IScheduledEmailDialogDashboardAttachmentsProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Props of the scheduled-export dialog’s dashboard-attachments field.
export interface IScheduledEmailDialogDashboardAttachmentsProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) (Optional) Dashboard filters the export is scoped to; the control passes them back as the second argument of every IScheduledEmailDialogDashboardAttachmentsProps.onDashboardAttachmentsChange call. | |||
(BETA) (Optional) Export templates offered in the template picker of the slide-based formats. | |||
boolean | (BETA) When true and at least one attachment is selected, the control shows the notice that exports do not reflect cross-filtering. | ||
boolean | (BETA) Whether the slide-based formats (PPTX, PDF slides) are offered; when false they are excluded from the add-attachment options. | ||
(formats: DashboardAttachmentType[], filters?: FilterContextItem[]) => void | (BETA) Replaces the selected dashboard export formats. Called with the complete new selection and the current IScheduledEmailDialogDashboardAttachmentsProps.dashboardFilters. | ||
(templateId: string | undefined, format: “PPTX” | “PDF_SLIDES” | “PDF”) => void | (BETA) (Optional) Sets the export template of one slide-based format. | ||
(settings: IExportDefinitionVisualizationObjectSettings) => void | (BETA) Sets the XLSX export settings. | ||
(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
IScheduledEmailDialogDashboardAttachmentsProps.dashboardFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Dashboard filters the export is scoped to; the control passes them back as the second argument of every IScheduledEmailDialogDashboardAttachmentsProps.onDashboardAttachmentsChange call.
dashboardFilters?: FilterContextItem[];
IScheduledEmailDialogDashboardAttachmentsProps.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[];
IScheduledEmailDialogDashboardAttachmentsProps.isCrossFilteringpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
When true and at least one attachment is selected, the control shows the notice that exports do not reflect cross-filtering.
isCrossFiltering: boolean;
IScheduledEmailDialogDashboardAttachmentsProps.isSlidesExportEnabledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Whether the slide-based formats (PPTX, PDF slides) are offered; when false they are excluded from the add-attachment options.
isSlidesExportEnabled: boolean;
IScheduledEmailDialogDashboardAttachmentsProps.onDashboardAttachmentsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Replaces the selected dashboard export formats. Called with the complete new selection and the current IScheduledEmailDialogDashboardAttachmentsProps.dashboardFilters.
onDashboardAttachmentsChange: (formats: DashboardAttachmentType[], filters?: FilterContextItem[]) => void;
IScheduledEmailDialogDashboardAttachmentsProps.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;
IScheduledEmailDialogDashboardAttachmentsProps.onXlsxSettingsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Sets the XLSX export settings.
onXlsxSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
IScheduledEmailDialogDashboardAttachmentsProps.selectedAttachmentspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The selected export formats.
selectedAttachments: DashboardAttachmentType[];
IScheduledEmailDialogDashboardAttachmentsProps.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;
};
IScheduledEmailDialogDashboardAttachmentsProps.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;