DashboardExcelExportOptions Interface
Contains options related to exporting a dashboard/dashboard item to the Excel format.
Declaration
export interface DashboardExcelExportOptions
Properties
CsvValueSeparator Property
Specifies a character used to separate values in an exported CSV document.
Declaration
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
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
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 (that includes current parameter values), use the DashboardStatePosition property.
Format Property
Specifies the Excel format in which the dashboard item is exported.
Declaration
Format?: DashboardExcelFormat
Property Value
Type | Description |
---|---|
DashboardExcelFormat | A DashboardExcelFormat object that specifies the Excel format in which the dashboard item is exported. |
IncludeHiddenParameters Property
Declaration
IncludeHiddenParameters?: boolean
Property Value
Type |
---|
boolean |