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