Settings Panel Technical Reference
Summary
- The Settings Panel API allows the Settings Panel to be opened programatically
- This includes opening Custom Settings Panels
Settings Panel Options
The Settings Panel Options section contains many useful configuration properties:
| Property | Description | Default |
|---|---|---|
| alwaysShowInDashboard | Whether a Settings Panel button should always be displayed in ModuleButtons area of Dashboard | false |
| alwaysShowInToolPanel | Whether a Settings Panel button should always be displayed in ModuleButtons area of ToolPanel | false |
| customSettingsPanels | Custom Settings Panels provided by developers at design-time | |
| icon | Icon shown in top left of Settings Panel: Can be ConfigurationIcon, ApplicationIcon or custom Icon | ConfigurationIcon |
| navigation | Ordered items to display at side of Settings Panel | all available AdapTable modules |
| popupType | Whether Settings Panel is 'window' (i.e. movable, resizable, no backdrop) or 'modal' (centre of screen with backdrop) | 'window' |
| position | Initial position of Settings Panel window | Middle of Screen |
| showModuleIcons | Whether to show Icons for each Module in the Setting Panel | true |
| size | Initial size of Settings Panel | Computed based on size of screen |
| title | Title for the Settings Panel | 'Settings Panel' |
Settings Panel API
The Settings Panel API section provides a couple of functions to show the Settings Panel:
| Method | Description |
|---|---|
| closeSettingsPanel() | Closes Settings Panel |
| openCustomSettingsPanel(name) | Opens Settings Panel with the Custom Settings Panel, provided by name, displayed |
| openSettingsPanel(moduleName) | Opens Settings Panel and displays specified Module (if provided) or first available one |