DashboardChangedInfo

Object returned by the DashboardChanged event

TypeScript
export interface DashboardChangedInfo extends
Extends

BaseContext

Properties

PropertyDescription
actionNameWhat caused Dashboard State to change
newDashboardStateCurrent Dashboard State
oldDashboardStatePrevious Dashboard State
adaptableContextCustom application Context provided in AdaptableOptions.adaptableContext

Methods

MethodDescription
isToolbarStateChangedToHidden(toolbarName)Check if given Toolbar was just changed to hidden state
isToolbarStateChangedToVisible(toolbarName)Check if given Toolbar was just changed to visible state

Property Details

actionName

What caused Dashboard State to change

TypeScript
actionName: string;
Property Value

string

newDashboardState

Current Dashboard State

TypeScript
newDashboardState: DashboardState;
Property Value

DashboardState

oldDashboardState

Previous Dashboard State

TypeScript
oldDashboardState: DashboardState;
Property Value

DashboardState

adaptableContext

Inherited from BaseContext

Custom application Context provided in AdaptableOptions.adaptableContext

TypeScript
adaptableContext: any;
Property Value

any

Method Details

isToolbarStateChangedToHidden

Check if given Toolbar was just changed to hidden state

TypeScript
isToolbarStateChangedToHidden(toolbarName: string): boolean;
Parameters
ParameterType
toolbarNamestring
Returns

boolean

isToolbarStateChangedToVisible

Check if given Toolbar was just changed to visible state

TypeScript
isToolbarStateChangedToVisible(toolbarName: string): boolean;
Parameters
ParameterType
toolbarNamestring
Returns

boolean