IDashboardTimezoneOverrideChangedPayload
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Payload of the IDashboardTimezoneOverrideChanged event.
export interface IDashboardTimezoneOverrideChangedPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| 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). | |
| 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. |
Property details
IDashboardTimezoneOverrideChangedPayload.effectiveTimezonepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
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).
readonly effectiveTimezone: string | undefined;
IDashboardTimezoneOverrideChangedPayload.timezoneOverridepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
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.
readonly timezoneOverride: string | undefined;