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

# IAnalyticalDesignerProps

- 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: [AnalyticalDesigner component](https://www.gooddata.ai/docs/gooddata-ui/latest/analytical-designer/analytical-designer/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).
> 

Props of the Analytical Designer component.

**Signature:**

```typescript
export interface IAnalyticalDesignerProps 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [apiRef?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropsapiref) |  | Ref<[IAnalyticalDesignerApi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerapi/index.md)> | **_(ALPHA)_** _(Optional)_ Receives the commands the host sends to Analytical Designer. |
| [backend?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropsbackend) |  | [IAnalyticalBackend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalbackend/index.md) | **_(ALPHA)_** _(Optional)_ Backend to work with. The default comes from the `BackendProvider`. It is read at mount: to switch the backend, remount the component with a new `key`. |
| [cacheReset?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropscachereset) |  | [IAnalyticalDesignerCacheReset](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignercachereset/index.md) | **_(ALPHA)_** _(Optional)_ Resets the caches of the backend when Analytical Designer needs fresh data, for example when the user refreshes the catalog. Pass it when the backend caches; the latest value is used. |
| [config?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropsconfig) |  | [IAnalyticalDesignerConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md) | **_(ALPHA)_** _(Optional)_ Configuration of Analytical Designer. |
| [disableThemeLoading?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropsdisablethemeloading) |  | boolean | **_(ALPHA)_** _(Optional)_ Skips loading the theme of the workspace. |
| [insight?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropsinsight) |  | string \| [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) \| [IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md) | **_(ALPHA)_** _(Optional)_ Insight to open: an identifier, a reference or the insight. Undefined opens a new insight. |
| [onError?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropsonerror) |  | (error: unknown) => void | **_(ALPHA)_** _(Optional)_ Called when Analytical Designer cannot start. |
| [onEvent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropsonevent) |  | (event: [AnalyticalDesignerEvent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.analyticaldesignerevent/index.md)) => void | **_(ALPHA)_** _(Optional)_ Called with every event Analytical Designer emits. Check `event.type` to narrow `event.data`. |
| [permissions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropspermissions) |  | [IWorkspacePermissions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspacepermissions/index.md) | **_(ALPHA)_** _(Optional)_ Permissions of the current user in the workspace. Analytical Designer loads them when they are not provided. |
| [slots?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropsslots) |  | [IAnalyticalDesignerSlots](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerslots/index.md) | **_(ALPHA)_** _(Optional)_ Regions of Analytical Designer that the host replaces or wraps. |
| [theme?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropstheme) |  | [ITheme](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md) | **_(ALPHA)_** _(Optional)_ Theme to apply. Analytical Designer loads the theme of the workspace when it is not provided. |
| [themeModifier?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropsthememodifier) |  | (theme: [ITheme](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md)) => [ITheme](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md) | **_(ALPHA)_** _(Optional)_ Changes the theme before Analytical Designer applies it. |
| [workspace?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerprops/index.md#ianalyticaldesignerpropsworkspace) |  | string | **_(ALPHA)_** _(Optional)_ Workspace to work in. The default comes from the `WorkspaceProvider`. It is read at mount: to switch the workspace, remount the component with a new `key`. |

## Property details

### IAnalyticalDesignerProps.apiRef

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

Receives the commands the host sends to Analytical Designer.

**Signature:**

```typescript
apiRef?: Ref<IAnalyticalDesignerApi>;
```

### IAnalyticalDesignerProps.backend

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

Backend to work with. The default comes from the `BackendProvider`. It is read at mount: to switch the backend, remount the component with a new `key`.

**Signature:**

```typescript
backend?: IAnalyticalBackend;
```

### IAnalyticalDesignerProps.cacheReset

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

Resets the caches of the backend when Analytical Designer needs fresh data, for example when the user refreshes the catalog. Pass it when the backend caches; the latest value is used.

**Signature:**

```typescript
cacheReset?: IAnalyticalDesignerCacheReset;
```

### IAnalyticalDesignerProps.config

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

Configuration of Analytical Designer.

**Signature:**

```typescript
config?: IAnalyticalDesignerConfig;
```

### IAnalyticalDesignerProps.disableThemeLoading

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

Skips loading the theme of the workspace.

**Signature:**

```typescript
disableThemeLoading?: boolean;
```

### IAnalyticalDesignerProps.insight

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

Insight to open: an identifier, a reference or the insight. Undefined opens a new insight.

**Signature:**

```typescript
insight?: string | ObjRef | IInsight;
```

### IAnalyticalDesignerProps.onError

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

Called when Analytical Designer cannot start.

**Signature:**

```typescript
onError?: (error: unknown) => void;
```

### IAnalyticalDesignerProps.onEvent

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

Called with every event Analytical Designer emits. Check `event.type` to narrow `event.data`.

**Signature:**

```typescript
onEvent?: (event: AnalyticalDesignerEvent) => void;
```

### IAnalyticalDesignerProps.permissions

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

Permissions of the current user in the workspace. Analytical Designer loads them when they are not provided.

**Signature:**

```typescript
permissions?: IWorkspacePermissions;
```

### IAnalyticalDesignerProps.slots

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

Regions of Analytical Designer that the host replaces or wraps.

**Signature:**

```typescript
slots?: IAnalyticalDesignerSlots;
```

### IAnalyticalDesignerProps.theme

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

Theme to apply. Analytical Designer loads the theme of the workspace when it is not provided.

**Signature:**

```typescript
theme?: ITheme;
```

### IAnalyticalDesignerProps.themeModifier

> **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 theme before Analytical Designer applies it.

**Signature:**

```typescript
themeModifier?: (theme: ITheme) => ITheme;
```

### IAnalyticalDesignerProps.workspace

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

Workspace to work in. The default comes from the `WorkspaceProvider`. It is read at mount: to switch the workspace, remount the component with a new `key`.

**Signature:**

```typescript
workspace?: string;
```