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

# IWorkspaceSettingsService

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/settings/index.ts

This service provides access to settings for a particular workspace.

**Signature:**

```typescript
export interface IWorkspaceSettingsService 
```

## Methods

| Method | Description |
| --- | --- |
| [deleteAiRateLimit()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicedeleteairatelimit) | **_(ALPHA)_** Deletes AI rate limit override for the current workspace, reverting to the organization/platform default. |
| [deleteColorPalette()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicedeletecolorpalette) | Deletes color palette from workspace settings returning chart colors to default. |
| [deleteDashboardFiltersApplyMode()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicedeletedashboardfiltersapplymode) | **_(ALPHA)_** Clears DashboardFiltersApplyMode configuration for workspace so default value from organization is used. |
| [deleteDefaultExportTemplate()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicedeletedefaultexporttemplate) | **_(BETA)_** Clears the default export template configuration for workspace so the value inherited from the organization (or the built-in default) is used. |
| [deleteEnableDrillToUrlByDefault()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicedeleteenabledrilltourlbydefault) | **_(ALPHA)_** Clears enable drill to URL by default configuration for workspace so default value from organization is used. |
| [deleteExportCsvCustomDelimiter()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicedeleteexportcsvcustomdelimiter) | **_(ALPHA)_** Clears workspace CSV delimiter configuration so default value from organization is used. |
| [deleteMetricFormatOverride()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicedeletemetricformatoverride) | Deletes metric format override from workspace settings, returning to inherited organization-level format. |
| [deleteTheme()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicedeletetheme) | Deletes theme from workspace settings returning workspace styling to default. |
| [getAiRateLimit()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicegetairatelimit) | **_(ALPHA)_** Returns the AI rate limit value owned by the workspace (without resolving inherited defaults). Returns `undefined` when the workspace has no override. |
| [getEnableDrillToUrlByDefault()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicegetenabledrilltourlbydefault) | **_(ALPHA)_** Gets enable drill to URL by default setting value for workspace. |
| [getExportCsvCustomDelimiter()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicegetexportcsvcustomdelimiter) | **_(ALPHA)_** Gets CSV delimiter setting value for workspace. |
| [getSettings()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicegetsettings) | Returns effective workspace settings with all inherited values resolved. |
| [getSettingsForCurrentUser()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicegetsettingsforcurrentuser) | Asynchronously queries feature flags taking into account settings from both the workspace and the current user. |
| [setActiveCalendars(calendars)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetactivecalendars) | Sets active calendars configuration for current workspace. |
| [setActiveLlmEndpoint(endpoint)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetactivellmendpoint) | Set active LLM endpoint for the organization. |
| [setActiveLlmProvider(provider, defaultModelId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetactivellmprovider) | Set active LLM provider for the organization. |
| [setAiRateLimit(value)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetairatelimit) | **_(ALPHA)_** Sets AI rate limit override for the current workspace. |
| [setAlertDefault(value)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetalertdefault) | Sets alert default |
| [setColorPalette(colorPaletteId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetcolorpalette) | Sets color palette for current workspace. |
| [setDashboardFiltersApplyMode(dashboardFiltersApplyMode)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetdashboardfiltersapplymode) | **_(ALPHA)_** Sets DashboardFiltersApplyMode configuration for workspace. Default is taken from organization setting. |
| [setDateFormat(dateFormat)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetdateformat) | Sets date format for current workspace. |
| [setDefaultExportTemplate(value)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetdefaultexporttemplate) | **_(BETA)_** Sets the default export template applied to slide exports in this workspace when none is explicitly requested. Default is taken from organization setting. |
| [setEnableAiOnData(enabled)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetenableaiondata) | **_(ALPHA)_** Sets enable AI on data setting for current workspace. |
| [setEnableDrillToUrlByDefault(enabled)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetenabledrilltourlbydefault) | **_(ALPHA)_** Sets enable drill to URL by default setting for workspace. Default is taken from organization setting. |
| [setEnableNullJoins(enabled)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetenablenulljoins) | **_(ALPHA)_** Sets enable null joins setting for workspace. Default is taken from organization setting. |
| [setEnablePartialDataResults(enabled)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetenablepartialdataresults) | **_(ALPHA)_** Sets enable partial data results setting for workspace. Default is taken from organization setting. |
| [setEnableQueryTags(enabled)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetenablequerytags) | **_(ALPHA)_** Sets enable query tags setting for workspace. Default is taken from organization setting. |
| [setEnableTimezoneChange(enabled)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetenabletimezonechange) | **_(ALPHA)_** Sets whether end users may change the timezone in Analytical Designer and, by default, on dashboards. |
| [setExportCsvCustomDelimiter(delimiter)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetexportcsvcustomdelimiter) | **_(ALPHA)_** Sets default CSV delimiter for exports in workspace. Default is taken from organization setting. |
| [setFiscalCalendar(fiscalYear)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetfiscalcalendar) | Sets fiscal calendar for current workspace. |
| [setFormatLocale(locale)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetformatlocale) | Sets format locale for current workspace. |
| [setLocale(locale)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetlocale) | Sets locale for current workspace. |
| [setMetadataLocale(locale)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetmetadatalocale) | Sets metadata locale for current workspace. |
| [setMetricFormatOverride(override)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetmetricformatoverride) | Sets metric format override for the current workspace. |
| [setSeparators(separators)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetseparators) | Set separators for the current workspace |
| [setTheme(themeId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesettheme) | Sets theme for current workspace. |
| [setTimezone(timezone)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesettimezone) | Sets timezone for current workspace. |
| [setWeekStart(weekStart)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md#iworkspacesettingsservicesetweekstart) | Sets first day of week for current workspace. |

## Method details

### IWorkspaceSettingsService.deleteAiRateLimit()

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

Deletes AI rate limit override for the current workspace, reverting to the organization/platform default.

**Signature:**

```typescript
deleteAiRateLimit(): Promise<void>;
```
**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.deleteColorPalette()

Deletes color palette from workspace settings returning chart colors to default.

**Signature:**

```typescript
deleteColorPalette(): Promise<void>;
```
**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.deleteDashboardFiltersApplyMode()

> **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 DashboardFiltersApplyMode configuration for workspace so default value from organization is used.

**Signature:**

```typescript
deleteDashboardFiltersApplyMode(): Promise<void>;
```
**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.deleteDefaultExportTemplate()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Clears the default export template configuration for workspace so the value inherited from the organization (or the built-in default) is used.

**Signature:**

```typescript
deleteDefaultExportTemplate(): Promise<void>;
```
**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.deleteEnableDrillToUrlByDefault()

> **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 enable drill to URL by default configuration for workspace so default value from organization is used.

**Signature:**

```typescript
deleteEnableDrillToUrlByDefault(): Promise<void>;
```
**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.deleteExportCsvCustomDelimiter()

> **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 workspace CSV delimiter configuration so default value from organization is used.

**Signature:**

```typescript
deleteExportCsvCustomDelimiter(): Promise<void>;
```
**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.deleteMetricFormatOverride()

Deletes metric format override from workspace settings, returning to inherited organization-level format.

**Signature:**

```typescript
deleteMetricFormatOverride(): Promise<void>;
```
**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.deleteTheme()

Deletes theme from workspace settings returning workspace styling to default.

**Signature:**

```typescript
deleteTheme(): Promise<void>;
```
**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.getAiRateLimit()

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

Returns the AI rate limit value owned by the workspace (without resolving inherited defaults). Returns `undefined` when the workspace has no override.

**Signature:**

```typescript
getAiRateLimit(): Promise<IAiRateLimit | undefined>;
```
**Returns:**

Promise&lt;[IAiRateLimit](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iairatelimit/index.md) &#124; undefined&gt;

promise

### IWorkspaceSettingsService.getEnableDrillToUrlByDefault()

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

Gets enable drill to URL by default setting value for workspace.

**Signature:**

```typescript
getEnableDrillToUrlByDefault(): Promise<boolean | undefined>;
```
**Returns:**

Promise&lt;boolean &#124; undefined&gt;

promise of workspace-owned setting value, or undefined if not set

#### Remarks

Returns the workspace-owned value only, not the resolved/inherited value. Returns `undefined` if no workspace override exists (inherits from organization).

### IWorkspaceSettingsService.getExportCsvCustomDelimiter()

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

Gets CSV delimiter setting value for workspace.

**Signature:**

```typescript
getExportCsvCustomDelimiter(): Promise<string | undefined>;
```
**Returns:**

Promise&lt;string &#124; undefined&gt;

promise of workspace-owned setting value, or undefined if not set

#### Remarks

Returns the workspace-owned value only, not the resolved/inherited value. Returns `undefined` if no workspace override exists (inherits from organization).

### IWorkspaceSettingsService.getSettings()

Returns effective workspace settings with all inherited values resolved.

**Signature:**

```typescript
getSettings(): Promise<IWorkspaceSettings>;
```
**Returns:**

Promise&lt;[IWorkspaceSettings](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iworkspacesettings/index.md)&gt;

promise of resolved workspace settings

#### Remarks

The returned settings include values inherited from organization and system defaults, not just those directly set at the workspace level. User-specific overrides are excluded.

### IWorkspaceSettingsService.getSettingsForCurrentUser()

Asynchronously queries feature flags taking into account settings from both the workspace and the current user.

**Signature:**

```typescript
getSettingsForCurrentUser(): Promise<IUserWorkspaceSettings>;
```
**Returns:**

Promise&lt;[IUserWorkspaceSettings](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuserworkspacesettings/index.md)&gt;

promise of user/workspace settings

### IWorkspaceSettingsService.setActiveCalendars()

Sets active calendars configuration for current workspace.

**Signature:**

```typescript
setActiveCalendars(calendars: IActiveCalendars): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| calendars | [IActiveCalendars](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iactivecalendars/index.md) | configuration for which calendars are enabled and which is the default. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setActiveLlmEndpoint()

Set active LLM endpoint for the organization.

**Signature:**

```typescript
setActiveLlmEndpoint(endpoint: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| endpoint | string | id of the LLM endpoint to set as active for the organization. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setActiveLlmProvider()

Set active LLM provider for the organization.

**Signature:**

```typescript
setActiveLlmProvider(provider: string, defaultModelId: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| provider | string | id of the LLM provider to set as active for the organization. |
| defaultModelId | string | id of the default model to set as active for the organization. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setAiRateLimit()

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

Sets AI rate limit override for the current workspace.

**Signature:**

```typescript
setAiRateLimit(value: IAiRateLimit): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| value | [IAiRateLimit](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iairatelimit/index.md) | max interactions and rolling time window for AI chat. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setAlertDefault()

Sets alert default

**Signature:**

```typescript
setAlertDefault(value: IAlertDefault): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| value | [IAlertDefault](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ialertdefault/index.md) | describes parameters for alerting. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setColorPalette()

Sets color palette for current workspace.

**Signature:**

```typescript
setColorPalette(colorPaletteId: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| colorPaletteId | string | ID of the color palette to apply to charts in workspace. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setDashboardFiltersApplyMode()

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

Sets DashboardFiltersApplyMode configuration for workspace. Default is taken from organization setting.

**Signature:**

```typescript
setDashboardFiltersApplyMode(dashboardFiltersApplyMode: DashboardFiltersApplyMode): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| dashboardFiltersApplyMode | [DashboardFiltersApplyMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.dashboardfiltersapplymode/index.md) | describes new mode for applying dashboard filters. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setDateFormat()

Sets date format for current workspace.

**Signature:**

```typescript
setDateFormat(dateFormat: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| dateFormat | string | the format based on the ICU standard, for example: "en-US", "cs-CZ", etc. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setDefaultExportTemplate()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Sets the default export template applied to slide exports in this workspace when none is explicitly requested. Default is taken from organization setting.

**Signature:**

```typescript
setDefaultExportTemplate(value: IDefaultExportTemplate): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| value | [IDefaultExportTemplate](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idefaultexporttemplate/index.md) | identifier and scope of the export template to use as the default. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setEnableAiOnData()

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

Sets enable AI on data setting for current workspace.

**Signature:**

```typescript
setEnableAiOnData(enabled: boolean): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| enabled | boolean | whether to enable sending aggregated data to LLM. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setEnableDrillToUrlByDefault()

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

Sets enable drill to URL by default setting for workspace. Default is taken from organization setting.

**Signature:**

```typescript
setEnableDrillToUrlByDefault(enabled: boolean): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| enabled | boolean | whether to enable drill to URL by default for dashboard widgets. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setEnableNullJoins()

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

Sets enable null joins setting for workspace. Default is taken from organization setting.

**Signature:**

```typescript
setEnableNullJoins(enabled: boolean): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| enabled | boolean | whether to enable null value matching in SQL joins for this workspace. |

**Returns:**

Promise&lt;void&gt;

promise

#### Remarks

When enabled, generated SQL joins coalesce null values before comparing join keys.

### IWorkspaceSettingsService.setEnablePartialDataResults()

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

Sets enable partial data results setting for workspace. Default is taken from organization setting.

**Signature:**

```typescript
setEnablePartialDataResults(enabled: boolean): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| enabled | boolean | whether to allow partial data results for executions in this workspace. |

**Returns:**

Promise&lt;void&gt;

promise

#### Remarks

When enabled, executions that reach a row/column/cell limit return partial data (with limit-break metadata) instead of failing.

### IWorkspaceSettingsService.setEnableQueryTags()

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

Sets enable query tags setting for workspace. Default is taken from organization setting.

**Signature:**

```typescript
setEnableQueryTags(enabled: boolean): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| enabled | boolean | whether to enable query tags for this workspace. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setEnableTimezoneChange()

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

Sets whether end users may change the timezone in Analytical Designer and, by default, on dashboards.

**Signature:**

```typescript
setEnableTimezoneChange(enabled: boolean): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| enabled | boolean | whether end users may change the timezone |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setExportCsvCustomDelimiter()

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

Sets default CSV delimiter for exports in workspace. Default is taken from organization setting.

**Signature:**

```typescript
setExportCsvCustomDelimiter(delimiter: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| delimiter | string | single character delimiter to use for CSV exports. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setFiscalCalendar()

Sets fiscal calendar for current workspace.

**Signature:**

```typescript
setFiscalCalendar(fiscalYear: IFiscalYear): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| fiscalYear | [IFiscalYear](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifiscalyear/index.md) | fiscal year configuration including month offset and optional prefixes. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setFormatLocale()

Sets format locale for current workspace.

**Signature:**

```typescript
setFormatLocale(locale: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| locale | string | IETF BCP 47 Code locale ID, for example "en-US", "cs-CZ", etc. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setLocale()

Sets locale for current workspace.

**Signature:**

```typescript
setLocale(locale: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| locale | string | IETF BCP 47 Code locale ID, for example "en-US", "cs-CZ", etc. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setMetadataLocale()

Sets metadata locale for current workspace.

**Signature:**

```typescript
setMetadataLocale(locale: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| locale | string | IETF BCP 47 Code locale ID, for example "en-US", "cs-CZ", etc. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setMetricFormatOverride()

Sets metric format override for the current workspace.

**Signature:**

```typescript
setMetricFormatOverride(override: IMetricFormatOverrideSetting): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| override | [IMetricFormatOverrideSetting](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imetricformatoverridesetting/index.md) | mapping of metric types to custom format strings. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setSeparators()

Set separators for the current workspace

**Signature:**

```typescript
setSeparators(separators: ISeparators): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| separators | [ISeparators](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iseparators/index.md) | separators for the current workspace |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setTheme()

Sets theme for current workspace.

**Signature:**

```typescript
setTheme(themeId: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| themeId | string | ID of the theme to apply to the current workspace. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setTimezone()

Sets timezone for current workspace.

**Signature:**

```typescript
setTimezone(timezone: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| timezone | string | the value based on IANA time zone database naming convention. for example: "America/Los\_Angeles", etc. |

**Returns:**

Promise&lt;void&gt;

promise

### IWorkspaceSettingsService.setWeekStart()

Sets first day of week for current workspace.

**Signature:**

```typescript
setWeekStart(weekStart: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| weekStart | string | "Sunday \| "Monday" |

**Returns:**

Promise&lt;void&gt;

promise
