resolveDashboardTimezoneUserOverrideAllowed()

Home > @gooddata/sdk-model > resolveDashboardTimezoneUserOverrideAllowed

resolveDashboardTimezoneUserOverrideAllowed() function

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Resolves whether consumers may change the dashboard timezone in view mode.

Signature:

export declare function resolveDashboardTimezoneUserOverrideAllowed(config: IDashboardTimezoneConfig | undefined, enableTimezoneChange: boolean | undefined): boolean;

Parameters

Parameter

Type

Description

config

IDashboardTimezoneConfig | undefined

dashboard timezone configuration; undefined inherits the setting

enableTimezoneChange

boolean | undefined

organization/workspace setting that supplies the default

Returns:

boolean

whether the view-mode timezone override is allowed

Remarks

Uses the dashboard's explicit IDashboardTimezoneConfig.allowUserOverrideInViewMode when set; otherwise falls back to the organization/workspace enableTimezoneChange setting.

← RequiredWorkspacePermissionsresolveTimezoneId() →