DashboardPanelExtensionOptions Interface

Provides options for customizing the DashboardPanelExtension.

Declaration

export interface DashboardPanelExtensionOptions

Remarks

See the following topic for information on how to use the DashboardControl’s client-side API: Extensions Overview.

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 mobile layout, you can add thumbnails for each dashboard. We recommend that you add thumbnails if you have a fixed set of dashboards, because you need to create the thumbnails and add them to a Web Dashboard manually.

Follow the steps below to add thumbnails:

1. Create and prepare dashboard thumbnails.

2. Create a folder in your project and add the thumbnails to this folder. Name files to match corresponding dashboards.

   

3. Use the extension’s dashboardThumbnail property to specify the path to the folder. In this example, the folder name is DashboardThumbnail. {0} is the dashboard name placeholder.

   // The dashboardControl variable is the obtained DashboardControl instance.
   dashboardControl.registerExtension(new DevExpress.Dashboard.DashboardPanelExtension(control,
    { dashboardThumbnail: "./Content/DashboardThumbnail/{0}.png" }));  
   

   The image below illustrates the resulting Dashboard Panel with thumbnails: