exportDashboardToImage()

Home > @gooddata/sdk-backend-spi > IWorkspaceDashboardsService > exportDashboardToImage

IWorkspaceDashboardsService.exportDashboardToImage() method

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Export dashboard to png.

PNG file is downloaded and attached as Blob data to the current window instance. If title is not provided, the dashboard title will be fetched.

Signature:

exportDashboardToImage(ref: ObjRef, options?: IDashboardExportImageOptions): Promise<IExportResult>;

Parameters

ParameterTypeDescription
refObjRefdashboard reference
optionsIDashboardExportImageOptions(Optional) export options

Returns:

Promise<IExportResult>

promise with object URL pointing to a Blob data of downloaded exported dashboard