ASPxClientDashboardViewer.ExportDashboardItemToImage(String, ASPxClientDashboardExportOptions) Method

Obsolete. 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

[Obsolete("This method is obsolete now. Use the ASPxClientDashboardViewer.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
)
<Obsolete("This method is obsolete now. Use the ASPxClientDashboardViewer.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

Type Name Description
String itemName

A String that is the component name of the dashboard item to be exported.

ASPxClientDashboardExportOptions options

An ASPxClientDashboardExportOptions object containing export options to be applied to the exported dashboard item.

Remarks

Suppose that the ASPxDashboardViewer displays a dashboard that contains a Grid dashboard item. The client identifier (ASPxDashboardViewer.ClientInstanceName) of the Web Viewer is set to 'webViewer'. The following code snippet demonstrates how to export the Grid dashboard item to an Image with the specified options.

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