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

# v1.DashboardTextFilter1

- Package: [@gooddata/sdk-code-schemas](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-code-schemas/src/v1/metadata.ts

A dashboard text filter

**Signature:**

```typescript
export interface DashboardTextFilter1 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [case\_sensitive?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1case_sensitive) |  | boolean | _(Optional)_ |
| [condition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1condition) |  | "is" \| "isNot" |  |
| [display\_as?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1display_as) |  | [DisplayAsLabelIdentifier2](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.displayaslabelidentifier2/index.md) | _(Optional)_ |
| [metric\_filters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1metric_filters) |  | string[] | _(Optional)_ An id of the attributes, labels, facts or metrics to validate the filter by |
| [mode?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1mode) |  | "readonly" \| "hidden" \| "active" | _(Optional)_ Setting filter mode to readonly will disable the filter. Setting it to hidden will hide the filter from the dashboard. Setting it to active will enable the filter. |
| [parents?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1parents) |  | ([LocalAttributeFilter2](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.localattributefilter2/index.md) \| [LocalDateFilter2](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.localdatefilter2/index.md))[] | _(Optional)_ An ids of the parent local attribute, text, or date filter |
| [selection\_type?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1selection_type) |  | "list" \| "text" \| "listOrText" | _(Optional)_ Controls which filter presentation types are available to the user in View mode. 'list' means only elements/list selection, 'text' means only text-based filtering, 'listOrText' means both types are available. |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1title) |  | string | _(Optional)_ Optional title of the filter |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1type) |  | "text\_filter" |  |
| [using](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1using) |  | [AttributeIdentifier4](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attributeidentifier4/index.md) \| [LabelIdentifier4](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.labelidentifier4/index.md) \| [ComputedAttributeIdentifier4](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.computedattributeidentifier4/index.md) | Attribute or label to use in this filter. |
| [values](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.dashboardtextfilter1/index.md#v1dashboardtextfilter1values) |  | (string \| null)[] |  |

## Property details

### v1.DashboardTextFilter1.case_sensitive

**Signature:**

```typescript
case_sensitive?: boolean;
```

### v1.DashboardTextFilter1.condition

**Signature:**

```typescript
condition: "is" | "isNot";
```

### v1.DashboardTextFilter1.display_as

**Signature:**

```typescript
display_as?: DisplayAsLabelIdentifier2;
```

### v1.DashboardTextFilter1.metric_filters

An id of the attributes, labels, facts or metrics to validate the filter by

**Signature:**

```typescript
metric_filters?: string[];
```

### v1.DashboardTextFilter1.mode

Setting filter mode to readonly will disable the filter. Setting it to hidden will hide the filter from the dashboard. Setting it to active will enable the filter.

**Signature:**

```typescript
mode?: "readonly" | "hidden" | "active";
```

### v1.DashboardTextFilter1.parents

An ids of the parent local attribute, text, or date filter

**Signature:**

```typescript
parents?: (LocalAttributeFilter2 | LocalDateFilter2)[];
```

### v1.DashboardTextFilter1.selection_type

Controls which filter presentation types are available to the user in View mode. 'list' means only elements/list selection, 'text' means only text-based filtering, 'listOrText' means both types are available.

**Signature:**

```typescript
selection_type?: "list" | "text" | "listOrText";
```

### v1.DashboardTextFilter1.title

Optional title of the filter

**Signature:**

```typescript
title?: string;
```

### v1.DashboardTextFilter1.type

**Signature:**

```typescript
type: "text_filter";
```

### v1.DashboardTextFilter1.using

Attribute or label to use in this filter.

**Signature:**

```typescript
using: AttributeIdentifier4 | LabelIdentifier4 | ComputedAttributeIdentifier4;
```

### v1.DashboardTextFilter1.values

**Signature:**

```typescript
values: (string | null)[];
```
