IScheduledEmailDialogWidgetAttachmentsProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Props of the scheduled-export dialog’s widget-attachments field.
export interface IScheduledEmailDialogWidgetAttachmentsProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) Raw-CSV export settings shown in the attachment’s settings editor. | |||
(BETA) CSV export settings shown in the attachment’s settings editor. | |||
(BETA) (Optional) Export templates offered in the template picker of the slide-based formats. | |||
boolean | (BETA) When true, formats without an accessible rendering (PDF_TABULAR) are excluded from the add-attachment options. | ||
boolean | (BETA) Whether the slide-based formats (PPTX, PDF) are offered; when false they are excluded from the add-attachment options. | ||
(settings: IExportDefinitionVisualizationObjectSettings) => void | (BETA) Sets the raw-CSV export settings. | ||
(settings: IExportDefinitionVisualizationObjectSettings) => void | (BETA) Sets the CSV export settings. | ||
(settings: IExportDefinitionVisualizationObjectSettings) => void | (BETA) Sets the tabular-PDF export settings. | ||
(templateId: string | undefined, format: “PPTX” | “PDF_SLIDES” | “PDF”) => void | (BETA) (Optional) Sets the export template of one slide-based format. | ||
(formats: WidgetAttachmentType[]) => void | (BETA) Replaces the selected widget export formats with the complete new selection. | ||
(settings: IExportDefinitionVisualizationObjectSettings) => void | (BETA) Sets the XLSX export settings. | ||
(BETA) Tabular-PDF export settings shown in the attachment’s settings editor. | |||
(BETA) The selected export formats. | |||
{ PPTX?: string; PDF_SLIDES?: string; PDF?: string; } | (BETA) (Optional) The template chosen per slide-based format; undefined where the default template applies. | ||
(BETA) XLSX export settings shown in the attachment’s settings editor. |
Property details
IScheduledEmailDialogWidgetAttachmentsProps.csvRawSettingspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Raw-CSV export settings shown in the attachment’s settings editor.
csvRawSettings: IExportDefinitionVisualizationObjectSettings;
IScheduledEmailDialogWidgetAttachmentsProps.csvSettingspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
CSV export settings shown in the attachment’s settings editor.
csvSettings: IExportDefinitionVisualizationObjectSettings;
IScheduledEmailDialogWidgetAttachmentsProps.exportTemplatespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Export templates offered in the template picker of the slide-based formats.
exportTemplates?: IExportTemplate[];
IScheduledEmailDialogWidgetAttachmentsProps.isAccessibilityModeEnabledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
When true, formats without an accessible rendering (PDF_TABULAR) are excluded from the add-attachment options.
isAccessibilityModeEnabled: boolean;
IScheduledEmailDialogWidgetAttachmentsProps.isSlidesExportEnabledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Whether the slide-based formats (PPTX, PDF) are offered; when false they are excluded from the add-attachment options.
isSlidesExportEnabled: boolean;
IScheduledEmailDialogWidgetAttachmentsProps.onCsvRawSettingsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the raw-CSV export settings.
onCsvRawSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
IScheduledEmailDialogWidgetAttachmentsProps.onCsvSettingsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the CSV export settings.
onCsvSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
IScheduledEmailDialogWidgetAttachmentsProps.onPdfSettingsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the tabular-PDF export settings.
onPdfSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
IScheduledEmailDialogWidgetAttachmentsProps.onSlidesTemplateIdChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the export template of one slide-based format.
onSlidesTemplateIdChange?: (templateId: string | undefined, format: "PPTX" | "PDF_SLIDES" | "PDF") => void;
IScheduledEmailDialogWidgetAttachmentsProps.onWidgetAttachmentsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Replaces the selected widget export formats with the complete new selection.
onWidgetAttachmentsChange: (formats: WidgetAttachmentType[]) => void;
IScheduledEmailDialogWidgetAttachmentsProps.onXlsxSettingsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the XLSX export settings.
onXlsxSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
IScheduledEmailDialogWidgetAttachmentsProps.pdfSettingspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Tabular-PDF export settings shown in the attachment’s settings editor.
pdfSettings: IExportDefinitionVisualizationObjectSettings;
IScheduledEmailDialogWidgetAttachmentsProps.selectedAttachmentspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The selected export formats.
selectedAttachments: WidgetAttachmentType[];
IScheduledEmailDialogWidgetAttachmentsProps.slidesTemplateIdspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The template chosen per slide-based format; undefined where the default template applies.
slidesTemplateIds?: {
PPTX?: string;
PDF_SLIDES?: string;
PDF?: string;
};
IScheduledEmailDialogWidgetAttachmentsProps.xlsxSettingspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
XLSX export settings shown in the attachment’s settings editor.
xlsxSettings: IExportDefinitionVisualizationObjectSettings;