IWorkspaceSettingsService

IWorkspaceSettingsService.deleteAiRateLimit()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

deleteAiRateLimit(): Promise<void>;

Returns

Promise<void>

promise

IWorkspaceSettingsService.deleteColorPalette()method

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

deleteColorPalette(): Promise<void>;

Returns

Promise<void>

promise

IWorkspaceSettingsService.deleteDashboardFiltersApplyMode()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Clears DashboardFiltersApplyMode configuration for workspace so default value from organization is used.

deleteDashboardFiltersApplyMode(): Promise<void>;

Returns

Promise<void>

promise

IWorkspaceSettingsService.deleteDefaultExportTemplate()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

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

deleteDefaultExportTemplate(): Promise<void>;

Returns

Promise<void>

promise

IWorkspaceSettingsService.deleteEnableDrillToUrlByDefault()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Clears enable drill to URL by default configuration for workspace so default value from organization is used.

deleteEnableDrillToUrlByDefault(): Promise<void>;

Returns

Promise<void>

promise

IWorkspaceSettingsService.deleteExportCsvCustomDelimiter()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Clears workspace CSV delimiter configuration so default value from organization is used.

deleteExportCsvCustomDelimiter(): Promise<void>;

Returns

Promise<void>

promise

IWorkspaceSettingsService.deleteMetricFormatOverride()method

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

deleteMetricFormatOverride(): Promise<void>;

Returns

Promise<void>

promise

IWorkspaceSettingsService.deleteTheme()method

Deletes theme from workspace settings returning workspace styling to default.

deleteTheme(): Promise<void>;

Returns

Promise<void>

promise

IWorkspaceSettingsService.getAiRateLimit()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

getAiRateLimit(): Promise<IAiRateLimit | undefined>;

Returns

Promise<IAiRateLimit | undefined>

promise

IWorkspaceSettingsService.getEnableDrillToUrlByDefault()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

getEnableDrillToUrlByDefault(): Promise<boolean | undefined>;

Returns

Promise<boolean | undefined>

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()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Gets CSV delimiter setting value for workspace.

getExportCsvCustomDelimiter(): Promise<string | undefined>;

Returns

Promise<string | undefined>

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()method

Returns effective workspace settings with all inherited values resolved.

getSettings(): Promise<IWorkspaceSettings>;

Returns

Promise<IWorkspaceSettings>

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()method

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

getSettingsForCurrentUser(): Promise<IUserWorkspaceSettings>;

Returns

Promise<IUserWorkspaceSettings>

promise of user/workspace settings

IWorkspaceSettingsService.setActiveCalendars()method

Sets active calendars configuration for current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setActiveLlmEndpoint()method

Set active LLM endpoint for the organization.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setActiveLlmProvider()method

Set active LLM provider for the organization.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setAiRateLimit()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Sets AI rate limit override for the current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setAlertDefault()method

Sets alert default

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setColorPalette()method

Sets color palette for current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setDashboardFiltersApplyMode()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setDateFormat()method

Sets date format for current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setDefaultExportTemplate()methodBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

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

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setEnableAiOnData()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Sets enable AI on data setting for current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setEnableDrillToUrlByDefault()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setEnableNullJoins()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

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

Parameters

Returns

Promise<void>

promise

Remarks

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

IWorkspaceSettingsService.setEnablePartialDataResults()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

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

Parameters

Returns

Promise<void>

promise

Remarks

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

IWorkspaceSettingsService.setEnableQueryTags()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setEnableTimezoneChange()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setExportCsvCustomDelimiter()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

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

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setFiscalCalendar()method

Sets fiscal calendar for current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setFormatLocale()method

Sets format locale for current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setLocale()method

Sets locale for current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setMetadataLocale()method

Sets metadata locale for current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setMetricFormatOverride()method

Sets metric format override for the current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setSeparators()method

Set separators for the current workspace

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setTheme()method

Sets theme for current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setTimezone()method

Sets timezone for current workspace.

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

Parameters

Returns

Promise<void>

promise

IWorkspaceSettingsService.setWeekStart()method

Sets first day of week for current workspace.

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

Parameters

Returns

Promise<void>

promise