DashboardState

Adaptable State Section for the AdapTable Dashboard

export interface DashboardState extends

Extends

BaseState

Properties

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

AdaptableCoordinate

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

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

Property Value

DashboardTab[]