<!-- Public documentation export; not library implementation source. -->
# ITimezoneApi

[Integration guide](https://docs.lumencharts.com/charting-library/reference/compatibility) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

## availableTimezones {#availabletimezones}

```ts
availableTimezones(): readonly TimezoneInfo[];
```

Use the type signature above and the integration guide for the owning capability.

## getTimezone {#gettimezone}

```ts
getTimezone(): TimezoneInfo;
```

Use the type signature above and the integration guide for the owning capability.

## setTimezone {#settimezone}

```ts
setTimezone(
    timezone: TimezoneId | CustomTimezoneId,
    options?: UndoOptions,
  ): void;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `timezone` | `TimezoneId &#124; CustomTimezoneId` | Yes |
| `options` | `UndoOptions` | No |

## onTimezoneChanged {#ontimezonechanged}

```ts
onTimezoneChanged(): ISubscription<(timezone: TimezoneId) => void>;
```

Use the type signature above and the integration guide for the owning capability.

## Related types

- [TimezoneInfo](https://docs.lumencharts.com/charting-library/api/TimezoneInfo)
- [TimezoneId](https://docs.lumencharts.com/charting-library/api/TimezoneId)
- [CustomTimezoneId](https://docs.lumencharts.com/charting-library/api/CustomTimezoneId)
- [UndoOptions](https://docs.lumencharts.com/charting-library/api/UndoOptions)
- [ISubscription](https://docs.lumencharts.com/charting-library/api/ISubscription)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/ITimezoneApi