dashboard-js-devexpress-dot-dashboard-ec1181db.md
Contains options related to exporting a dashboard/dashboard item as an image.
export interface DashboardImageExportOptions
Specifies whether to add the state of master filter items to the exported document.
ExportFilters?: boolean
| Type | Description |
|---|---|
| boolean |
true , to add the state of master filter items to the exported document; otherwise, false.
|
Specifies whether to add current parameter values to the exported document.
ExportParameters?: boolean
| Type | Description |
|---|---|
| boolean |
true , to add current parameter values to the exported document; otherwise, false.
|
Provides access to the font settings of the exported image.
FontInfo?: ExportFontInfo
| Type | Description |
|---|---|
| ExportFontInfo |
A ExportFontInfo object that provides access to the font settings of the exported image.
|
Specifies an image format in which the dashboard/dashboard item is exported.
Format?: DashboardExportImageFormat
| Type | Description |
|---|---|
| DashboardExportImageFormat |
A DashboardExportImageFormat object that specifies an image format in which the dashboard/dashboard item is exported.
|
Specifies whether to add the current parameter values to the exported document.
IncludeHiddenParameters?: boolean
| Type | Description |
|---|---|
| boolean |
true to add the current parameter values to the exported document; otherwise, false.
|
Warning
If the IncludeHiddenParameters client property is enabled, a user can still obtain access to all hidden parameters and associated values.
Encode parameter values wherever/whenever possible. Never store sensitive/unencrypted information within dashboard parameters.
Specifies the resolution (in dpi) used to export a dashboard/dashboard item to an image.
Resolution?: number
| 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.
|
Specifies the scale factor (in fractions of 1 ), by which a dashboard/dashboard item is scaled in the exported document.
ScaleFactor?: number
| Type | Description |
|---|---|
| number |
A number that specifies the scale factor by which a dashboard/dashboard item is scaled in the exported document.
|
Specifies whether a dashboard title or dashboard item caption is used as the exported document title.
ShowTitle?: boolean
| Type | Description |
|---|---|
| boolean |
true to use the dashboard title or dashboard item caption as the title of the exported document; otherwise, false.
|
Title?: string
| Type |
|---|
| string |