ITimezoneIndicatorProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
export interface ITimezoneIndicatorProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) Effective workspace/organization timezone used when ITimezoneIndicatorProps.timezoneConfig does not define an explicit timezone ID. | ||
(ALPHA) (Optional) Resolved timezone information. The default indicator renders only IDashboardTimezoneInfo.name in the badge; IDashboardTimezoneInfo.offsetLabel is shown in the tooltip and exposed here for custom renderings. When not provided, the indicator resolves the information from ITimezoneIndicatorProps.timezoneConfig and ITimezoneIndicatorProps.defaultTimezone. | |||
(ALPHA) (Optional) Dashboard timezone configuration driving the indicator visibility. |
Property details
ITimezoneIndicatorProps.defaultTimezonepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Effective workspace/organization timezone used when ITimezoneIndicatorProps.timezoneConfig does not define an explicit timezone ID.
defaultTimezone?: string;
ITimezoneIndicatorProps.timezonepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Resolved timezone information. The default indicator renders only IDashboardTimezoneInfo.name in the badge; IDashboardTimezoneInfo.offsetLabel is shown in the tooltip and exposed here for custom renderings. When not provided, the indicator resolves the information from ITimezoneIndicatorProps.timezoneConfig and ITimezoneIndicatorProps.defaultTimezone.
timezone?: IDashboardTimezoneInfo;
ITimezoneIndicatorProps.timezoneConfigpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Dashboard timezone configuration driving the indicator visibility.
timezoneConfig?: IDashboardTimezoneConfig;