DashboardChangedInfo

View as Markdown

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.

TypeScript
export interface DashboardChangedInfo extends
Extends

BaseContext

Properties

PropertyTypeDescription
actionNamestringWhat 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.
newDashboardStateDashboardStateDashboard State after this change.
oldDashboardStateDashboardStateDashboard State before this change.

null when actionName is ADAPTABLE_READY.
adaptableContextanyCustom application Context provided in AdaptableOptions.adaptableContext

Methods

MethodReturnsDescription
isToolbarStateChangedToHidden(toolbarName)booleanWhether 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)booleanWhether 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.

TypeScript
actionName: string;
Property Value

string

newDashboardState

Dashboard State after this change.

TypeScript
newDashboardState: DashboardState;
Property Value

DashboardState

oldDashboardState

Dashboard State before this change.

null when actionName is ADAPTABLE_READY.

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

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.

TypeScript
isToolbarStateChangedToHidden(toolbarName: string): boolean;
Parameters
ParameterTypeDescription
toolbarNamestringToolbar 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.

TypeScript
isToolbarStateChangedToVisible(toolbarName: string): boolean;
Parameters
ParameterTypeDescription
toolbarNamestringToolbar to test
Returns

true when the toolbar became visible

boolean