# locale

Locale name (`en` | `ko` | `ja` | `zh`) or a partial override object ().

Canonical: https://chart.syidax.com/docs/options/locale/

<a id="definition"></a>

## Definition

| Item | Value |
| --- | --- |
| JavaScript property | `locale` |
| HTML attribute | Pass objects, arrays, and callbacks as JavaScript properties |
| Type | `ChartLocaleName \| Partial<ChartLocale>` |
| Default | `undefined` |
| Literals in the type | `en`, `ko`, `ja`, `zh` |

undefined means this property was not explicitly set. The effective value may depend on the chart type and other settings.

- [ChartLocaleName](https://chart.syidax.com/docs/types/ChartLocaleName.md) — Type definition
- [ChartLocale](https://chart.syidax.com/docs/types/ChartLocale.md) — Type definition

<a id="related"></a>

## Related documentation

A property with the same name may have different types and defaults across charts. When using a direct tag, follow that chart's documentation below.

- [Shared facade and direct tags](https://chart.syidax.com/docs/concepts.md)
- [sy-theme-river](https://chart.syidax.com/docs/components/theme-river.md#property-locale)
- [sy-flow-lines](https://chart.syidax.com/docs/components/flow-lines.md#property-locale)
- [sy-stock-chart](https://chart.syidax.com/docs/components/stock-chart.md#property-locale)
- [sy-surface-3d](https://chart.syidax.com/docs/components/surface-3d.md#property-locale)
- [sy-bar-3d](https://chart.syidax.com/docs/components/bar-3d.md#property-locale)
- [sy-scatter-3d](https://chart.syidax.com/docs/components/scatter-3d.md#property-locale)