exportDashboardToPresentation()

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

IWorkspaceDashboardsService.exportDashboardToPresentation() 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 pdf. You can override dashboard filters with custom filters. When no custom filters are set, the persisted dashboard filters will be used.

PDF file is downloaded and attached as Blob data to the current window instance.

Signature:

exportDashboardToPresentation(ref: ObjRef, format: "PDF" | "PPTX", filters?: FilterContextItem[], options?: IDashboardExportPresentationOptions): Promise<IExportResult>;

Parameters

Parameter	Type	Description
ref	ObjRef	dashboard reference
format	"PDF" | "PPTX"	export format
filters	FilterContextItem[]	(Optional) Override stored dashboard filters with custom filters
options	IDashboardExportPresentationOptions	(Optional) additional options

Returns:

Promise<IExportResult>

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