DashboardExportExtensionOptions Interface

Provides options for customizing the DashboardExportExtension.

Declaration

export interface DashboardExportExtensionOptions

Properties

allowExportDashboard Property

Specifies whether the entire dashboard can be exported by end-users.

Declaration

allowExportDashboard?: boolean

Property Value

Type Description
boolean

true, if end-users can export the entire dashboard; otherwise, false.

allowExportDashboardItems Property

Specifies whether the dashboard items can be exported by end-users.

Declaration

allowExportDashboardItems?: boolean

Property Value

Type Description
boolean

true, if end-users can export the dashboard items; otherwise, false.

excelExportOptions Property

Provides access to options related to exporting a dashboard/dashboard item to the Excel format.

Declaration

excelExportOptions?: DashboardExcelExportOptions

Property Value

Type Description
DashboardExcelExportOptions

A DashboardExcelExportOptions object that contains Excel export options.

imageExportOptions Property

Provides access to options related to exporting a dashboard/dashboard item to an image.

Declaration

imageExportOptions?: DashboardImageExportOptions

Property Value

Type Description
DashboardImageExportOptions

A DashboardExcelExportOptions object that contains Image export options.

onExportDialogHidden Property

A handler for the event occurring when the export dialog is hidden.

Declaration

onExportDialogHidden?: (args: any) => void

Property Value

Type Description
(args: any) => void

A custom function that is executed when the export dialog is hidden.

onExportDialogShowing Property

A handler for the event occurring before the export dialog is shown.

Declaration

onExportDialogShowing?: (args: any) => void

Property Value

Type Description
(args: any) => void

A custom function that is executed before the export dialog is shown.

onExportDialogShown Property

A handler for the event occurring after the export dialog is shown.

Declaration

onExportDialogShown?: (args: any) => void

Property Value

Type Description
(args: any) => void

A custom function that is executed after the export dialog is shown.

pdfExportOptions Property

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

Declaration

pdfExportOptions?: DashboardPdfExportOptions

Property Value

Type Description
DashboardPdfExportOptions

A DashboardPdfExportOptions object that contains PDF export options.