Skip to main content

DashboardExcelExportOptions Interface

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

#Declaration

TypeScript
export interface DashboardExcelExportOptions

#Properties

#CsvValueSeparator Property

Specifies a character used to separate values in an exported CSV document.

#Declaration

TypeScript
CsvValueSeparator?: string

#Property Value

Type Description
string

A string value that specifies the character used to separate values in an exported CSV document.

#Remarks

Note that the CsvValueSeparator property is in effect when the Format is set to Csv.

#DashboardStatePosition Property

Specifies the position of the dashboard state (such as master filter or current parameter values) in the exported document.

#Declaration

TypeScript
DashboardStatePosition?: DashboardStateExcelExportPosition

#Property Value

Type Description
DashboardStateExcelExportPosition

The DashboardStateExcelExportPosition object that specify the position of the dashboard state in the exported Excel document.

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

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

#Format Property

Specifies the Excel format in which the dashboard item is exported.

#Declaration

TypeScript

#Property Value

Type Description
DashboardExcelFormat

A DashboardExcelFormat object that specifies the Excel format in which the dashboard item is exported.

#IncludeHiddenParameters Property

Specifies whether to add current parameter values to the exported document.

#Declaration

TypeScript
IncludeHiddenParameters?: boolean

#Property Value

Type Description
boolean

true to add current parameter values 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.