exportDashboardToPdfPresentation()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
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.
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