DashboardState
Adaptable State Section for the AdapTable Dashboard
export interface DashboardState extendsExtends
Properties
| Property | Description | Default |
|---|---|---|
| ActiveTabIndex | Index of Active Tab (in Tabs collection) | |
| DashboardTitle | Title displayed in Dashboard Header | adaptableId in Adaptable Options |
| FloatingPosition | Position of Dashboard when in Floating mode | |
| IsCollapsed | Is Dashboard collapsed; if true, header is visible (but not Tabs' contents) | false |
| IsFloating | Is Dashboard floating; if true, appears in draggable, minmised form (double-click to revert to default position) | false |
| IsHidden | Whether Dashboard is completely hidden - can be made visible again in Column Menu and Tool Panel | false |
| IsInline | Alternative way of rendering Dashboard, with headers section to left of Toolbars | false |
| ModuleButtons | Buttons which open the Settings Panel screen for associated AdapTable Module | ['SettingsPanel'] |
| PinnedToolbars | Toolbars displayed above Grid (and not in Tab) | |
| Tabs | Named group of Toolbars | Empty Array |
Property Details
ActiveTabIndex
Index of Active Tab (in Tabs collection)
ActiveTabIndex?: number;Property Value
number
DashboardTitle
Title displayed in Dashboard Header
DashboardTitle?: string;Default Value
adaptableId in Adaptable Options
Property Value
string
FloatingPosition
Position of Dashboard when in Floating mode
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, appears in draggable, minmised form (double-click to revert to 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
IsInline
Alternative way of rendering Dashboard, with headers section to left of Toolbars
IsInline?: boolean;Default Value
false
Property Value
boolean
ModuleButtons
Buttons which open the Settings Panel screen for associated AdapTable Module
ModuleButtons?: AdaptableModuleButtons;Default Value
['SettingsPanel']
Property Value
AdaptableModuleButtons
PinnedToolbars
Toolbars displayed above Grid (and not in Tab)
PinnedToolbars?: AdaptableDashboardToolbars | string[];Property Value
AdaptableDashboardToolbars | string[]
Tabs
Named group of Toolbars
Tabs?: DashboardTab[];Default Value
Empty Array