IDashboardTimezoneConfig
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dashboard-level timezone configuration.
export interface IDashboardTimezoneConfig
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| boolean | (ALPHA) (Optional) Whether consumers may change the timezone ad-hoc in view mode. The override is session-only and never persisted to the dashboard. Also gates the embedding setTimezone command. When unset, the organization/workspace | |
| boolean | (ALPHA) (Optional) Whether the timezone indicator is shown on the dashboard (and in its exports). | |
| (ALPHA) (Optional) IANA timezone ID (e.g. “Europe/Prague”), or BROWSER_DETECTED to detect the timezone from the viewer’s browser at load time. Undefined means the workspace/organization setting is used. |
Property details
IDashboardTimezoneConfig.allowUserOverrideInViewModepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether consumers may change the timezone ad-hoc in view mode. The override is session-only and never persisted to the dashboard. Also gates the embedding setTimezone command.
When unset, the organization/workspace enableTimezoneChange setting is used as the default. An explicit false disables the override even when that setting is on.
readonly allowUserOverrideInViewMode?: boolean;
IDashboardTimezoneConfig.showTimezoneInfopropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the timezone indicator is shown on the dashboard (and in its exports).
readonly showTimezoneInfo?: boolean;
IDashboardTimezoneConfig.timezoneIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
IANA timezone ID (e.g. “Europe/Prague”), or BROWSER_DETECTED to detect the timezone from the viewer’s browser at load time. Undefined means the workspace/organization setting is used.
readonly timezoneId?: DashboardTimezoneId;