IDashboardExportPdfOptions

IDashboardExportPdfOptions.exportMetadatapropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Custom export metadata forwarded through the export flow.

exportMetadata?: Record<string, string>;

IDashboardExportPdfOptions.filenamepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Filename for the export. If not provided, the dashboard title will be fetched.

filename?: string;

IDashboardExportPdfOptions.parametersByTabpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Per-tab parameter runtime-overrides applied when rendering the exported file. Keyed by tablocalIdentifier. Mirrors dashboardTabsParametersOverrides on the tabular options.

parametersByTab?: Record<string, IDashboardExportParameter[]>;

IDashboardExportPdfOptions.timeoutpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Override the default export result polling timeout (in milliseconds).

timeout?: number;

Remarks

If not specified, there is still a default timeout applied. You can use this to make the timeout more aggressive or more relaxed than the default. We recommend not setting this lower than 5 seconds as it would mean only one attempt would be made.