DashboardChangedInfo
Object returned by the DashboardChanged event
TypeScript
export interface DashboardChangedInfo extendsExtends
Properties
| Property | Description |
|---|---|
| actionName | What caused Dashboard State to change |
| newDashboardState | Current Dashboard State |
| oldDashboardState | Previous Dashboard State |
| adaptableContext | Custom application Context provided in AdaptableOptions.adaptableContext |
Methods
| Method | Description |
|---|---|
| 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
oldDashboardState
Previous Dashboard State
TypeScript
oldDashboardState: DashboardState;Property Value
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
| Parameter | Type |
|---|---|
| toolbarName | string |
Returns
boolean
isToolbarStateChangedToVisible
Check if given Toolbar was just changed to visible state
TypeScript
isToolbarStateChangedToVisible(toolbarName: string): boolean;Parameters
| Parameter | Type |
|---|---|
| toolbarName | string |
Returns
boolean