dashboard-js-devexpress-dot-dashboard-0efc2fa1.md
Contains options related to exporting a dashboard/dashboard item to PDF format.
export interface DashboardPdfExportOptions
Specifies the number of horizontal/vertical pages that span the total width/height of a dashboard/dashboard item.
AutoFitPageCount?: number
| Type | Description |
|---|---|
| number |
An integer value that specifies the number of horizontal/vertical pages that span the total width/height of a dashboard/dashboard item.
|
The AutoFitPageCount property is in effect when the DocumentScaleMode property is set to AutoFitToPagesWidth.
Specifies whether cards within the Card dashboard item are automatically arranged on the exported page.
CardAutoArrangeContent?: boolean
| Type | Description |
|---|---|
| boolean |
true , to automatically arrange cards on the exported page; otherwise, false.
|
Specifies whether the page orientation used to export the Chart dashboard item is selected automatically.
ChartAutomaticPageLayout?: boolean
| Type | Description |
|---|---|
| boolean |
true , to automatically select the page orientation used to export the Chart dashboard item; otherwise, false.
|
The ChartAutomaticPageLayout property is in effect when the DocumentScaleMode property is set to None. If the ChartAutomaticPageLayout property is set to true , it overrides the page orientation specified using the PageLayout property.
Specifies the export size mode for the Chart dashboard item.
ChartSizeMode?: DashboardChartExportSizeMode
| Type | Description |
|---|---|
| DashboardChartExportSizeMode |
A DashboardChartExportSizeMode value that specifies the export size mode for the Chart dashboard item.
|
Specifies whether the page orientation used to export a dashboard is selected automatically.
DashboardAutomaticPageLayout?: boolean
| Type | Description |
|---|---|
| boolean |
true , to automatically select the page orientation used to export a dashboard; otherwise, false.
|
Specifies the position of the dashboard state (such as master filter or current parameter values) in the exported document.
DashboardStatePosition?: DashboardStateExportPosition
| Type |
|---|
| DashboardStateExportPosition |
To add a master state to the exported document, use the ExportFilters property. To export current parameter values, set the ExportParameters property to true.
Specifies the mode for scaling a dashboard/dashboard item in the exported document.
DocumentScaleMode?: DashboardExportDocumentScaleMode
| Type |
|---|
| DashboardExportDocumentScaleMode |
To change the size of the dashboard or split it into several pages, use the DocumentScaleMode property and specify the following export options depending on the selected mode:
| Scale Mode | Related Property | Description |
|---|---|---|
| AutoFitToPagesWidth | AutoFitPageCount | Splits the dashboard into multiple pages and aligns it. |
| UseScaleFactor | ScaleFactor | Scales the dashboard. |
| None | n/a | The dashboard size is fixed, and other dashboard scaling settings are not in effect. |
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.
|
To specify the position of the dashboard state (that includes the state of master filter items), use the DashboardStatePosition property.
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.
|
To specify the position of the dashboard state (including current parameter values), use the DashboardStatePosition property.
Provides access to the font settings of the exported PDF document.
FontInfo?: ExportFontInfo
| Type | Description |
|---|---|
| ExportFontInfo |
A ExportFontInfo object that provides access to the font settings of the exported PDF document.
|
Specifies whether gauges within the Gauge dashboard item are automatically arranged on the exported page.
GaugeAutoArrangeContent?: boolean
| Type | Description |
|---|---|
| boolean |
true , to arrange gauges automatically on the exported page; otherwise, false.
|
Specifies whether the size of the Grid dashboard item is changed according to the width of the exported page.
GridFitToPageWidth?: boolean
| Type | Description |
|---|---|
| boolean |
true , to change the size of the Grid dashboard item according to the width of the exported page; otherwise, false.
|
Specifies whether to add column headers of the Grid dashboard item to every page.
GridPrintHeadersOnEveryPage?: boolean
| Type | Description |
|---|---|
| boolean |
true , to add column headers to every page; otherwise, false.
|
Specifies whether to add current values of hidden parameters to the exported document.
IncludeHiddenParameters?: boolean
| Type | Description |
|---|---|
| boolean |
true to add current values of hidden parameters 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 whether the page orientation used to export the Map dashboard item is selected automatically.
MapAutomaticPageLayout?: boolean
| Type | Description |
|---|---|
| boolean |
true , to automatically select the page orientation used to export the Map dashboard item; otherwise, false.
|
The MapAutomaticPageLayout property is in effect when the DocumentScaleMode property is set to None. If the MapAutomaticPageLayout property is set to true , it overrides the page orientation specified using the PageLayout property.
Specifies the export size mode for the Map dashboard item.
MapSizeMode?: DashboardMapSizeMode
| Type | Description |
|---|---|
| DashboardMapSizeMode |
A DashboardMapSizeMode value that specifies the export size mode for the Map dashboard item.
|
Specifies the page orientation used to export a dashboard/dashboard item.
PageLayout?: DashboardExportPageLayout
| Type | Description |
|---|---|
| DashboardExportPageLayout |
A DashboardExportPageLayout value that specifies the page orientation used to export a dashboard/dashboard item.
|
Specifies the type of paper for the exported document.
PaperKind?: DashboardExportPaperKind | string
| Type | Description |
|---|---|
| string |
A string value that specifies the type of paper for the exported document.
|
Specifies whether pies within the Pie dashboard item are automatically arranged on the exported page.
PieAutoArrangeContent?: boolean
| Type | Description |
|---|---|
| boolean |
true , to arrange pies automatically on the exported page; otherwise, false.
|
Specifies whether to add column headers of the Pivot dashboard item to every page.
PivotPrintHeadersOnEveryPage?: boolean
| Type | Description |
|---|---|
| boolean |
true , to add column headers to every page; otherwise, false.
|
Specifies whether the page orientation used to export the Range Filter dashboard item is selected automatically.
RangeFilterAutomaticPageLayout?: boolean
| Type | Description |
|---|---|
| boolean |
true , to automatically select the page orientation used to export the Range Filter dashboard item; otherwise, false.
|
The RangeFilterAutomaticPageLayout property is in effect when the DocumentScaleMode property is set to None. If the RangeFilterAutomaticPageLayout property is set to true , it overrides the page orientation specified using the PageLayout property.
Specifies the export size mode for the Range Filter dashboard item.
RangeFilterSizeMode?: DashboardRangeFilterExportSizeMode
| Type | Description |
|---|---|
| DashboardRangeFilterExportSizeMode |
A DashboardRangeFilterExportSizeMode value that specifies the export size mode for the Range Filter dashboard item
|
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 included as the exported document title.
ShowTitle?: boolean
| Type | Description |
|---|---|
| boolean |
true to export a dashboard title (or dashboard item caption) as the exported document title; otherwise, false.
|
Specifies a title for the exported PDF document.
Title?: string
| Type | Description |
|---|---|
| string |
A string that is a title.
|
Specifies whether the page orientation used to export the Treemap dashboard item is selected automatically.
TreemapAutomaticPageLayout?: boolean
| Type | Description |
|---|---|
| boolean |
true , to automatically select the page orientation used to export the Treemap dashboard item; otherwise, false.
|
The TreemapAutomaticPageLayout property is in effect when the DocumentScaleMode property is set to None. If the TreemapAutomaticPageLayout property is set to true , it overrides the page orientation specified using the PageLayout property.
Specifies the export size mode for the Treemap dashboard item.
TreemapSizeMode?: DashboardTreemapExportSizeMode
| Type | Description |
|---|---|
| DashboardTreemapExportSizeMode |
A DashboardTreemapExportSizeMode object that specifies how the Treemap dashboard item should be resized when being exported.
|