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

# IAnalyticalDesignerConfig

- 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), [Customize Analytical Designer](https://www.gooddata.ai/docs/gooddata-ui/latest/analytical-designer/customize-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).
> 

Configuration of Analytical Designer.

**Signature:**

```typescript
export interface IAnalyticalDesignerConfig 
```

## Remarks

Analytical Designer reads the values that set up the runtime (locale, settings, organization, theme, telemetry and read-only mode) when it mounts. Changes to the route values (`sourceDashboard`, `sourceInsight`, the actions, the tags, the separators, `asOfDate`, `isEmbedded` and `allowDashboardLinks`) navigate Analytical Designer.

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [agGridToken?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigaggridtoken) |  | string | **_(ALPHA)_** _(Optional)_ AG Grid token for the pivot table. The default comes from the settings. |
| [allowDashboardLinks?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigallowdashboardlinks) |  | boolean | **_(ALPHA)_** _(Optional)_ Whether the drill-to-dashboard configuration can link dashboards. |
| [asOfDate?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigasofdate) |  | string | **_(ALPHA)_** _(Optional)_ Date that relative date filters are computed from, in the `YYYY-MM-DD` format. |
| [colorPalette?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigcolorpalette) |  | [IColorPalette](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icolorpalette/index.md) | **_(ALPHA)_** _(Optional)_ Color palette of the charts. Analytical Designer loads the palette of the workspace when it is not provided. |
| [displayedActions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigdisplayedactions) |  | Array<"cancel"> | **_(ALPHA)_** _(Optional)_ Header actions to show that are hidden by default. |
| [excludeObjectsWithTags?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigexcludeobjectswithtags) |  | string[] | **_(ALPHA)_** _(Optional)_ The catalog items with one of these tags are hidden. |
| [formatLocale?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigformatlocale) |  | string | **_(ALPHA)_** _(Optional)_ Locale that formats numbers and dates. The default comes from the settings. |
| [hiddenActions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfighiddenactions) |  | [AnalyticalDesignerHiddenAction](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.analyticaldesignerhiddenaction/index.md)[] | **_(ALPHA)_** _(Optional)_ Header actions to hide. |
| [includeObjectsWithTags?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigincludeobjectswithtags) |  | string[] | **_(ALPHA)_** _(Optional)_ Only the catalog items with one of these tags are shown. |
| [isEmbedded?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigisembedded) |  | boolean | **_(ALPHA)_** _(Optional)_ Marks Analytical Designer as opened from a dashboard. |
| [isReadOnly?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigisreadonly) |  | boolean | **_(ALPHA)_** _(Optional)_ Hides the actions that change the insight: save, save as and create new. |
| [locale?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfiglocale) |  | [ILocale](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ilocale/index.md) | **_(ALPHA)_** _(Optional)_ Locale of the user interface. The default is `en-US`. |
| [mapboxToken?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigmapboxtoken) |  | string | **_(ALPHA)_** _(Optional)_ Mapbox token for the geo charts. The default comes from the settings. |
| [organization?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigorganization) |  | { id?: string; title?: string; isAdmin?: boolean; expiredDate?: string; entitlements?: [IEntitlementDescriptor](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ientitlementdescriptor/index.md)[]; } | **_(ALPHA)_** _(Optional)_ The organization. Analytical Designer loads its `id` and `title` when `id` is not provided. The other values are stored in the bootstrap data for hosts that pass them; Analytical Designer itself reads none of them today (the trial dialog that did was removed). |
| [separators?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigseparators) |  | [ISeparators](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iseparators/index.md) | **_(ALPHA)_** _(Optional)_ Separators of thousands and decimals. The default comes from the settings. |
| [settings?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigsettings) |  | [IUserWorkspaceSettings](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuserworkspacesettings/index.md) \| [IUserSettings](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iusersettings/index.md) | **_(ALPHA)_** _(Optional)_ Settings and feature flags. Analytical Designer loads them from the backend when they are not provided. |
| [sourceDashboard?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigsourcedashboard) |  | string \| [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(ALPHA)_** _(Optional)_ Dashboard the edited insight comes from. Its presence, not its value, starts the edit-from-dashboard flow: the header offers going back to the dashboard. An empty string means the dashboard is not saved yet. |
| [sourceInsight?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigsourceinsight) |  | string \| [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | **_(ALPHA)_** _(Optional)_ Insight to open as an unsaved copy (the explore flow). Saving creates a new insight. |
| [telemetryCallbacks?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigtelemetrycallbacks) |  | [IAnalyticalDesignerTelemetryCallbacks](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignertelemetrycallbacks/index.md) | **_(ALPHA)_** _(Optional)_ Forwards the Analytical Designer telemetry into the host's pipeline. The default tracks nothing. |
| [user?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfiguser) |  | [IUser](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md) | **_(ALPHA)_** _(Optional)_ The current user. Analytical Designer loads it when it is not provided. |
| [whiteLabeling?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-analytical-designer/sdk-ui-analytical-designer.ianalyticaldesignerconfig/index.md#ianalyticaldesignerconfigwhitelabeling) |  | { logoUrl?: string; isBranded?: boolean; } | **_(ALPHA)_** _(Optional)_ White labeling of the Analytical Designer user interface. |

## Property details

### IAnalyticalDesignerConfig.agGridToken

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

AG Grid token for the pivot table. The default comes from the settings.

**Signature:**

```typescript
agGridToken?: string;
```

### IAnalyticalDesignerConfig.allowDashboardLinks

> **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 drill-to-dashboard configuration can link dashboards.

**Signature:**

```typescript
allowDashboardLinks?: boolean;
```

### IAnalyticalDesignerConfig.asOfDate

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

Date that relative date filters are computed from, in the `YYYY-MM-DD` format.

**Signature:**

```typescript
asOfDate?: string;
```

### IAnalyticalDesignerConfig.colorPalette

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

Color palette of the charts. Analytical Designer loads the palette of the workspace when it is not provided.

**Signature:**

```typescript
colorPalette?: IColorPalette;
```

### IAnalyticalDesignerConfig.displayedActions

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

Header actions to show that are hidden by default.

**Signature:**

```typescript
displayedActions?: Array<"cancel">;
```

### IAnalyticalDesignerConfig.excludeObjectsWithTags

> **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 items with one of these tags are hidden.

**Signature:**

```typescript
excludeObjectsWithTags?: string[];
```

### IAnalyticalDesignerConfig.formatLocale

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

Locale that formats numbers and dates. The default comes from the settings.

**Signature:**

```typescript
formatLocale?: string;
```

### IAnalyticalDesignerConfig.hiddenActions

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

Header actions to hide.

**Signature:**

```typescript
hiddenActions?: AnalyticalDesignerHiddenAction[];
```

### IAnalyticalDesignerConfig.includeObjectsWithTags

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

Only the catalog items with one of these tags are shown.

**Signature:**

```typescript
includeObjectsWithTags?: string[];
```

### IAnalyticalDesignerConfig.isEmbedded

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

Marks Analytical Designer as opened from a dashboard.

**Signature:**

```typescript
isEmbedded?: boolean;
```

### IAnalyticalDesignerConfig.isReadOnly

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

Hides the actions that change the insight: save, save as and create new.

**Signature:**

```typescript
isReadOnly?: boolean;
```

### IAnalyticalDesignerConfig.locale

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

Locale of the user interface. The default is `en-US`.

**Signature:**

```typescript
locale?: ILocale;
```

### IAnalyticalDesignerConfig.mapboxToken

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

Mapbox token for the geo charts. The default comes from the settings.

**Signature:**

```typescript
mapboxToken?: string;
```

### IAnalyticalDesignerConfig.organization

> **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 organization. Analytical Designer loads its `id` and `title` when `id` is not provided. The other values are stored in the bootstrap data for hosts that pass them; Analytical Designer itself reads none of them today (the trial dialog that did was removed).

**Signature:**

```typescript
organization?: {
        id?: string;
        title?: string;
        isAdmin?: boolean;
        expiredDate?: string;
        entitlements?: IEntitlementDescriptor[];
    };
```

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

Separators of thousands and decimals. The default comes from the settings.

**Signature:**

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

### IAnalyticalDesignerConfig.settings

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

Settings and feature flags. Analytical Designer loads them from the backend when they are not provided.

**Signature:**

```typescript
settings?: IUserWorkspaceSettings | IUserSettings;
```

### IAnalyticalDesignerConfig.sourceDashboard

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

Dashboard the edited insight comes from. Its presence, not its value, starts the edit-from-dashboard flow: the header offers going back to the dashboard. An empty string means the dashboard is not saved yet.

**Signature:**

```typescript
sourceDashboard?: string | ObjRef;
```

### IAnalyticalDesignerConfig.sourceInsight

> **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 as an unsaved copy (the explore flow). Saving creates a new insight.

**Signature:**

```typescript
sourceInsight?: string | ObjRef;
```

### IAnalyticalDesignerConfig.telemetryCallbacks

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

Forwards the Analytical Designer telemetry into the host's pipeline. The default tracks nothing.

**Signature:**

```typescript
telemetryCallbacks?: IAnalyticalDesignerTelemetryCallbacks;
```

### IAnalyticalDesignerConfig.user

> **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 current user. Analytical Designer loads it when it is not provided.

**Signature:**

```typescript
user?: IUser;
```

### IAnalyticalDesignerConfig.whiteLabeling

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

White labeling of the Analytical Designer user interface.

**Signature:**

```typescript
whiteLabeling?: {
        logoUrl?: string;
        isBranded?: boolean;
    };
```