IScheduledEmailDialogFiltersProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Props of the default scheduled email dialog’s filters region (the Filters tab content).
export interface IScheduledEmailDialogFiltersProps extends IAutomationDialogFiltersProps
Extends: IAutomationDialogFiltersProps
Remarks
The region is bimodal: whenever filtersByTab is present with more than one tab, the by-tab members (filtersByTab and the *ByTab parameter family) drive rendering and the flat handlers are unused; otherwise the flat members drive it and the by-tab members are unused. defaultProps always carries both families so a wrap stays faithful in either mode.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
Record<string, IAvailableAutomationParameter[]> | (BETA) (Optional) Addable workspace parameters per tab (by-tab mode). | ||
Record<string, FilterContextItem[]> | (BETA) (Optional) Edited filter selection per tab. | ||
(BETA) (Optional) Filters structured per dashboard tab; when present with more than one tab, the region renders in by-tab mode. | |||
boolean | (BETA) Whether the schedule targets the whole dashboard (shows the store-filters checkbox) rather than a single widget. | ||
(filtersByTab: Record<string, FilterContextItem[]>) => void | (BETA) (Optional) Replaces a tab’s filter selection with the complete updated record. | ||
(tabId: string, ref: IdentifierRef) => void | (BETA) (Optional) Called when a parameter is added in a tab section (by-tab mode). | ||
(tabId: string, ref: IdentifierRef, value: ParameterValue) => void | (BETA) (Optional) Called when a parameter chip’s value is edited in a tab section (by-tab mode). | ||
(tabId: string, ref: IdentifierRef) => void | (BETA) (Optional) Called when a parameter chip is removed in a tab section (by-tab mode). | ||
(value: boolean, filters?: FilterContextItem[], filtersByTab?: Record<string, FilterContextItem[]>) => void | (BETA) Toggles filter (and parameter) persistence. The current filters must be passed back — flat mode as | ||
Record<string, IAutomationParameter[]> | (BETA) (Optional) Parameter chips per tab (by-tab mode). | ||
boolean | (BETA) (Optional) Whether workspace parameters are enabled; adjusts the store-filters tooltip copy. | ||
boolean | (BETA) Whether the schedule stores its own filters instead of using the latest saved dashboard filters. |
Property details
IScheduledEmailDialogFiltersProps.availableParametersByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Addable workspace parameters per tab (by-tab mode).
availableParametersByTab?: Record<string, IAvailableAutomationParameter[]>;
IScheduledEmailDialogFiltersProps.editedFiltersByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Edited filter selection per tab.
editedFiltersByTab?: Record<string, FilterContextItem[]>;
IScheduledEmailDialogFiltersProps.filtersByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Filters structured per dashboard tab; when present with more than one tab, the region renders in by-tab mode.
filtersByTab?: IAutomationFiltersTab[];
IScheduledEmailDialogFiltersProps.isDashboardAutomationpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether the schedule targets the whole dashboard (shows the store-filters checkbox) rather than a single widget.
isDashboardAutomation: boolean;
IScheduledEmailDialogFiltersProps.onFiltersByTabChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Replaces a tab’s filter selection with the complete updated record.
onFiltersByTabChange?: (filtersByTab: Record<string, FilterContextItem[]>) => void;
IScheduledEmailDialogFiltersProps.onParameterAddByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called when a parameter is added in a tab section (by-tab mode).
onParameterAddByTab?: (tabId: string, ref: IdentifierRef) => void;
IScheduledEmailDialogFiltersProps.onParameterChangeByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called when a parameter chip’s value is edited in a tab section (by-tab mode).
onParameterChangeByTab?: (tabId: string, ref: IdentifierRef, value: ParameterValue) => void;
IScheduledEmailDialogFiltersProps.onParameterDeleteByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Called when a parameter chip is removed in a tab section (by-tab mode).
onParameterDeleteByTab?: (tabId: string, ref: IdentifierRef) => void;
IScheduledEmailDialogFiltersProps.onStoreFiltersChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Toggles filter (and parameter) persistence. The current filters must be passed back — flat mode as (value, selectedFilters, undefined), by-tab mode as (value, undefined, editedFiltersByTab); calling it with the value alone leaves the draft’s export definitions out of sync with the toggle.
onStoreFiltersChange: (value: boolean, filters?: FilterContextItem[], filtersByTab?: Record<string, FilterContextItem[]>) => void;
IScheduledEmailDialogFiltersProps.parametersByTabpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Parameter chips per tab (by-tab mode).
parametersByTab?: Record<string, IAutomationParameter[]>;
IScheduledEmailDialogFiltersProps.parametersEnabledpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether workspace parameters are enabled; adjusts the store-filters tooltip copy.
parametersEnabled?: boolean;
IScheduledEmailDialogFiltersProps.storeFilterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Whether the schedule stores its own filters instead of using the latest saved dashboard filters.
storeFilters: boolean;