DashboardState Class

A data container for changes resulting from end-user interaction - selected master filter values, drill-down levels, selected dashboard item layers and current parameter values.

Declaration

export class DashboardState

Remarks

The DashboardState class includes states of individual dashboard items (the DashboardState.Items property) and currently selected parameter values (DashboardState.Parameters).

Properties

Items Property

Provides access to states of individual dashboard items displayed in the dashboard.

Declaration

Items: {
    [id: string]: ItemState;
}

Property Value

Type	Description
[id: string]: ItemState	A collection of ItemState objects that are states of individual dashboard items.

Parameters Property

Provides access to states of dashboard parameters.

Declaration

Parameters: {
    [id: string]: any;
}

Property Value

Type	Description
[id: string]: any	A collection of dashboard parameter states.