> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IScheduledEmailDialogFiltersProps

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/presentation/automations/scheduledEmail/types.ts

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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

**Signature:**

```typescript
export interface IScheduledEmailDialogFiltersProps extends IAutomationDialogFiltersProps 
```
**Extends:** [IAutomationDialogFiltersProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iautomationdialogfiltersprops/index.md)

## 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?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsavailableparametersbytab) |  | Record<string, IAvailableAutomationParameter[]> | **_(BETA)_** _(Optional)_ Addable workspace parameters per tab (by-tab mode). |
| [editedFiltersByTab?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropseditedfiltersbytab) |  | Record<string, [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[]> | **_(BETA)_** _(Optional)_ Edited filter selection per tab. |
| [filtersByTab?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsfiltersbytab) |  | [IAutomationFiltersTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iautomationfilterstab/index.md)[] | **_(BETA)_** _(Optional)_ Filters structured per dashboard tab; when present with more than one tab, the region renders in by-tab mode. |
| [isDashboardAutomation](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsisdashboardautomation) |  | boolean | **_(BETA)_** Whether the schedule targets the whole dashboard (shows the store-filters checkbox) rather than a single widget. |
| [onFiltersByTabChange?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsonfiltersbytabchange) |  | (filtersByTab: Record<string, [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[]>) => void | **_(BETA)_** _(Optional)_ Replaces a tab's filter selection with the complete updated record. |
| [onParameterAddByTab?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsonparameteraddbytab) |  | (tabId: string, ref: [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md)) => void | **_(BETA)_** _(Optional)_ Called when a parameter is added in a tab section (by-tab mode). |
| [onParameterChangeByTab?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsonparameterchangebytab) |  | (tabId: string, ref: [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md), value: [ParameterValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.parametervalue/index.md)) => void | **_(BETA)_** _(Optional)_ Called when a parameter chip's value is edited in a tab section (by-tab mode). |
| [onParameterDeleteByTab?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsonparameterdeletebytab) |  | (tabId: string, ref: [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md)) => void | **_(BETA)_** _(Optional)_ Called when a parameter chip is removed in a tab section (by-tab mode). |
| [onStoreFiltersChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsonstorefilterschange) |  | (value: boolean, filters?: [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[], filtersByTab?: Record<string, [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[]>) => void | **_(BETA)_** 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?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsparametersbytab) |  | Record<string, [IAutomationParameter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iautomationparameter/index.md)[]> | **_(BETA)_** _(Optional)_ Parameter chips per tab (by-tab mode). |
| [parametersEnabled?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsparametersenabled) |  | boolean | **_(BETA)_** _(Optional)_ Whether workspace parameters are enabled; adjusts the store-filters tooltip copy. |
| [storeFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogfiltersprops/index.md#ischeduledemaildialogfilterspropsstorefilters) |  | boolean | **_(BETA)_** Whether the schedule stores its own filters instead of using the latest saved dashboard filters. |

## Property details

### IScheduledEmailDialogFiltersProps.availableParametersByTab

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Addable workspace parameters per tab (by-tab mode).

**Signature:**

```typescript
availableParametersByTab?: Record<string, IAvailableAutomationParameter[]>;
```

### IScheduledEmailDialogFiltersProps.editedFiltersByTab

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Edited filter selection per tab.

**Signature:**

```typescript
editedFiltersByTab?: Record<string, FilterContextItem[]>;
```

### IScheduledEmailDialogFiltersProps.filtersByTab

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Filters structured per dashboard tab; when present with more than one tab, the region renders in by-tab mode.

**Signature:**

```typescript
filtersByTab?: IAutomationFiltersTab[];
```

### IScheduledEmailDialogFiltersProps.isDashboardAutomation

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Whether the schedule targets the whole dashboard (shows the store-filters checkbox) rather than a single widget.

**Signature:**

```typescript
isDashboardAutomation: boolean;
```

### IScheduledEmailDialogFiltersProps.onFiltersByTabChange

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Replaces a tab's filter selection with the complete updated record.

**Signature:**

```typescript
onFiltersByTabChange?: (filtersByTab: Record<string, FilterContextItem[]>) => void;
```

### IScheduledEmailDialogFiltersProps.onParameterAddByTab

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Called when a parameter is added in a tab section (by-tab mode).

**Signature:**

```typescript
onParameterAddByTab?: (tabId: string, ref: IdentifierRef) => void;
```

### IScheduledEmailDialogFiltersProps.onParameterChangeByTab

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Called when a parameter chip's value is edited in a tab section (by-tab mode).

**Signature:**

```typescript
onParameterChangeByTab?: (tabId: string, ref: IdentifierRef, value: ParameterValue) => void;
```

### IScheduledEmailDialogFiltersProps.onParameterDeleteByTab

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Called when a parameter chip is removed in a tab section (by-tab mode).

**Signature:**

```typescript
onParameterDeleteByTab?: (tabId: string, ref: IdentifierRef) => void;
```

### IScheduledEmailDialogFiltersProps.onStoreFiltersChange

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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.

**Signature:**

```typescript
onStoreFiltersChange: (value: boolean, filters?: FilterContextItem[], filtersByTab?: Record<string, FilterContextItem[]>) => void;
```

### IScheduledEmailDialogFiltersProps.parametersByTab

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Parameter chips per tab (by-tab mode).

**Signature:**

```typescript
parametersByTab?: Record<string, IAutomationParameter[]>;
```

### IScheduledEmailDialogFiltersProps.parametersEnabled

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Whether workspace parameters are enabled; adjusts the store-filters tooltip copy.

**Signature:**

```typescript
parametersEnabled?: boolean;
```

### IScheduledEmailDialogFiltersProps.storeFilters

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Whether the schedule stores its own filters instead of using the latest saved dashboard filters.

**Signature:**

```typescript
storeFilters: boolean;
```