IScheduleTimezoneSelection

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

IScheduleTimezoneSelection 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.

A timezone selection of the schedule dialog's "Time zone" section.

shouldSave decides whether the value is baked into the export definitions. Values the backend derives itself at run time are displayed but not saved: the Default option of a dashboard schedule (id undefined; persisted dashboard configuration → settings hierarchy) and a widget schedule showing the settings-hierarchy resolution (concrete id). Everything the backend cannot derive is saved: the view-mode override and browser resolution always, the dashboard's stored configuration for widget schedules, and any timezone picked manually in the dropdown.

Signature:

export interface IScheduleTimezoneSelection 

Properties

Property	Modifiers	Type	Description
id		string | undefined	(ALPHA) Selected timezone (IANA ID); undefined represents the Default option.
shouldSave		boolean	(ALPHA) Whether the selection is baked into the export definitions or left for the backend to derive at run time.