[v3] Add locale to ChartOptions type (#8118)

* Add locale to ChartOptions type

* Adds locale options documentation

* fixed typo

* changes links to number format, linking the constructor

* changes to a better sentence

* changes to better sentence (2)

Co-authored-by: stock <stocki.nail@gmail.com>
This commit is contained in:
lab900-marcel-samyn 2020-12-04 07:25:43 +01:00 committed by GitHub
parent c1aeba1e67
commit e08b17636b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 32 additions and 0 deletions

View File

@ -0,0 +1,25 @@
---
title: Locale
---
For applications where the numbers of ticks on scales must be formatted accordingly with a language sensitive number formatting, you can enable this kind of formatting by setting the `locale` option.
The locale is a string that is a [Unicode BCP 47 locale identifier](https://www.unicode.org/reports/tr35/tr35.html#BCP_47_Conformance).
A Unicode BCP 47 locale identifier consists of
1. a language code,
2. (optionally) a script code,
3. (optionally) a region (or country) code,
4. (optionally) one or more variant codes, and
5. (optionally) one or more extension sequences,
with all present components separated by hyphens.
By default the chart is using the default locale of the platform which is running on.
## Configuration Options
| Name | Type | Default | Description
| ---- | ---- | ------- | -----------
| `locale` | `string` | `undefined` | a string with a BCP 47 language tag, leveraging on [INTL NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat).

View File

@ -16,6 +16,7 @@ module.exports = {
'general/accessibility',
'general/responsive',
'general/device-pixel-ratio',
'general/locale',
{Interactions: ['general/interactions/index', 'general/interactions/events', 'general/interactions/modes']},
'general/options',
'general/colors',

View File

@ -131,6 +131,12 @@ export interface CoreChartOptions extends ParsingOptions {
* @default 2
*/
aspectRatio: number;
/**
* Locale used for number formatting (using `Intl.NumberFormat`).
* @default user's browser setting
*/
locale: string;
/**
* Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.