mirror of
https://github.com/chartjs/Chart.js.git
synced 2026-03-23 00:26:52 +01:00
Fix typos found by codespell (#10103)
This commit is contained in:
committed by
GitHub
parent
ec67123df8
commit
a7d98fb1a0
@@ -111,7 +111,7 @@ The doughnut/pie chart allows a number of properties to be specified for each da
|
||||
| [`circumference`](#general) | `number` | - | - | `undefined`
|
||||
| [`clip`](#general) | `number`\|`object` | - | - | `undefined`
|
||||
| [`data`](#data-structure) | `number[]` | - | - | **required**
|
||||
| [`hoverBackgroundColor`](#interations) | [`Color`](../general/colors.md) | Yes | Yes | `undefined`
|
||||
| [`hoverBackgroundColor`](#interactions) | [`Color`](../general/colors.md) | Yes | Yes | `undefined`
|
||||
| [`hoverBorderColor`](#interactions) | [`Color`](../general/colors.md) | Yes | Yes | `undefined`
|
||||
| [`hoverBorderJoinStyle`](#interactions) | `'round'`\|`'bevel'`\|`'miter'` | Yes | Yes | `undefined`
|
||||
| [`hoverBorderWidth`](#interactions) | `number` | Yes | Yes | `undefined`
|
||||
|
||||
@@ -62,7 +62,7 @@ The following options can be included in a polar area chart dataset to configure
|
||||
| [`borderWidth`](#styling) | `number` | Yes | Yes | `2`
|
||||
| [`clip`](#general) | `number`\|`object` | - | - | `undefined`
|
||||
| [`data`](#data-structure) | `number[]` | - | - | **required**
|
||||
| [`hoverBackgroundColor`](#interations) | [`Color`](../general/colors.md) | Yes | Yes | `undefined`
|
||||
| [`hoverBackgroundColor`](#interactions) | [`Color`](../general/colors.md) | Yes | Yes | `undefined`
|
||||
| [`hoverBorderColor`](#interactions) | [`Color`](../general/colors.md) | Yes | Yes | `undefined`
|
||||
| [`hoverBorderJoinStyle`](#interactions) | `'round'`\|`'bevel'`\|`'miter'` | Yes | Yes | `undefined`
|
||||
| [`hoverBorderWidth`](#interactions) | `number` | Yes | Yes | `undefined`
|
||||
|
||||
@@ -123,7 +123,7 @@ These keys can be configured in following paths:
|
||||
* `datasets[type]` - dataset type options
|
||||
* `overrides[type]` - chart type options
|
||||
|
||||
These paths are valid under `defaults` for global confuguration and `options` for instance configuration.
|
||||
These paths are valid under `defaults` for global configuration and `options` for instance configuration.
|
||||
|
||||
## animation
|
||||
|
||||
@@ -183,7 +183,7 @@ Namespace: `options.transitions[mode]`
|
||||
| `'active'` | animation.duration | 400 | Override default duration to 400ms for hover animations
|
||||
| `'resize'` | animation.duration | 0 | Override default duration to 0ms (= no animation) for resize
|
||||
| `'show'` | animations.colors | `{ type: 'color', properties: ['borderColor', 'backgroundColor'], from: 'transparent' }` | Colors are faded in from transparent when dataset is shown using legend / [api](../developers/api.md#showdatasetIndex).
|
||||
| `'show'` | animations.visible | `{ type: 'boolean', duration: 0 }` | Dataset visiblity is immediately changed to true so the color transition from transparent is visible.
|
||||
| `'show'` | animations.visible | `{ type: 'boolean', duration: 0 }` | Dataset visibility is immediately changed to true so the color transition from transparent is visible.
|
||||
| `'hide'` | animations.colors | `{ type: 'color', properties: ['borderColor', 'backgroundColor'], to: 'transparent' }` | Colors are faded to transparent when dataset id hidden using legend / [api](../developers/api.md#hidedatasetIndex).
|
||||
| `'hide'` | animations.visible | `{ type: 'boolean', easing: 'easeInExpo' }` | Visibility is changed to false at a very late phase of animation
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ Subtitle is a second title placed under the main title, by default. It has exact
|
||||
|
||||
Namespace: `options.plugins.subtitle`. The global defaults for subtitle are configured in `Chart.defaults.plugins.subtitle`.
|
||||
|
||||
Excactly the same configuration options with [title](./title.md) are available for subtitle, the namespaces only differ.
|
||||
Exactly the same configuration options with [title](./title.md) are available for subtitle, the namespaces only differ.
|
||||
|
||||
## Example Usage
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ A number of changes were made to the configuration options passed to the `Chart`
|
||||
* Polar area `startAngle` option is now consistent with `Radar`, 0 is at top and value is in degrees. Default is changed from `-½π` to `0`.
|
||||
* Doughnut `rotation` option is now in degrees and 0 is at top. Default is changed from `-½π` to `0`.
|
||||
* Doughnut `circumference` option is now in degrees. Default is changed from `2π` to `360`.
|
||||
* Doughnut `cutoutPercentage` was renamed to `cutout`and accepts pixels as numer and percent as string ending with `%`.
|
||||
* Doughnut `cutoutPercentage` was renamed to `cutout`and accepts pixels as number and percent as string ending with `%`.
|
||||
* `scale` option was removed in favor of `options.scales.r` (or any other scale id, with `axis: 'r'`)
|
||||
* `scales.[x/y]Axes` arrays were removed. Scales are now configured directly to `options.scales` object with the object key being the scale Id.
|
||||
* `scales.[x/y]Axes.barPercentage` was moved to dataset option `barPercentage`
|
||||
|
||||
@@ -2,10 +2,10 @@
|
||||
|
||||
## Out of the box working samples
|
||||
These samples are made for demonstration purposes only. They won't work out of the box if you copy paste them into your own website. This is because of how the docs are getting built. Some boilerplate code gets hidden.
|
||||
For a sample that can be copyed and pasted and used directly you can check the [usage page](../getting-started/usage.md).
|
||||
For a sample that can be copied and pasted and used directly you can check the [usage page](../getting-started/usage.md).
|
||||
|
||||
## Autogenerated data
|
||||
The data used in the samples is autogenerated using custom functions. These functions do not ship with the library, for more information about this you can check the [utils page](./utils.md).
|
||||
|
||||
## Actions block
|
||||
The samples have an `actions` code block. These actions are not part of chart.js. They are internally transformed to seperate buttons together with onClick listeners by a plugin we use in the documentation. To implement such actions yourself you can make some buttons and add onClick event listeners to them. Then in these event listeners you can call your variable in which you made the chart and do the logic that the button is supposed to do.
|
||||
The samples have an `actions` code block. These actions are not part of chart.js. They are internally transformed to separate buttons together with onClick listeners by a plugin we use in the documentation. To implement such actions yourself you can make some buttons and add onClick event listeners to them. Then in these event listeners you can call your variable in which you made the chart and do the logic that the button is supposed to do.
|
||||
|
||||
Reference in New Issue
Block a user