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

# IAnalyticalDesignerApi

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

Commands a host sends to Analytical Designer.

**Signature:**

```typescript
export interface IAnalyticalDesignerApi 
```

## Methods

| Method | Description |
| --- | --- |
| [clear()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerapi/index.md#ianalyticaldesignerapiclear) | **_(ALPHA)_** Clears the insight. |
| [requestCancellation()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerapi/index.md#ianalyticaldesignerapirequestcancellation) | **_(ALPHA)_** Asks Analytical Designer to cancel the editing. Analytical Designer confirms unsaved changes first. |
| [sendCommand(command)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerapi/index.md#ianalyticaldesignerapisendcommand) | **_(ALPHA)_** Sends any command of the `@gooddata/sdk-embedding` contract. |
| [setFilterContext(data, contextId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerapi/index.md#ianalyticaldesignerapisetfiltercontext) | **_(ALPHA)_** Merges a dashboard filter context into the filters of the open insight. |

## Method details

### IAnalyticalDesignerApi.clear()

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

Clears the insight.

**Signature:**

```typescript
clear(): void;
```
**Returns:**

void

### IAnalyticalDesignerApi.requestCancellation()

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

Asks Analytical Designer to cancel the editing. Analytical Designer confirms unsaved changes first.

**Signature:**

```typescript
requestCancellation(): void;
```
**Returns:**

void

### IAnalyticalDesignerApi.sendCommand()

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

Sends any command of the `@gooddata/sdk-embedding` contract.

**Signature:**

```typescript
sendCommand(command: AdCommandData): void;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| command | AdCommandData |  |

**Returns:**

void

### IAnalyticalDesignerApi.setFilterContext()

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

Merges a dashboard filter context into the filters of the open insight.

**Signature:**

```typescript
setFilterContext(data: IFilterContextContent, contextId?: string): void;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| data | IFilterContextContent |  |
| contextId | string | _(Optional)_ |

**Returns:**

void