archive-gh-me/Chart.js
1
0
Fork 0
mirror of https://github.com/chartjs/Chart.js.git synced 2025-12-08 20:36:08 +00:00
Code Issues Projects Releases Wiki Activity

Update context documentation (#8626)

Browse Source
This commit is contained in:
Jukka Kurkela 2021-03-13 15:05:57 +02:00 committed by GitHub
parent aee979da54
commit aae8a06c37
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/docs/general/options.md
View File

@ -70,6 +70,8 @@ A plugin can provide `additionalOptionScopes` array of paths to additionally loo
Scriptable options also accept a function which is called for each of the underlying data values and that takes the unique argument `context` representing contextual information (see [option context](options.md#option-context)).
A resolver is passed as second parameter, that can be used to access other options in the same context.
> **Note:** the `context` argument should be validated in the scriptable function, because the function can be invoked in different contexts. The `type` field is a good candidate for this validation.
Example:
```javascript
@ -132,7 +134,7 @@ In addition to [chart](#chart)
* `active`: true if element is active (hovered)
* `dataset`: dataset at index `datasetIndex`
* `datasetIndex`: index of the current dataset
* `index`: getter for `datasetIndex`
* `index`: same as `datasetIndex`
* `mode`: the update mode
* `type`: `'dataset'`
@ -145,8 +147,7 @@ In addition to [dataset](#dataset)
* `parsed`: the parsed data values for the given `dataIndex` and `datasetIndex`
* `raw`: the raw data values for the given `dataIndex` and `datasetIndex`
* `element`: the element (point, arc, bar, etc.) for this data
* `index`: getter for `dataIndex`
* `mode`: the update mode
* `index`: same as `dataIndex`
* `type`: `'data'`
### scale

1
src/core/core.datasetController.js
View File

@ -158,6 +158,7 @@ function createDatasetContext(parent, index, dataset) {
dataset,
datasetIndex: index,
index,
mode: 'default',
type: 'dataset'
}
);