IChangeDashboardTimezoneOverridePayload
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Payload of the IChangeDashboardTimezoneOverride command.
export interface IChangeDashboardTimezoneOverridePayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| boolean | (ALPHA) (Optional) Skips the check that the dashboard’s timezone configuration allows user overrides in view mode, for restoring a timezone the platform already committed to (an export render, an automation deep link). The dashboard timezone feature flag is still honored. | |
| string | undefined | (ALPHA) Concrete IANA timezone id (e.g. “Europe/Prague”), the BROWSER_DETECTED sentinel (resolved to the viewer’s browser timezone by the handler), or undefined to clear the override so the dashboard/workspace configuration applies again. |
Property details
IChangeDashboardTimezoneOverridePayload.bypassUserOverrideCheckpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Skips the check that the dashboard’s timezone configuration allows user overrides in view mode, for restoring a timezone the platform already committed to (an export render, an automation deep link). The dashboard timezone feature flag is still honored.
readonly bypassUserOverrideCheck?: boolean;
IChangeDashboardTimezoneOverridePayload.timezoneIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Concrete IANA timezone id (e.g. “Europe/Prague”), the BROWSER_DETECTED sentinel (resolved to the viewer’s browser timezone by the handler), or undefined to clear the override so the dashboard/workspace configuration applies again.
readonly timezoneId: string | undefined;