DashboardImageExportOptions Class
Contains options related to exporting a dashboard/dashboard item to an image.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v24.2.Core.dll
NuGet Package: DevExpress.Dashboard.Core
#Declaration
public class DashboardImageExportOptions :
IDashboardImageExportOptions,
IDashboardExportOptions
#Related API Members
The following members return DashboardImageExportOptions objects:
#Remarks
The following properties allow you to access default image-specific export options for different controls.
- ASPxDashboard.ImageExportOptions / DashboardExtensionSettings.ImageExportOptions
- DashboardDesigner.ImageExportOptions
- DashboardViewer.ImageExportOptions
- DashboardControl.ImageExportOptions
Moreover, you can specify image options when exporting a dashboard/dashboard item using the following methods.
- WebDashboardExporter.ExportToImage / WebDashboardExporter.ExportDashboardItemToImage
- DashboardDesigner.ExportToImage / DashboardDesigner.ExportDashboardItemToImage
- DashboardViewer.ExportToImage / DashboardViewer.ExportDashboardItemToImage
- DashboardControl.ExportToImage / DashboardControl.ExportDashboardItemToImage
Note
To export a dashboard/dashboard item on the web using an API, use the Export
#Example
The following code snippet shows how to export the Chart dashboard item displayed within the DashboardDesigner using the DashboardDesigner.ExportDashboardItemToImage method with specific image-export options specified.
using DevExpress.DashboardCommon;
// ...
dashboardDesigner1.ExportDashboardItemToImage("chartDashboardItem1", @"c:\temp\ExportedImage.jpg", new DashboardImageExportOptions() {
Format = DashboardExportImageFormat.Jpeg,
ScaleFactor = 1.5f
}
);