Skip to main content

DashboardPdfExportOptions Interface

In This Article

Contains options related to exporting a dashboard/dashboard item to PDF format.

#Declaration

TypeScript
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

TypeScript
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

TypeScript
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

TypeScript
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

TypeScript

#Property Value

Type Description
DashboardChartExportSizeMode

A DashboardChartExportSizeMode value that specifies the export size mode for the Chart dashboard item.

#DashboardAutomaticPageLayout Property

Specifies whether the page orientation used to export a dashboard is selected automatically.

#Declaration

TypeScript
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

TypeScript
DashboardStatePosition?: DashboardStateExportPosition

#Property Value

Type
DashboardStateExportPosition

#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

TypeScript

#Property Value

Type
DashboardExportDocumentScaleMode

#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
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.

#ExportFilters Property

Specifies whether to add the state of master filter items to the exported document.

#Declaration

TypeScript
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

TypeScript
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

TypeScript
FontInfo?: ExportFontInfo

#Property Value

Type Description
ExportFontInfo

A ExportFontInfo object that provides access to the font settings of the exported PDF document.

#GaugeAutoArrangeContent Property

Specifies whether gauges within the Gauge dashboard item are automatically arranged on the exported page.

#Declaration

TypeScript
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

TypeScript
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

TypeScript
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

TypeScript
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 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.

#MapAutomaticPageLayout Property

Specifies whether the page orientation used to export the Map dashboard item is selected automatically.

#Declaration

TypeScript
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

TypeScript
MapSizeMode?: DashboardMapSizeMode

#Property Value

Type Description
DashboardMapSizeMode

A DashboardMapSizeMode value that specifies the export size mode for the Map dashboard item.

#PageLayout Property

Specifies the page orientation used to export a dashboard/dashboard item.

#Declaration

TypeScript

#Property Value

Type Description
DashboardExportPageLayout

A DashboardExportPageLayout value that specifies the page orientation used to export a dashboard/dashboard item.

#PaperKind Property

Specifies the type of paper for the exported document.

#Declaration

TypeScript
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

TypeScript
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

TypeScript
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

TypeScript
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

TypeScript

#Property Value

Type Description
DashboardRangeFilterExportSizeMode

A DashboardRangeFilterExportSizeMode value that specifies the export size mode for the Range Filter dashboard item

#ScaleFactor Property

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

#Declaration

TypeScript
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

TypeScript
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

TypeScript
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

TypeScript
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

TypeScript

#Property Value

Type Description
DashboardTreemapExportSizeMode

A DashboardTreemapExportSizeMode object that specifies how the Treemap dashboard item should be resized when being exported.