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

# IAnalyticalDesignerVisualizationDescriptionProps

- Package: [@gooddata/sdk-ui-analytical-designer](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.68/libs/sdk-ui-analytical-designer/src/embedding/editorHeaderSlotTypes.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Props of the visualization description.

**Signature:**

```typescript
export interface IAnalyticalDesignerVisualizationDescriptionProps extends IAnalyticalDesignerHeaderContext 
```
**Extends:** [IAnalyticalDesignerHeaderContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerheadercontext/index.md)

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [addLabel](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignervisualizationdescriptionprops/index.md#ianalyticaldesignervisualizationdescriptionpropsaddlabel) |  | string | **_(ALPHA)_** Label of the action that adds a description. |
| [description](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignervisualizationdescriptionprops/index.md#ianalyticaldesignervisualizationdescriptionpropsdescription) |  | string | **_(ALPHA)_** Current description of the visualization. Empty when it has none. |
| [filters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignervisualizationdescriptionprops/index.md#ianalyticaldesignervisualizationdescriptionpropsfilters) |  | [IFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifilter/index.md)[] | **_(ALPHA)_** Filters of the visualization, which references in the rich text description resolve against. |
| [isEditable](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignervisualizationdescriptionprops/index.md#ianalyticaldesignervisualizationdescriptionpropsiseditable) |  | boolean | **_(ALPHA)_** Whether the description can be changed. |
| [onDescriptionChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignervisualizationdescriptionprops/index.md#ianalyticaldesignervisualizationdescriptionpropsondescriptionchange) |  | (description: string) =&gt; void | **_(ALPHA)_** Changes the description. Ignored when the description cannot be changed. |
| [placeholder](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignervisualizationdescriptionprops/index.md#ianalyticaldesignervisualizationdescriptionpropsplaceholder) |  | string | **_(ALPHA)_** Text shown in the empty description editor. |
| [separators?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignervisualizationdescriptionprops/index.md#ianalyticaldesignervisualizationdescriptionpropsseparators) |  | [ISeparators](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iseparators/index.md) | **_(ALPHA)_** _(Optional)_ Number separators for the references in the description. |

## Property details

### IAnalyticalDesignerVisualizationDescriptionProps.addLabel

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Label of the action that adds a description.

**Signature:**

```typescript
addLabel: string;
```

### IAnalyticalDesignerVisualizationDescriptionProps.description

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Current description of the visualization. Empty when it has none.

**Signature:**

```typescript
description: string;
```

### IAnalyticalDesignerVisualizationDescriptionProps.filters

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Filters of the visualization, which references in the rich text description resolve against.

**Signature:**

```typescript
filters: IFilter[];
```

### IAnalyticalDesignerVisualizationDescriptionProps.isEditable

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Whether the description can be changed.

**Signature:**

```typescript
isEditable: boolean;
```

### IAnalyticalDesignerVisualizationDescriptionProps.onDescriptionChange

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Changes the description. Ignored when the description cannot be changed.

**Signature:**

```typescript
onDescriptionChange: (description: string) => void;
```

### IAnalyticalDesignerVisualizationDescriptionProps.placeholder

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Text shown in the empty description editor.

**Signature:**

```typescript
placeholder: string;
```

### IAnalyticalDesignerVisualizationDescriptionProps.separators

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Number separators for the references in the description.

**Signature:**

```typescript
separators?: ISeparators;
```
