DashboardImageExportOptions Interface

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

Declaration

export interface DashboardImageExportOptions

Properties

ExportFilters Property

Specifies 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

Specifies 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 image.

Declaration

FontInfo?: ExportFontInfo

Property Value

Type	Description
ExportFontInfo	A ExportFontInfo object that provides access to the font settings of the exported image.

Format Property

Specifies an image format in which the dashboard/dashboard item is exported.

Declaration

Format?: DashboardExportImageFormat

Property Value

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

IncludeHiddenParameters Property

Specifies whether to add the current values of the parameters to the exported document.

Declaration

IncludeHiddenParameters?: boolean

Property Value

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

Remarks

Warning

If the IncludeHiddenParameters client property is enabled, a user can still get access to all hidden parameters with their values.

Encode the passed parameter value if possible. Do not store any sensitive information in dashboard parameters that isn’t encrypted.

Resolution Property

Specifies 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 when you export a dashboard/dashboard item as an image. The default value is 96.

ScaleFactor Property

Specifies 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 number that specifies the scale factor by which a dashboard/dashboard item is scaled in the exported document.

ShowTitle Property

Specifies whether a dashboard title or dashboard item caption is used as the exported document title.

Declaration

ShowTitle?: boolean

Property Value

Type	Description
boolean	true to use the dashboard title or dashboard item caption as the title of the exported document; otherwise, false.

Title Property

Declaration

Title?: string

Property Value

Type
string