IDashboardExportPresentationOptions
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Options for exporting a dashboard to a presentation.
export interface IDashboardExportPresentationOptions extends IDashboardExportTimezoneOptions
Extends: IDashboardExportTimezoneOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
Record<string, string> | (BETA) (Optional) | ||
string | (BETA) (Optional) | ||
boolean | (BETA) (Optional) | ||
Record<string, IDashboardExportParameter[]> | (BETA) (Optional) Per-tab parameter runtime-overrides applied when rendering the exported slides. Keyed by tab | ||
string | (BETA) (Optional) | ||
number | (BETA) (Optional) Override the default export result polling timeout (in milliseconds). | ||
string | (BETA) (Optional) | ||
ObjRef[] | (BETA) (Optional) | ||
ObjRef[] | (BETA) (Optional) |
Property details
IDashboardExportPresentationOptions.exportMetadatapropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
exportMetadata?: Record<string, string>;
IDashboardExportPresentationOptions.filenamepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
filename?: string;
IDashboardExportPresentationOptions.hideWidgetTitlespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
hideWidgetTitles?: boolean;
IDashboardExportPresentationOptions.parametersByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Per-tab parameter runtime-overrides applied when rendering the exported slides. Keyed by tab localIdentifier; a widget-scoped export carries the single owning tab. Mirrors dashboardTabsParametersOverrides on the tabular options.
parametersByTab?: Record<string, IDashboardExportParameter[]>;
IDashboardExportPresentationOptions.templateIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
templateId?: string;
IDashboardExportPresentationOptions.timeoutpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
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.
IDashboardExportPresentationOptions.titlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
title?: string;
IDashboardExportPresentationOptions.visualizationIdspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
visualizationIds?: ObjRef[];
IDashboardExportPresentationOptions.widgetIdspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
widgetIds?: ObjRef[];