DashboardImageExportOptions Class

Contains options related to exporting a dashboard/dashboard item to an image.

Declaration

declare class DashboardImageExportOptions

Remarks

The ASPxClientDashboard.GetImageExportOptions and ASPxClientDashboard.SetImageExportOptions properties allow you to obtain and specify image-specific export options on the client side.

You can use the ASPxClientDashboard.ExportToImage / ASPxClientDashboard.ExportDashboardItemToImage methods to specify image options when exporting a dashboard/dashboard item.

Properties

ExportFilters Property

Gets or sets whether to add the state of master filter items to the exported document.

Declaration

ExportFilters: boolean

Property Value

Type	Description
boolean	true, to add the state of master filter items to the exported document; otherwise, false.

ExportParameters Property

Gets or sets whether to add current parameter values to the exported document.

Declaration

ExportParameters: boolean

Property Value

Type	Description
boolean	true, to add current parameter values to the exported document; otherwise, false.

FontInfo Property

Provides access to the font settings of the exported document.

Declaration

FontInfo: ExportFontInfo

Property Value

Type	Description
ExportFontInfo	A ExportFontInfo object containing the font settings of the exported document.

Format Property

Gets or sets an image format in which the dashboard/dashboard item is exported.

Declaration

Format: string

Property Value

Type	Description
string	A DashboardExportImageFormat value that specifies an image format in which the dashboard/dashboard item is exported.

IncludeHiddenParameters Property

Gets or sets whether to add current values of a hidden parameter to the exported document.

Declaration

IncludeHiddenParameters: boolean

Property Value

Type	Description
boolean	true, to add current values of a hidden parameter to the exported document; otherwise, false.

Remarks

Note that the IncludeHiddenParameters property requires enabling the DashboardImageExportOptions.ExportParameters property.

Resolution Property

Gets or sets the resolution (in dpi) used to export a dashboard/dashboard item to an image.

Declaration

Resolution: number

Property Value

Type	Description
number	An integer value that specifies the resolution (in dpi) used to export a dashboard/dashboard item to an image.

ScaleFactor Property

Gets or sets the scale factor (in fractions of 1), by which a dashboard/dashboard item is scaled in the exported document.

Declaration

ScaleFactor: number

Property Value

Type	Description
number	A string value that specifies the scale factor by which a dashboard/dashboard item is scaled in the exported document.

ShowTitle Property

Gets or sets whether a dashboard title (or dashboard item’s caption) is included as the exported document title.

Declaration

ShowTitle: boolean

Property Value

Type	Description
boolean	true, to include a dashboard title (or dashboard item’s caption) as the exported document title; otherwise, false.

Title Property

Gets or sets a title of the exported document.

Declaration

Title: string

Property Value

Type	Description
string	A string value that specifies the title of the exported document.