DashboardChangedInfo
Payload of the DashboardChanged event.
Fires when Dashboard State changes, and once shortly after startup (actionName ADAPTABLE_READY). It is not fired when the old and new state are equal.
Extends , so adaptableApi is included.
export interface DashboardChangedInfo extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| actionName | string | What changed.ADAPTABLE_READY is the first event, shortly after startup.Otherwise it is the Redux action type: DASHBOARD_SET_IS_COLLAPSED, DASHBOARD_SET_IS_HIDDEN, DASHBOARD_SET_IS_FLOATING, DASHBOARD_SET_FLOATING_POSITION, DASHBOARD_SET_MODULE_BUTTONS, DASHBOARD_SET_TABS, DASHBOARD_ACTIVE_TAB_INDEX_CHANGE, DASHBOARD_CLOSE_TOOLBAR. |
| newDashboardState | DashboardState | Dashboard State after this change. |
| oldDashboardState | DashboardState | Dashboard State before this change.null when actionName is ADAPTABLE_READY. |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
Methods
| Method | Returns | Description |
|---|---|---|
| isToolbarStateChangedToHidden(toolbarName) | boolean | Whether toolbarName became hidden because of this change.True when the toolbar left the active tab, or it stayed in the active tab and the Dashboard was collapsed or hidden. |
| isToolbarStateChangedToVisible(toolbarName) | boolean | Whether toolbarName became visible because of this change.True when the toolbar entered the active tab, or it was already in the active tab and the Dashboard was expanded or unhidden. |
Property Details
actionName
What changed.
ADAPTABLE_READY is the first event, shortly after startup.
Otherwise it is the Redux action type:
DASHBOARD_SET_IS_COLLAPSED, DASHBOARD_SET_IS_HIDDEN, DASHBOARD_SET_IS_FLOATING, DASHBOARD_SET_FLOATING_POSITION, DASHBOARD_SET_MODULE_BUTTONS, DASHBOARD_SET_TABS, DASHBOARD_ACTIVE_TAB_INDEX_CHANGE, DASHBOARD_CLOSE_TOOLBAR.
actionName: string;Property Value
string
newDashboardState
Dashboard State after this change.
newDashboardState: DashboardState;Property Value
oldDashboardState
Dashboard State before this change.
null when actionName is ADAPTABLE_READY.
oldDashboardState: DashboardState;Property Value
adaptableContext
Inherited from BaseContext
Custom application Context provided in AdaptableOptions.adaptableContext
adaptableContext: any;Property Value
any
Method Details
isToolbarStateChangedToHidden
Whether toolbarName became hidden because of this change.
True when the toolbar left the active tab, or it stayed in the active tab and the Dashboard was collapsed or hidden.
isToolbarStateChangedToHidden(toolbarName: string): boolean;Parameters
| Parameter | Type | Description |
|---|---|---|
| toolbarName | string | Toolbar to test |
Returns
true when the toolbar became hidden
boolean
isToolbarStateChangedToVisible
Whether toolbarName became visible because of this change.
True when the toolbar entered the active tab, or it was already in the active tab and the Dashboard was expanded or unhidden.
isToolbarStateChangedToVisible(toolbarName: string): boolean;Parameters
| Parameter | Type | Description |
|---|---|---|
| toolbarName | string | Toolbar to test |
Returns
true when the toolbar became visible
boolean