ASPxClientDashboard.ExportDashboardItemToImage(String, ASPxClientDashboardExportOptions) Method

OBSOLETE

This method is obsolete now. Use the ExportDashboardItemToImage instead. To learn more, see the following KB article: https://www.devexpress.com/Support/Center/Question/Details/T488764

Exports a dashboard item to an Image file with the specified export options and writes it to the Response.

Namespace: DevExpress.DashboardWeb.Scripts

Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.Scripts.dll

Declaration

C#

[Obsolete("This method is obsolete now. Use the ASPxClientDashboard.ExportDashboardItemToImage(string itemName, DashboardImageExportOptions options) methods instead. To learn more, see the following KB article: https://www.devexpress.com/Support/Center/Question/Details/T488764")]
public void ExportDashboardItemToImage(
    string itemName,
    ASPxClientDashboardExportOptions options
)

VB.NET

<Obsolete("This method is obsolete now. Use the ASPxClientDashboard.ExportDashboardItemToImage(string itemName, DashboardImageExportOptions options) methods instead. To learn more, see the following KB article: https://www.devexpress.com/Support/Center/Question/Details/T488764")>
Public Sub ExportDashboardItemToImage(
    itemName As String,
    options As ASPxClientDashboardExportOptions
)

Parameters

Name	Type	Description
itemName	String	A string that is the component name of the dashboard item to be exported.
options	ASPxClientDashboardExportOptions	An ASPxClientDashboardExportOptions object containing export options to be applied to the exported dashboard item.

Remarks

Suppose that the ASPxDashboard displays a dashboard that contains a Grid dashboard item. The client identifier (ASPxDashboard.ClientInstanceName) of the Web Dashboard is set to ‘webDashboard’. The following code snippet demonstrates how to export the Grid dashboard item to an Image with the specified options.

JS

function(s, e) {
    webDashboard.ExportDashboardItemToImage('gridDashboardItem1', {
    IncludeCaption: true,
    Caption: 'Sales Details',
    FilterState: DashboardExportFilterState.Below,
    ImageOptions: {
        Format: DashboardExportImageFormat.Png,
        Resolution: 200
        }
    });
}