IDashboardTimezoneOverrideChangedPayload

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

IDashboardTimezoneOverrideChangedPayload interface

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.

Payload of the IDashboardTimezoneOverrideChanged event.

Signature:

export interface IDashboardTimezoneOverrideChangedPayload

Properties

Property

Modifiers

Type

Description

effectiveTimezone

readonly

string | undefined

(ALPHA) The effective dashboard timezone after the change: the override when set, otherwise the dashboard's configured timezone (with the browser-detected sentinel resolved), or undefined when no dashboard timezone applies (feature disabled or nothing configured).

timezoneOverride

readonly

string | undefined

(ALPHA) The new session-only timezone override: a concrete IANA timezone ID, or undefined when the override was cleared. The payload never carries the browser-detected sentinel — the command handler resolves it before the state is written and this event is emitted.

← IDashboardTimezoneOverrideChangedIDashboardUserInteractionTriggered →