Skip to main content
All docs
V24.1

ImageFormatOptions Class

Contains settings that specify parameters affecting how the dashboard or dashboard item is exported in Image format.

Declaration

declare class ImageFormatOptions

Remarks

Use the ASPxClientDashboardExportOptions.ImageOptions property to access options specific to exporting the dashboard (dashboard item) in Image format.

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.

Properties

Format Property

Obsolete. Gets or sets an image format in which the dashboard (dashboard item) is exported.

Declaration

Format: string

Property Value

Type Description
string

A value returned by the DashboardExportImageFormat class that specifies an image format in which the dashboard (dashboard item) is exported.

Resolution Property

Obsolete. Gets or sets the resolution (in dpi) used to export a dashboard (dashboard item) in Image format.

Declaration

Resolution: number

Property Value

Type Description
number

An integer value that specifies the resolution (in dpi) used when you export a dashboard/dashboard item as an image. The default value is 96.