IScheduledEmailDialogFiltersProps

Home > @gooddata/sdk-ui-dashboard > IScheduledEmailDialogFiltersProps

IScheduledEmailDialogFiltersProps interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Props of the default scheduled email dialog's filters region (the Filters tab content).

Signature:

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
availableParametersByTab?		Record<string, IAutomationParameter[]>	(ALPHA) (Optional) Addable workspace parameters per tab (by-tab mode).
editedFiltersByTab?		Record<string, FilterContextItem[]>	(ALPHA) (Optional) Edited filter selection per tab.
filtersByTab?		IAutomationFiltersTab[]	(ALPHA) (Optional) Filters structured per dashboard tab; when present with more than one tab, the region renders in by-tab mode.
isDashboardAutomation		boolean	(ALPHA) Whether the schedule targets the whole dashboard (shows the store-filters checkbox) rather than a single widget.
onFiltersByTabChange?		(filtersByTab: Record<string, FilterContextItem[]>) => void	(ALPHA) (Optional) Replaces a tab's filter selection with the complete updated record.
onParameterAddByTab?		(tabId: string, ref: IdentifierRef) => void	(ALPHA) (Optional) Called when a parameter is added in a tab section (by-tab mode).
onParameterChangeByTab?		(tabId: string, ref: IdentifierRef, value: ParameterValue) => void	(ALPHA) (Optional) Called when a parameter chip's value is edited in a tab section (by-tab mode).
onParameterDeleteByTab?		(tabId: string, ref: IdentifierRef) => void	(ALPHA) (Optional) Called when a parameter chip is removed in a tab section (by-tab mode).
onStoreFiltersChange		(value: boolean, filters?: FilterContextItem[], filtersByTab?: Record<string, FilterContextItem[]>) => void	(ALPHA) 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.
parametersByTab?		Record<string, IAutomationParameter[]>	(ALPHA) (Optional) Parameter chips per tab (by-tab mode).
parametersEnabled?		boolean	(ALPHA) (Optional) Whether workspace parameters are enabled; adjusts the store-filters tooltip copy.
storeFilters		boolean	(ALPHA) Whether the schedule stores its own filters instead of using the latest saved dashboard filters.