Settings Panel Technical Reference
Summary
- The Settings Panel API allows the Settings Panel to be opened programmatically
- This includes opening Custom Settings Panels
Settings Panel Options
The Settings Panel Options section contains many useful configuration properties:
| Property | Type | Description | Default |
|---|---|---|---|
| alwaysShowInDashboard | boolean | Whether a Settings Panel button should always be displayed in ModuleButtons area of Dashboard | false |
| alwaysShowInToolPanel | boolean | Whether a Settings Panel button should always be displayed in ModuleButtons area of ToolPanel | false |
| customSettingsPanels | CustomSettingsPanel[] | Custom Settings Panels provided by developers at design-time | |
| gridInfoTabs | GridInfoTabs | Which Tabs can be used to display Grid Info: 'Grid Options', 'Grid Summary' or 'Grid State' | ['Grid Options', 'Grid Summary', 'Grid State'] |
| icon | 'ConfigurationIcon' | 'ApplicationIcon' |AdaptableIcon | Icon shown in top left of Settings Panel: Can be ConfigurationIcon, ApplicationIcon or custom Icon | ConfigurationIcon |
| navigation | SettingsPanelNavigationConfigurer|LegacyFlatSettingsPanelNavigation | Configure grouped navigation for the Settings Panel; use SettingsPanelNavigationConfigurer but backwards compatibility via the deprecated LegacyFlatSettingsPanelNavigation is supported | all available AdapTable modules in the default grouped order |
| popupType | PopupType | How the Settings Panel is rendered: 'modal' (centred and unmovable and resizable) or 'window' (supports size, position, drag and resize) | 'modal' |
| position | SettingsPanelPosition | Initial position of Settings Panel — pixel offset of top-left corner from top-left of viewport (requires popupType to be 'window') | Middle of Screen |
| showModuleIcons | boolean | Whether to show Icons for each Module in the Setting Panel | true |
| size | SettingsPanelSize | Initial size (in pixels) of Settings Panel (requires popupType to be 'window') | Computed based on size of screen |
| title | string | Title for Settings Panel | 'Settings Panel' |
Settings Panel API
The Settings Panel API section provides a couple of functions to show the Settings Panel:
| Method | Returns | Description |
|---|---|---|
| closeSettingsPanel() | void | Closes Settings Panel |
| openCustomSettingsPanel(name) | void | Opens Settings Panel with the Custom Settings Panel, provided by name, displayed |
| openSettingsPanel(moduleName) | void | Opens Settings Panel and displays specified Module (if provided) or first available one |