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

Fix type definitions for getPixelForValue (#9263)

Browse Source 
Update docs: From what I can tell, the `index` parameter was re-introduced as part of the new `normalized` option.
This commit is contained in:
Josh Kelley 2021-06-14 00:49:27 -04:00 committed by GitHub
parent 54da5341f1
commit 2768c7dea7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/developers/axes.md
View File

@ -90,9 +90,8 @@ To work with Chart.js, custom scale types must implement the following interface
// Get the pixel (x coordinate for horizontal axis, y coordinate for vertical axis) for a given value
// @param value : the value to get the pixel for
// @param index : index into the data array of the value
// @param datasetIndex : index of the dataset the value comes from
getPixelForValue: function(value, index, datasetIndex) {},
// @param [index] : index into the data array of the value
getPixelForValue: function(value, index) {},
// Get the value for a given pixel (x coordinate for horizontal axis, y coordinate for vertical axis)
// @param pixel : pixel value

2
docs/getting-started/v3-migration.md
View File

@ -467,7 +467,7 @@ The APIs listed in this section have changed in signature or behaviour from vers
#### Changed in Scales
* `Scale.getLabelForIndex` was replaced by `scale.getLabelForValue`
* `Scale.getPixelForValue` now has only one parameter. For the `TimeScale` that parameter must be millis since the epoch
* `Scale.getPixelForValue` now only requires one parameter. For the `TimeScale` that parameter must be millis since the epoch. As a performance optimization, it may take an optional second parameter, giving the index of the data point.
##### Changed in Ticks

2
types/index.esm.d.ts vendored
View File

@ -1219,7 +1219,7 @@ export interface Scale<O extends CoreScaleOptions = CoreScaleOptions> extends El
* @param {number} [index]
* @return {number}
*/
getPixelForValue(value: number, index: number): number;
getPixelForValue(value: number, index?: number): number;
/**
* Used to get the data value from a given pixel. This is the inverse of getPixelForValue