From ed83c6fb03a02911bfcafb87202b7e4ebbe3696e Mon Sep 17 00:00:00 2001 From: Ben McCann Date: Sun, 10 Sep 2017 15:03:33 -0700 Subject: [PATCH] Expand scale jsdocs --- src/core/core.scale.js | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/src/core/core.scale.js b/src/core/core.scale.js index f48b67a5ec1..89df4304b5b 100644 --- a/src/core/core.scale.js +++ b/src/core/core.scale.js @@ -538,17 +538,33 @@ module.exports = function(Chart) { return rawValue; }, - // Used to get the value to display in the tooltip for the data at the given index - // function getLabelForIndex(index, datasetIndex) + /** + * Used to get the value to display in the tooltip for the data at the given index + * @param index + * @param datasetIndex + */ getLabelForIndex: helpers.noop, - // Used to get data value locations. Value can either be an index or a numerical value + /** + * Returns the location of the given data point. Value can either be an index or a numerical value + * The coordinate (0, 0) is at the upper-left corner of the canvas + * @param value + * @param index + * @param datasetIndex + */ getPixelForValue: helpers.noop, - // Used to get the data value from a given pixel. This is the inverse of getPixelForValue + /** + * Used to get the data value from a given pixel. This is the inverse of getPixelForValue + * The coordinate (0, 0) is at the upper-left corner of the canvas + * @param pixel + */ getValueForPixel: helpers.noop, - // Used for tick location, should + /** + * Returns the location of the tick at the given index + * The coordinate (0, 0) is at the upper-left corner of the canvas + */ getPixelForTick: function(index) { var me = this; var offset = me.options.offset; @@ -569,7 +585,10 @@ module.exports = function(Chart) { return me.top + (index * (innerHeight / (me._ticks.length - 1))); }, - // Utility for getting the pixel location of a percentage of scale + /** + * Utility for getting the pixel location of a percentage of scale + * The coordinate (0, 0) is at the upper-left corner of the canvas + */ getPixelForDecimal: function(decimal) { var me = this; if (me.isHorizontal()) { @@ -583,6 +602,10 @@ module.exports = function(Chart) { return me.top + (decimal * me.height); }, + /** + * Returns the pixel for the minimum chart value + * The coordinate (0, 0) is at the upper-left corner of the canvas + */ getBasePixel: function() { return this.getPixelForValue(this.getBaseValue()); },