The requested page is not available for the requested platform. You are viewing the content for Default platform.

DashboardPanelExtensionOptions Interface

Provides options for customizing the DashboardPanelExtension.

Declaration

export interface DashboardPanelExtensionOptions

Remarks

See the Extension section for information on how to use the HTML JavaScript Dashboard's client-side API.

See Also
400141#extensions

Properties

dashboardThumbnail Property

Specifies a dashboard thumbnail for the dashboard panel in a mobile layout.

Declaration

dashboardThumbnail?: string

Property Value

Type Description
string

A string that is a dashboard thumbnail's name. The name should be the same as a name of the relevant dashboard.

Remarks

In a mobile layout, you can specify a dashboard thumbnail to display a list of available dashboards with icons. Create dashboard images and put them in a folder in your project. Note that the dashboard thumbnail's name should be the same as the name of the relevant dashboard:

Use the DashboardPanelExtension's constructor to set a path to the dashboard thumbnails contained in the specified folder:

function onBeforeRender(sender) {
  var control = sender.GetDashboardControl();
  control.registerExtension(new DevExpress.Dashboard.DashboardPanelExtension(control, { dashboardThumbnail: "./DashboardThumbnail/{0}.png" }));
}