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

# IScheduledExportFiltersContextValue

- 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/state/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).
> 

The scheduled-export dialog's filter and export-parameter model: the current selection and available filters (flat and per tab), the handlers that mutate them, the staleness gate, and the export-parameter chips with their handlers.

Changes when a filter, a parameter or the store-filters toggle is edited; never per keystroke.

**Signature:**

```typescript
export interface IScheduledExportFiltersContextValue 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [applyLatest](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueapplylatest) |  | () => void | **_(BETA)_** Resets the parameters to the dashboard's current effective values (the "apply latest" flow). |
| [automationIsValid](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueautomationisvalid) |  | boolean | **_(BETA)_** False when the saved filters or the saved parameters no longer match the dashboard; gates the stale-filters confirmation. |
| [availableFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueavailablefilters) |  | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] \| undefined | **_(BETA)_** The dashboard filters the schedule may use; undefined until resolved. |
| [availableParametersByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueavailableparametersbytab) |  | Record<string, IAvailableAutomationParameter[]> | **_(BETA)_** Per-tab workspace parameters addable via the "+" menu. |
| [editedFiltersByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueeditedfiltersbytab) |  | Record<string, [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[]> \| undefined | **_(BETA)_** The edited selection per dashboard tab (by-tab mode). |
| [filtersAreStale](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvaluefiltersarestale) |  | boolean | **_(BETA)_** Whether the saved filters alone no longer match the dashboard. |
| [filtersByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvaluefiltersbytab) |  | [IAutomationFiltersTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iautomationfilterstab/index.md)[] \| undefined | **_(BETA)_** Filters structured per dashboard tab; present with more than one tab. |
| [flatTabId](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueflattabid) |  | string \| undefined | **_(BETA)_** The tab the flat (non-tabbed) UI edits; undefined for multi-tab dashboards or when no parameter context applies. |
| [onApplyCurrentFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonapplycurrentfilters) |  | () => void | **_(BETA)_** Replaces the selection with the dashboard's current filters (the stale-filters repair). |
| [onFiltersByTabChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonfiltersbytabchange) |  | (newFiltersByTab: Record<string, [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[]>, storeFiltersParam?: boolean) => void | **_(BETA)_** By-tab counterpart of `onFiltersChange`: replaces the per-tab selection wholesale. |
| [onFiltersChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonfilterschange) |  | (filters: [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[], storeFiltersParam?: boolean) => void | **_(BETA)_** Replaces the selection with the complete updated array and mirrors it into the export definitions. `storeFiltersParam` overrides the current toggle value for this write. |
| [onParameterAdd](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonparameteradd) |  | (ref: [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md)) => void | **_(BETA)_** Adds a workspace parameter with its default value on the flat tab. |
| [onParameterAddByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonparameteraddbytab) |  | (tabId: string, ref: [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md)) => void | **_(BETA)_** Adds a workspace parameter with its default value on the given tab. |
| [onParameterChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonparameterchange) |  | (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)_** Sets a parameter's value on the flat tab. |
| [onParameterChangeByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonparameterchangebytab) |  | (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)_** Sets a parameter's value on the given tab. |
| [onParameterDelete](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonparameterdelete) |  | (ref: [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md)) => void | **_(BETA)_** Removes a parameter override on the flat tab. |
| [onParameterDeleteByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonparameterdeletebytab) |  | (tabId: string, ref: [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md)) => void | **_(BETA)_** Removes a parameter override on the given tab. |
| [onStoreFiltersChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonstorefilterschange) |  | (value: boolean, filters?: [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[], filtersByTabParam?: 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, filters, undefined)`, by-tab mode as `(value, undefined, filtersByTab)`. |
| [onStoreParametersChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueonstoreparameterschange) |  | (storeParameters: boolean) => void | **_(BETA)_** Re-encodes the parameters onto the automation with the new persistence value. |
| [parametersEnabled](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueparametersenabled) |  | boolean | **_(BETA)_** Whether the export-parameters feature is on; the parameter members below are empty when off. |
| [selectedFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvalueselectedfilters) |  | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | **_(BETA)_** The filters the schedule is saved with (flat mode). |
| [storeFilters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvaluestorefilters) |  | boolean | **_(BETA)_** Whether the schedule stores its own filters instead of using the latest saved dashboard filters. |
| [visibleParametersByTab](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportfilterscontextvalue/index.md#ischeduledexportfilterscontextvaluevisibleparametersbytab) |  | Record<string, [IAutomationParameter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iautomationparameter/index.md)[]> | **_(BETA)_** Per-tab visible parameters to render as chips. |

## Property details

### IScheduledExportFiltersContextValue.applyLatest

> **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).
> 

Resets the parameters to the dashboard's current effective values (the "apply latest" flow).

**Signature:**

```typescript
applyLatest: () => void;
```

### IScheduledExportFiltersContextValue.automationIsValid

> **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).
> 

False when the saved filters or the saved parameters no longer match the dashboard; gates the stale-filters confirmation.

**Signature:**

```typescript
automationIsValid: boolean;
```

### IScheduledExportFiltersContextValue.availableFilters

> **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).
> 

The dashboard filters the schedule may use; undefined until resolved.

**Signature:**

```typescript
availableFilters: FilterContextItem[] | undefined;
```

### IScheduledExportFiltersContextValue.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).
> 

Per-tab workspace parameters addable via the "+" menu.

**Signature:**

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

### IScheduledExportFiltersContextValue.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).
> 

The edited selection per dashboard tab (by-tab mode).

**Signature:**

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

### IScheduledExportFiltersContextValue.filtersAreStale

> **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 saved filters alone no longer match the dashboard.

**Signature:**

```typescript
filtersAreStale: boolean;
```

### IScheduledExportFiltersContextValue.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; present with more than one tab.

**Signature:**

```typescript
filtersByTab: IAutomationFiltersTab[] | undefined;
```

### IScheduledExportFiltersContextValue.flatTabId

> **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).
> 

The tab the flat (non-tabbed) UI edits; undefined for multi-tab dashboards or when no parameter context applies.

**Signature:**

```typescript
flatTabId: string | undefined;
```

### IScheduledExportFiltersContextValue.onApplyCurrentFilters

> **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 the selection with the dashboard's current filters (the stale-filters repair).

**Signature:**

```typescript
onApplyCurrentFilters: () => void;
```

### IScheduledExportFiltersContextValue.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).
> 

By-tab counterpart of `onFiltersChange`: replaces the per-tab selection wholesale.

**Signature:**

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

### IScheduledExportFiltersContextValue.onFiltersChange

> **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 the selection with the complete updated array and mirrors it into the export definitions. `storeFiltersParam` overrides the current toggle value for this write.

**Signature:**

```typescript
onFiltersChange: (filters: FilterContextItem[], storeFiltersParam?: boolean) => void;
```

### IScheduledExportFiltersContextValue.onParameterAdd

> **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).
> 

Adds a workspace parameter with its default value on the flat tab.

**Signature:**

```typescript
onParameterAdd: (ref: IdentifierRef) => void;
```

### IScheduledExportFiltersContextValue.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).
> 

Adds a workspace parameter with its default value on the given tab.

**Signature:**

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

### IScheduledExportFiltersContextValue.onParameterChange

> **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).
> 

Sets a parameter's value on the flat tab.

**Signature:**

```typescript
onParameterChange: (ref: IdentifierRef, value: ParameterValue) => void;
```

### IScheduledExportFiltersContextValue.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).
> 

Sets a parameter's value on the given tab.

**Signature:**

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

### IScheduledExportFiltersContextValue.onParameterDelete

> **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).
> 

Removes a parameter override on the flat tab.

**Signature:**

```typescript
onParameterDelete: (ref: IdentifierRef) => void;
```

### IScheduledExportFiltersContextValue.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).
> 

Removes a parameter override on the given tab.

**Signature:**

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

### IScheduledExportFiltersContextValue.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, filters, undefined)`, by-tab mode as `(value, undefined, filtersByTab)`.

**Signature:**

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

### IScheduledExportFiltersContextValue.onStoreParametersChange

> **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).
> 

Re-encodes the parameters onto the automation with the new persistence value.

**Signature:**

```typescript
onStoreParametersChange: (storeParameters: boolean) => void;
```

### IScheduledExportFiltersContextValue.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 the export-parameters feature is on; the parameter members below are empty when off.

**Signature:**

```typescript
parametersEnabled: boolean;
```

### IScheduledExportFiltersContextValue.selectedFilters

> **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).
> 

The filters the schedule is saved with (flat mode).

**Signature:**

```typescript
selectedFilters: FilterContextItem[];
```

### IScheduledExportFiltersContextValue.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;
```

### IScheduledExportFiltersContextValue.visibleParametersByTab

> **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).
> 

Per-tab visible parameters to render as chips.

**Signature:**

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