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

# IAnalyticalDesignerEventDataMap

- 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.65/libs/sdk-ui-analytical-designer/src/embedding/analyticalDesignerTypes.ts
- Guides: [Handle Analytical Designer events](https://www.gooddata.ai/docs/gooddata-ui/latest/analytical-designer/handle-analytical-designer-events/index.md)

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

Payload of each event Analytical Designer emits, by the type of the event.

**Signature:**

```typescript
export interface IAnalyticalDesignerEventDataMap 
```

## Remarks

The types are the names of the `@gooddata/sdk-embedding` contract of the embedded Analytical Designer, for example `GdcAdEventType.InsightSaved` is `visualizationSaved`.

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [apiTokenIsAboutToExpire](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapapitokenisabouttoexpire) |  | Record<string, never> | **_(ALPHA)_** The API token of Analytical Designer expires soon. |
| [appCommandFailed](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapappcommandfailed) |  | ICommandFailedBody | **_(ALPHA)_** A command the host sent failed. |
| [attributeHierarchyModified](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapattributehierarchymodified) |  | IAdAvailableCommands | **_(ALPHA)_** The user created, changed or deleted an attribute hierarchy. |
| [availableCommands](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapavailablecommands) |  | GdcAdCommandType[] | **_(ALPHA)_** The commands Analytical Designer accepts changed. |
| [catalogLoaded](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapcatalogloaded) |  | AdCatalogLoadedBody | **_(ALPHA)_** The catalog loaded. |
| [clearFinished](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapclearfinished) |  | IAdAvailableCommands | **_(ALPHA)_** A `clear` command finished. |
| [clearInsightFinished](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapclearinsightfinished) |  | IAdAvailableCommands | **_(ALPHA)_** A `clearInsight` command finished. |
| [drill](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapdrill) |  | [IDrillEvent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idrillevent/index.md) | **_(ALPHA)_** The user drilled in the insight. |
| [exportInsightFinished](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapexportinsightfinished) |  | AdExportFinishedBody | **_(ALPHA)_** An `exportInsight` command finished, with the link to the exported file. |
| [filterContextChanged](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapfiltercontextchanged) |  | AdFilterContextChangedBody | **_(ALPHA)_** The user changed a filter of the insight. |
| [insightChanged](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapinsightchanged) |  | AdInsightChangedBody | **_(ALPHA)_** The insight definition changed and its execution started. |
| [insightEditingCancelled](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapinsighteditingcancelled) |  | null | **_(ALPHA)_** The user cancelled the editing. |
| [insightOpened](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapinsightopened) |  | [IAnalyticalDesignerInsightOpenedData](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerinsightopeneddata/index.md) | **_(ALPHA)_** Analytical Designer opened an insight. |
| [insightRendered](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapinsightrendered) |  | AdInsightRenderedBody | **_(ALPHA)_** The insight rendered. |
| [listeningForDrillableItems](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamaplisteningfordrillableitems) |  | Record<string, never> | **_(ALPHA)_** Analytical Designer accepts the `drillableItems` command. |
| [metricsChanged](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapmetricschanged) |  | Record<string, never> | **_(ALPHA)_** The user saved or deleted a metric. A host that shares a caching backend with Analytical Designer resets its caches here. |
| [redoFinished](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapredofinished) |  | IAdAvailableCommands | **_(ALPHA)_** A `redo` command finished. |
| [removeFilterContextFinished](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapremovefiltercontextfinished) |  | IAdAvailableCommands | **_(ALPHA)_** A `removeFilterContext` command finished. |
| [setFilterContextFinished](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapsetfiltercontextfinished) |  | IAdAvailableCommands | **_(ALPHA)_** A `setFilterContext` command finished. |
| [undoFinished](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapundofinished) |  | IAdAvailableCommands | **_(ALPHA)_** An `undo` command finished. |
| [visualizationSaved](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignereventdatamap/index.md#ianalyticaldesignereventdatamapvisualizationsaved) |  | AdInsightSavedBody | **_(ALPHA)_** The user or a `save` command saved the insight. |

## Property details

### IAnalyticalDesignerEventDataMap.apiTokenIsAboutToExpire

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

The API token of Analytical Designer expires soon.

**Signature:**

```typescript
apiTokenIsAboutToExpire: Record<string, never>;
```

### IAnalyticalDesignerEventDataMap.appCommandFailed

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

A command the host sent failed.

**Signature:**

```typescript
appCommandFailed: ICommandFailedBody;
```

### IAnalyticalDesignerEventDataMap.attributeHierarchyModified

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

The user created, changed or deleted an attribute hierarchy.

**Signature:**

```typescript
attributeHierarchyModified: IAdAvailableCommands;
```

### IAnalyticalDesignerEventDataMap.availableCommands

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

The commands Analytical Designer accepts changed.

**Signature:**

```typescript
availableCommands: GdcAdCommandType[];
```

### IAnalyticalDesignerEventDataMap.catalogLoaded

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

The catalog loaded.

**Signature:**

```typescript
catalogLoaded: AdCatalogLoadedBody;
```

### IAnalyticalDesignerEventDataMap.clearFinished

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

A `clear` command finished.

**Signature:**

```typescript
clearFinished: IAdAvailableCommands;
```

### IAnalyticalDesignerEventDataMap.clearInsightFinished

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

A `clearInsight` command finished.

**Signature:**

```typescript
clearInsightFinished: IAdAvailableCommands;
```

### IAnalyticalDesignerEventDataMap.drill

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

The user drilled in the insight.

**Signature:**

```typescript
drill: IDrillEvent;
```

### IAnalyticalDesignerEventDataMap.exportInsightFinished

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

An `exportInsight` command finished, with the link to the exported file.

**Signature:**

```typescript
exportInsightFinished: AdExportFinishedBody;
```

### IAnalyticalDesignerEventDataMap.filterContextChanged

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

The user changed a filter of the insight.

**Signature:**

```typescript
filterContextChanged: AdFilterContextChangedBody;
```

### IAnalyticalDesignerEventDataMap.insightChanged

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

The insight definition changed and its execution started.

**Signature:**

```typescript
insightChanged: AdInsightChangedBody;
```

### IAnalyticalDesignerEventDataMap.insightEditingCancelled

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

The user cancelled the editing.

**Signature:**

```typescript
insightEditingCancelled: null;
```

### IAnalyticalDesignerEventDataMap.insightOpened

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

Analytical Designer opened an insight.

**Signature:**

```typescript
insightOpened: IAnalyticalDesignerInsightOpenedData;
```

### IAnalyticalDesignerEventDataMap.insightRendered

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

The insight rendered.

**Signature:**

```typescript
insightRendered: AdInsightRenderedBody;
```

### IAnalyticalDesignerEventDataMap.listeningForDrillableItems

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

Analytical Designer accepts the `drillableItems` command.

**Signature:**

```typescript
listeningForDrillableItems: Record<string, never>;
```

### IAnalyticalDesignerEventDataMap.metricsChanged

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

The user saved or deleted a metric. A host that shares a caching backend with Analytical Designer resets its caches here.

**Signature:**

```typescript
metricsChanged: Record<string, never>;
```

### IAnalyticalDesignerEventDataMap.redoFinished

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

A `redo` command finished.

**Signature:**

```typescript
redoFinished: IAdAvailableCommands;
```

### IAnalyticalDesignerEventDataMap.removeFilterContextFinished

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

A `removeFilterContext` command finished.

**Signature:**

```typescript
removeFilterContextFinished: IAdAvailableCommands;
```

### IAnalyticalDesignerEventDataMap.setFilterContextFinished

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

A `setFilterContext` command finished.

**Signature:**

```typescript
setFilterContextFinished: IAdAvailableCommands;
```

### IAnalyticalDesignerEventDataMap.undoFinished

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

An `undo` command finished.

**Signature:**

```typescript
undoFinished: IAdAvailableCommands;
```

### IAnalyticalDesignerEventDataMap.visualizationSaved

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

The user or a `save` command saved the insight.

**Signature:**

```typescript
visualizationSaved: AdInsightSavedBody;
```