Settings Panel Technical Reference

Whether a Settings Panel button should always be displayed in ModuleButtons area of ToolPanel

Custom Settings Panels provided by developers at design-time

Display / chrome options for Settings Panel navigation (icons, descriptions, search, collapse).

Which Tabs to show in Grid Info: 'Grid Summary', 'Layout', 'Grid State' or 'Grid Options'

Tab labels in the UI are Summary, Layout, State and Options

Icon shown in top left of Settings Panel: Can be ConfigurationIcon, ApplicationIcon or custom Icon.

When omitted, uses 'ApplicationIcon' if userInterfaceOptions.applicationIcon is set,
otherwise 'ConfigurationIcon'.

Configure grouped navigation for the Settings Panel; use SettingsPanelNavigationConfigurer but backwards compatibility via the deprecated LegacyFlatSettingsPanelNavigation is supported

How the Settings Panel is rendered: 'modal' (centred and unmovable and resizable) or 'window' (supports size, position, drag and resize); ignored if containerOptions.modalContainer is set

Initial position of Settings Panel — pixel offset of top-left corner from top-left of viewport (requires popupType to be 'window')

Initial size (in pixels) of Settings Panel (requires popupType to be 'window')

Runtime display name for the panel chrome, menus, and tooltips. End users never see the
internal name “Settings Panel” — they see this title instead.

When omitted, resolves to AdaptableOptions.adaptableId if that is a meaningful
(non-generic) value, otherwise 'Grid Settings'.

Whether users can collapse Settings Panel navigation to an icon rail

Whether to show Description subtitles under each Module in Settings Panel navigation

Whether to show Icons for each Module when navigation is expanded.
Collapsed (icon-rail) navigation always shows icons.

Whether to show the module search field above Settings Panel navigation

Short subtitle shown under the name in Settings Panel navigation.

Framework-specific (Angular, React or Vue) component to be rendered

Icon rendered inside settings-panel name, inside the navigation

Appears in Settings Panel Navigation. Include in navigation to choose placement
(by default added to a Custom Panels group at the end).

Function to provide bespoke content when NOT using a Framework wrapper

Distance from the left edge of the viewport, in pixels.

Distance from the top edge of the viewport, in pixels.

Height of the window, in pixels.

Width of the window, in pixels.

Closes Settings Panel

Opens Settings Panel with the Custom Settings Panel, provided by name, displayed

Opens Settings Panel and displays specified Module (if provided) or first available one