exportDashboardToPdfPresentation()
Home > @gooddata/sdk-ui-dashboard > exportDashboardToPdfPresentation
exportDashboardToPdfPresentation() function
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the IExportDashboardToPdfPresentation command. Dispatching this command will result in a request to export the dashboard to a PDF presentation file. If successful, an instance of IDashboardExportToPdfPresentationResolved will be emitted with the URL of the resulting file.
Signature:
export declare function exportDashboardToPdfPresentation(payload?: IExportDashboardToPresentationPayload, correlationId?: string): IExportDashboardToPdfPresentation;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
payload |
(Optional) payload to override the dashboard export options. If not provided, the dashboard will be exported with the current filter context and options. | |
|
correlationId |
string |
(Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |
Returns: