DashboardControlEvents Interface

Provides access to the DashboardControl’s events.

Declaration

export interface DashboardControlEvents

Properties

beforeRender Property

Occurs before any element in the Web Dashboard control has been rendered.

Declaration

beforeRender: DashboardControlArgs

Property Value

Type	Description
DashboardControlArgs	An object that contains event arguments.

Remarks

Main article: onBeforeRender

dashboardBeginUpdate Property

Occurs when a dashboard update is initiated.

Declaration

dashboardBeginUpdate: DashboardUpdateArgs

Property Value

Type	Description
DashboardUpdateArgs	An object that contains event arguments.

Remarks

Main article: onDashboardBeginUpdate

dashboardEndUpdate Property

Occurs after the dashboard update is performed.

Declaration

dashboardEndUpdate: DashboardUpdateArgs

Property Value

Type	Description
DashboardUpdateArgs	An object that contains event arguments.

Remarks

Main article: onDashboardEndUpdate

dashboardInitialized Property

Occurs after the dashboard displayed in the control has been initialized.

Declaration

dashboardInitialized: DashboardInitializedArgs

Property Value

Type	Description
DashboardInitializedArgs	An object that contains event arguments.

Remarks

Main article: onDashboardInitialized

dashboardInitializing Property

Occurs before the dashboard displayed in the control has been initialized.

Declaration

dashboardInitializing: DashboardInitializingArgs

Property Value

Type	Description
DashboardInitializingArgs	An object that contains event arguments.

Remarks

Main article: onDashboardInitializing

dashboardStateChanged Property

Occurs after the current dashboard state in the Web Dashboard is changed.

Declaration

dashboardStateChanged: DashboardStateChangedArgs

Property Value

Type	Description
DashboardStateChangedArgs	An object that contains event arguments.

Remarks

Main article: onDashboardStateChanged

initializing Property

Occurs after the control has been initialized and before the control has been rendered.

Declaration

initializing: DashboardControlArgs

Property Value

Type	Description
DashboardControlArgs	An object that contains event arguments.

Remarks

Main article: onInitializing

itemBeginUpdate Property

Occurs when a dashboard item update is initiated.

Declaration

itemBeginUpdate: DashboardItemUpdateArgs

Property Value

Type	Description
DashboardItemUpdateArgs	An object that contains event arguments.

Remarks

Main article: onItemBeginUpdate

itemEndUpdate Property

Occurs after the dashboard item update is performed.

Declaration

itemEndUpdate: DashboardItemUpdateArgs

Property Value

Type	Description
DashboardItemUpdateArgs	An object that contains event arguments.

Remarks

Main article: onItemEndUpdate

optionChanged Property

Occurs after a widget option is changed.

Declaration

optionChanged: DashboardOptionChangedArgs<DashboardControlOptions>

Property Value

Type	Description
DashboardOptionChangedArgs<DashboardControlOptions>	An object that contains event arguments.

Remarks

Main article: onOptionChanged