DashboardExportExtensionOptions Interface
Provides options for customizing the DashboardExportExtension.
#Declaration
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:
#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 Excel format.
#Declaration
excelExportOptions?: DevExpress.Dashboard.DashboardExcelExportOptions
#Property Value
Type | Description |
---|---|
Dashboard |
A Dashboard |
#Remarks
The following example shows how to customize dashboard Excel export options when you initialize a dashboard control instance:
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
imageExportOptions?: DevExpress.Dashboard.DashboardImageExportOptions
#Property Value
Type | Description |
---|---|
Dashboard |
A Dashboard |
#Remarks
The following example shows how to customize dashboard PDF export options when you initialize a dashboard control instance:
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
onExportDialogHidden?: (args: DashboardExportDialogArgs) => void
#Property Value
Type | Description |
---|---|
(args: Dashboard |
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
onExportDialogShowing?: (args: DashboardExportDialogArgs) => void
#Property Value
Type | Description |
---|---|
(args: Dashboard |
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
onExportDialogShown?: (args: DashboardExportDialogArgs) => void
#Property Value
Type | Description |
---|---|
(args: Dashboard |
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
pdfExportOptions?: DevExpress.Dashboard.DashboardPdfExportOptions
#Property Value
Type | Description |
---|---|
Dashboard |
A Dashboard |
#Remarks
The following example shows how to customize dashboard PDF export options when you initialize a dashboard control instance:
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
}
}
}
}
});