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

# IAddTextAttributeFilterPayload

- 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/model/commands/filters.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).
> 

Payload of the [IAddTextAttributeFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iaddtextattributefilter/index.md) command.

**Signature:**

```typescript
export interface IAddTextAttributeFilterPayload 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [filter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iaddtextattributefilterpayload/index.md#iaddtextattributefilterpayloadfilter) | `readonly` | [DashboardTextAttributeFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.dashboardtextattributefilter/index.md) | **_(BETA)_** The text attribute filter to add (arbitrary or match). |
| [index](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iaddtextattributefilterpayload/index.md#iaddtextattributefilterpayloadindex) | `readonly` | number | **_(BETA)_** Index among the attribute filters at which the new filter should be placed. Index of -1 adds the filter at the end. |
| [mode?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iaddtextattributefilterpayload/index.md#iaddtextattributefilterpayloadmode) | `readonly` | [DashboardAttributeFilterConfigMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.dashboardattributefilterconfigmode/index.md) | **_(BETA)_** _(Optional)_ Specify the visibility mode of the attribute filter. |

## Property details

### IAddTextAttributeFilterPayload.filter

> **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 text attribute filter to add (arbitrary or match).

**Signature:**

```typescript
readonly filter: DashboardTextAttributeFilter;
```

### IAddTextAttributeFilterPayload.index

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

Index among the attribute filters at which the new filter should be placed. Index of -1 adds the filter at the end.

**Signature:**

```typescript
readonly index: number;
```

### IAddTextAttributeFilterPayload.mode

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

Specify the visibility mode of the attribute filter.

**Signature:**

```typescript
readonly mode?: DashboardAttributeFilterConfigMode;
```