Skip to main content
All docs
V24.1

ASPxClientDashboardInitializingEventArgs Class

Provides data for the ASPxClientDashboard.DashboardInitializing event.

Declaration

declare class ASPxClientDashboardInitializingEventArgs extends ASPxClientEventArgs

Remarks

Warning

A use of ASPxClientDashboard API reduces flexibility when you configure the control. The DashboardControl underlies the ASPxClientDashboard object. The control provides access to all client settings and allows you to implement complex scenarios. We recommend that you use the DashboardControl API to configure the Web Dashboard on the client. More information: Client-Side Functionality.

The corresponding DashboardControl’s event: DashboardControlOptions.onDashboardInitializing.

Inherited Members

Inheritance

ASPxClientEventArgs
ASPxClientDashboardInitializingEventArgs

Properties

Dashboard Property

Gets a model of the dashboard displayed in the control.

Declaration

Dashboard: any

Property Value

Type Description
any

A Dashboard object that is a dashboard for which the event is raised.

DashboardId Property

Gets a string value that is the dashboard identifier.

Declaration

DashboardId: string

Property Value

Type Description
string

A string value that is a dashboard’s unique name.

Ready Property

Specifies a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished.

Declaration

Ready: any

Property Value

Type Description
any

A JQueryPromise<any> object.