Skip to main content

DashboardExportExtensionOptions Interface

Provides options for customizing the DashboardExportExtension.

#Declaration

TypeScript
export interface DashboardExportExtensionOptions

#Remarks

See the following topic for information on how to use the DashboardControl’s client-side API: Extensions Overview.

The table below displays client-side API you can use to configure export options:

Export Type

DashboardExportExtension

DashboardExportExtensionOptions

Common

DashboardExportExtension.allowExportDashboard

DashboardExportExtension.allowExportDashboardItems

DashboardExportExtension.showExportDashboardDialog

DashboardExportExtension.showExportDashboardItemDialog

DashboardExportExtensionOptions.allowExportDashboard

DashboardExportExtensionOptions.allowExportDashboardItems

DashboardExportExtensionOptions.onExportDialogHidden

DashboardExportExtensionOptions.onExportDialogShowing

DashboardExportExtensionOptions.onExportDialogShown

Excel

DashboardExportExtension.getExcelExportOptions

DashboardExportExtension.setExcelExportOptions

DashboardExportExtension.exportToExcel

DashboardExportExtension.exportDashboardItemToExcel

DashboardExportExtensionOptions.excelExportOptions

Pdf

DashboardExportExtension.getPdfExportOptions

DashboardExportExtension.setPdfExportOptions

DashboardExportExtension.exportToPdf

DashboardExportExtension.exportDashboardItemToPdf

DashboardExportExtensionOptions.pdfExportOptions

Image

DashboardExportExtension.getImageExportOptions

DashboardExportExtension.setImageExportOptions

DashboardExportExtension.exportToImage

DashboardExportExtension.exportDashboardItemToImage

DashboardExportExtensionOptions.imageExportOptions

See Also

#Properties

#allowExportDashboard Property

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

#Declaration

TypeScript
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

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

#Declaration

TypeScript
excelExportOptions?: DevExpress.Dashboard.DashboardExcelExportOptions

#Property Value

Type Description
DashboardExcelExportOptions

A DashboardExcelExportOptions object that contains Excel export options.

#Remarks

The following example shows how to customize dashboard Excel export options when you initialize a dashboard control instance:

javascript
var dashboardControl = new DashboardControl(this.element.nativeElement.querySelector(".dashboard-container"),  {  
  endpoint: "https://demos.devexpress.com/services/dashboard/api",  
  workingMode: "Designer",
  extensions: {
    "dashboardExport": {
      excelExportOptions: {
        Format: "Xlsx",
        DashboardStatePosition = "SeparateSheet"
      }
    }
  }
});

#imageExportOptions Property

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

#Declaration

TypeScript
imageExportOptions?: DevExpress.Dashboard.DashboardImageExportOptions

#Property Value

Type Description
DashboardImageExportOptions

A DashboardExcelExportOptions object that contains Image export options.

#Remarks

The following example shows how to customize dashboard PDF export options when you initialize a dashboard control instance:

javascript
var dashboardControl = new DashboardControl(this.element.nativeElement.querySelector(".dashboard-container"),  {  
  endpoint: "https://demos.devexpress.com/services/dashboard/api",  
  workingMode: "Designer",
  extensions: {
    "dashboardExport": {
      imageExportOptions: {
        FontInfo: {
          UseCustomFontInfo: true,
          Name: "Tahoma",
          GdiCharSet: 1
        }
      }
    }
  }
});

#onExportDialogHidden Property

A handler for the event that occurs when the export dialog is hidden.

#Declaration

TypeScript
onExportDialogHidden?: (args: DashboardExportDialogArgs) => void

#Property Value

Type Description
(args: DashboardExportDialogArgs) => void

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

#onExportDialogShowing Property

A handler for the event that occurs before the export dialog is shown.

#Declaration

TypeScript
onExportDialogShowing?: (args: DashboardExportDialogArgs) => void

#Property Value

Type Description
(args: DashboardExportDialogArgs) => void

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

#onExportDialogShown Property

A handler for the event that occurs after the export dialog is shown.

#Declaration

TypeScript
onExportDialogShown?: (args: DashboardExportDialogArgs) => void

#Property Value

Type Description
(args: DashboardExportDialogArgs) => void

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

#pdfExportOptions Property

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

#Declaration

TypeScript
pdfExportOptions?: DevExpress.Dashboard.DashboardPdfExportOptions

#Property Value

Type Description
DashboardPdfExportOptions

A DashboardPdfExportOptions object that contains PDF export options.

#Remarks

The following example shows how to customize dashboard PDF export options when you initialize a dashboard control instance:

javascript
var dashboardControl = new DashboardControl(this.element.nativeElement.querySelector(".dashboard-container"),  {  
  endpoint: "https://demos.devexpress.com/services/dashboard/api",  
  workingMode: "Designer",
  extensions: {
    "dashboardExport": {
      pdfExportOptions: {
        FontInfo: {
          UseCustomFontInfo: true,
          Name: "Tahoma",
          GdiCharSet: 1
        }
      }
    }
  }
});
See Also