DashboardPdfExportOptions Interface

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

Declaration

interface DashboardPdfExportOptions

Properties

AutoFitPageCount Property

Specifies the number of horizontal/vertical pages spanning 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 spanning the total width/height of a dashboard/dashboard item.

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 arranged automatically on the exported page.

Declaration

CardAutoArrangeContent?: boolean

Property Value

Type Description
boolean

true, to arrange cards automatically 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.

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

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

DocumentScaleMode Property

Specifies the mode for scaling a dashboard/dashboard item in the exported document.

Declaration

DocumentScaleMode?: DashboardExportDocumentScaleMode

Property Value

Type Description
DashboardExportDocumentScaleMode

To change the size of the dashboard or split it into several pages, specify the DocumentScaleMode property. Then 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

ExportFilters?: boolean

Property Value

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.

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.

To specify the position of the dashboard state (that includes current parameter values), use the DashboardStatePosition property.

FontInfo Property

Declaration

FontInfo?: ExportFontInfo

Property Value

Type Description
ExportFontInfo

GaugeAutoArrangeContent Property

Specifies whether gauges within the Gauge dashboard item are arranged automatically 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

Declaration

IncludeHiddenParameters?: boolean

Property Value

Type Description
boolean

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.

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

PageLayout?: DashboardExportPageLayout

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

PaperKind?: DashboardExportPaperKind | string

Property Value

Type Description
string

A string value that specifies the type of paper for the exported document.

string

A string value that specifies the type of paper for the exported document.

Property Value

Type Description
string

A string value that specifies the type of paper for the exported document.

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 arranged automatically 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.

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
DashboardRangeFilterExportSizeMode

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

ScaleFactor Property

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

Declaration

ShowTitle?: boolean

Property Value

Type Description
boolean

Title Property

Declaration

Title?: string

Property Value

Type Description
string

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.

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
DashboardTreemapExportSizeMode