Skip to main content

DashboardInitializingArgs Type

Provides data for the DashboardInitializing event.

Declaration

export type DashboardInitializingArgs = {
    component: DevExpress.Dashboard.DashboardControl;
    dashboardId: string;
    dashboard: DevExpress.Dashboard.Model.Dashboard;
    ready: JQueryPromise<any>;
}

Members

Name Type Description
component DashboardControl

A Web Dashboard control.

dashboard Dashboard

A model of the dashboard displayed in the control.

dashboardId string

A string value that is the dashboard identifier.

ready JQueryPromise<any>

A JQuery Promise object that is resolved after the action is completed.

Remarks

Use the onDashboardInitializing handler to raise the DashboardInitializing event.

To learn more about promises, see JQueryPromise.