DashboardState
Dashboard section of Adaptable State, including Initial State.
The Dashboard sits above the grid. Tabs are named groups of toolbars (the default is an empty list). PinnedToolbars sit above the grid and are not inside a tab. ActiveTabIndex is the zero-based index of the open tab. IsCollapsed leaves the header visible and hides the tab contents. IsFloating shows a draggable dashboard; FloatingPosition is its pixel position. IsHidden removes it until it is shown again from the Column Menu or Tool Panel.
export interface DashboardState extendsExtends
Properties
| Property | Type | Description | Default |
|---|---|---|---|
| ActiveTabIndex | number | Zero-based index into Tabs of the tab that is open. | |
| DashboardTitle | string | Title displayed in Dashboard Header | adaptableId in Adaptable Options |
| FloatingPosition | AdaptableCoordinate | Pixel position of the Dashboard while IsFloating is true. x and y are offsets in pixels. | |
| IsCollapsed | boolean | Is Dashboard collapsed; if true, header is visible (but not Tabs' contents) | false |
| IsFloating | boolean | Is Dashboard floating; if true, it appears in a draggable form (double-click to revert to the default position) | false |
| IsHidden | boolean | Whether Dashboard is completely hidden - can be made visible again in Column Menu and Tool Panel | false |
| ModuleButtons | AdaptableModuleButtons | Module shortcut buttons in the Dashboard header (actions zone). Opening the Settings Panel itself is handled by the fixed Home control (application icon or configuration icon) on the left of the Dashboard — do not include 'SettingsPanel' here. | [] |
| PinnedToolbars | AdaptableDashboardToolbars | string[] | Toolbars shown above the grid, outside any tab. | |
| Tabs | DashboardTab[] | Named groups of toolbars. Each tab has a Name and the Toolbars it shows. | Empty Array |
Property Details
ActiveTabIndex
Zero-based index into Tabs of the tab that is open.
ActiveTabIndex?: number;Property Value
number
DashboardTitle
Title displayed in Dashboard Header
DashboardTitle?: string;Default Value
adaptableId in Adaptable Options
Property Value
string
FloatingPosition
Pixel position of the Dashboard while IsFloating is true. x and y are offsets in pixels.
FloatingPosition?: AdaptableCoordinate;Property Value
IsCollapsed
Is Dashboard collapsed; if true, header is visible (but not Tabs' contents)
IsCollapsed?: boolean;Default Value
false
Property Value
boolean
IsFloating
Is Dashboard floating; if true, it appears in a draggable form (double-click to revert to the default position)
IsFloating?: boolean;Default Value
false
Property Value
boolean
IsHidden
Whether Dashboard is completely hidden - can be made visible again in Column Menu and Tool Panel
IsHidden?: boolean;Default Value
false
Property Value
boolean
ModuleButtons
Module shortcut buttons in the Dashboard header (actions zone).
Opening the Settings Panel itself is handled by the fixed Home control (application icon or
configuration icon) on the left of the Dashboard — do not include 'SettingsPanel' here.
ModuleButtons?: AdaptableModuleButtons;Default Value
[]
Property Value
AdaptableModuleButtons
PinnedToolbars
Toolbars shown above the grid, outside any tab.
PinnedToolbars?: AdaptableDashboardToolbars | string[];Property Value
AdaptableDashboardToolbars | string[]
Tabs
Named groups of toolbars. Each tab has a Name and the Toolbars it shows.
Tabs?: DashboardTab[];Default Value
Empty Array