resolveDashboardTimezoneInfo()

Home > @gooddata/sdk-ui-dashboard > resolveDashboardTimezoneInfo

resolveDashboardTimezoneInfo() 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 the dashboard timezone configuration to displayable timezone information: a concrete IANA timezone ID, the friendly name and the UTC offset label.

When effectiveTimezoneId is provided (the concrete IANA ID already preferred by the dashboard — including any session-only view-mode override), it takes precedence. Otherwise falls back to the configured timezone (resolving the browser-detected sentinel) and then to the effective workspace/organization timezone.

Signature:

export declare function resolveDashboardTimezoneInfo(timezoneConfig: IDashboardTimezoneConfig | undefined, defaultTimezone?: string, effectiveTimezoneId?: string): IDashboardTimezoneInfo | undefined;

Parameters

Parameter

Type

Description

timezoneConfig

IDashboardTimezoneConfig | undefined

defaultTimezone

string

(Optional)

effectiveTimezoneId

string

(Optional)

Returns:

IDashboardTimezoneInfo | undefined

← ResolveAsyncRenderPayloadResolvedDashboardConfig →