changeDashboardTimezoneOverride()

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

changeDashboardTimezoneOverride() function

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.

Creates the ChangeDashboardTimezoneOverride command.

Signature:

export declare function changeDashboardTimezoneOverride(timezoneId: string | undefined, correlationId?: string): IChangeDashboardTimezoneOverride;

Parameters

Parameter	Type	Description
timezoneId	string | undefined	concrete IANA timezone id, the BROWSER_DETECTED sentinel (resolved to the viewer's browser timezone by the handler), or undefined to clear the override
correlationId	string	(Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing

Returns:

IChangeDashboardTimezoneOverride

Remarks

Dispatching this command will set (or clear, when timezoneId is undefined) the session-only ad-hoc timezone override of the dashboard. The override takes precedence over the dashboard's configured timezone, is never persisted with the dashboard, and resets on full reload.

The command is rejected when the ad-hoc override is not allowed: the dashboard timezone feature is disabled or the dashboard's timezone configuration does not allow user overrides in view mode.