DashboardState

View as Markdown

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.

TypeScript
export interface DashboardState extends
Extends

BaseState

Properties

PropertyTypeDescriptionDefault
ActiveTabIndexnumberZero-based index into Tabs of the tab that is open.
DashboardTitlestringTitle displayed in Dashboard HeaderadaptableId in Adaptable Options
FloatingPositionAdaptableCoordinatePixel position of the Dashboard while IsFloating is true. x and y are offsets in pixels.
IsCollapsedbooleanIs Dashboard collapsed; if true, header is visible (but not Tabs' contents)false
IsFloatingbooleanIs Dashboard floating; if true, it appears in a draggable form (double-click to revert to the default position)false
IsHiddenbooleanWhether Dashboard is completely hidden - can be made visible again in Column Menu and Tool Panelfalse
ModuleButtonsAdaptableModuleButtonsModule 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.
[]
PinnedToolbarsAdaptableDashboardToolbars | string[]Toolbars shown above the grid, outside any tab.
TabsDashboardTab[]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.

TypeScript
ActiveTabIndex?: number;
Property Value

number

DashboardTitle

Title displayed in Dashboard Header

TypeScript
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.

TypeScript
FloatingPosition?: AdaptableCoordinate;
Property Value

AdaptableCoordinate

IsCollapsed

Is Dashboard collapsed; if true, header is visible (but not Tabs' contents)

TypeScript
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)

TypeScript
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

TypeScript
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.

TypeScript
ModuleButtons?: AdaptableModuleButtons;
Default Value

[]

Property Value

AdaptableModuleButtons

PinnedToolbars

Toolbars shown above the grid, outside any tab.

TypeScript
PinnedToolbars?: AdaptableDashboardToolbars | string[];
Property Value

AdaptableDashboardToolbars | string[]

Tabs

Named groups of toolbars. Each tab has a Name and the Toolbars it shows.

TypeScript
Tabs?: DashboardTab[];
Default Value

Empty Array

Property Value

DashboardTab[]