IScheduledExportAttachments
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
What the scheduled-export dialog’s attachment section displays, derived from the draft’s export definitions with the defaults applied.
export interface IScheduledExportAttachments
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) Raw-CSV settings; an undefined | |||
(BETA) CSV settings; an undefined | |||
boolean | (BETA) Whether the draft holds a widget CSV export definition. | ||
boolean | (BETA) Whether the draft holds a whole-dashboard export definition (true for a draft with none yet). | ||
boolean | (BETA) Whether the draft holds a widget XLSX export definition. | ||
(BETA) Tabular-PDF settings; page size defaults from the workspace locale, orientation to portrait, | |||
(BETA) The formats of the draft’s export definitions, in definition order. | |||
{ PPTX: string | undefined; PDF_SLIDES: string | undefined; PDF: string | undefined; } | (BETA) The slides template chosen per slides format; undefined where the default template applies. | ||
(BETA) XLSX settings; |
Property details
IScheduledExportAttachments.csvRawSettingspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Raw-CSV settings; an undefined delimiter is the backend default.
csvRawSettings: IExportDefinitionVisualizationObjectSettings;
IScheduledExportAttachments.csvSettingspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
CSV settings; an undefined delimiter is the backend default.
csvSettings: IExportDefinitionVisualizationObjectSettings;
IScheduledExportAttachments.isCsvExportSelectedpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Whether the draft holds a widget CSV export definition.
isCsvExportSelected: boolean;
IScheduledExportAttachments.isDashboardExportSelectedpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Whether the draft holds a whole-dashboard export definition (true for a draft with none yet).
isDashboardExportSelected: boolean;
IScheduledExportAttachments.isXlsxExportSelectedpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Whether the draft holds a widget XLSX export definition.
isXlsxExportSelected: boolean;
IScheduledExportAttachments.pdfSettingspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Tabular-PDF settings; page size defaults from the workspace locale, orientation to portrait, exportInfo to true.
pdfSettings: IExportDefinitionVisualizationObjectSettings;
IScheduledExportAttachments.selectedAttachmentspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The formats of the draft’s export definitions, in definition order.
selectedAttachments: Array<DashboardAttachmentType | WidgetAttachmentType>;
IScheduledExportAttachments.slidesTemplateIdspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The slides template chosen per slides format; undefined where the default template applies.
slidesTemplateIds: {
PPTX: string | undefined;
PDF_SLIDES: string | undefined;
PDF: string | undefined;
};
IScheduledExportAttachments.xlsxSettingspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
XLSX settings; mergeHeaders and exportInfo default to true.
xlsxSettings: IExportDefinitionVisualizationObjectSettings;