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

# IAnalyticalDesignerEmbedProps

- 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 control that embeds the visualization.

**Signature:**

```typescript
export interface IAnalyticalDesignerEmbedProps 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 |
| --- | --- | --- | --- |
| [documentationLabel](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerembedprops/index.md#ianalyticaldesignerembedpropsdocumentationlabel) |  | string | **_(ALPHA)_** Label of the choice that opens the documentation about embedding Analytical Designer. |
| [documentationUrl](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerembedprops/index.md#ianalyticaldesignerembedpropsdocumentationurl) |  | string | **_(ALPHA)_** Address of the documentation about embedding Analytical Designer. |
| [embedInsightDisabledReason?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerembedprops/index.md#ianalyticaldesignerembedpropsembedinsightdisabledreason) |  | string | **_(ALPHA)_** _(Optional)_ Why the visualization cannot be embedded. |
| [embedInsightLabel](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerembedprops/index.md#ianalyticaldesignerembedpropsembedinsightlabel) |  | string | **_(ALPHA)_** Label of the choice that shows the code embedding the visualization. |
| [isEmbedInsightDisabled](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerembedprops/index.md#ianalyticaldesignerembedpropsisembedinsightdisabled) |  | boolean | **_(ALPHA)_** Whether the visualization cannot be embedded, because it is empty. |
| [label](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerembedprops/index.md#ianalyticaldesignerembedpropslabel) |  | string | **_(ALPHA)_** Accessible name of the control. |
| [onEmbedInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerembedprops/index.md#ianalyticaldesignerembedpropsonembedinsight) |  | () =&gt; void | **_(ALPHA)_** Opens the dialog with the code embedding the visualization. Ignored when it cannot be embedded. |

## Property details

### IAnalyticalDesignerEmbedProps.documentationLabel

> **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 choice that opens the documentation about embedding Analytical Designer.

**Signature:**

```typescript
documentationLabel: string;
```

### IAnalyticalDesignerEmbedProps.documentationUrl

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

Address of the documentation about embedding Analytical Designer.

**Signature:**

```typescript
documentationUrl: string;
```

### IAnalyticalDesignerEmbedProps.embedInsightDisabledReason

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

Why the visualization cannot be embedded.

**Signature:**

```typescript
embedInsightDisabledReason?: string;
```

### IAnalyticalDesignerEmbedProps.embedInsightLabel

> **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 choice that shows the code embedding the visualization.

**Signature:**

```typescript
embedInsightLabel: string;
```

### IAnalyticalDesignerEmbedProps.isEmbedInsightDisabled

> **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 visualization cannot be embedded, because it is empty.

**Signature:**

```typescript
isEmbedInsightDisabled: boolean;
```

### IAnalyticalDesignerEmbedProps.label

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

Accessible name of the control.

**Signature:**

```typescript
label: string;
```

### IAnalyticalDesignerEmbedProps.onEmbedInsight

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

Opens the dialog with the code embedding the visualization. Ignored when it cannot be embedded.

**Signature:**

```typescript
onEmbedInsight: () => void;
```
