rename and document appendArrayMultiPointValues

Author: alexcjohnson

src/components/fx/helpers.js

@@ -89,7 +89,8 @@ exports.quadrature = function quadrature(dx, dy) {
  *
  * @param {object} pointData : point data object (gets mutated here)
  * @param {object} trace : full trace object
- * @param {number} pointNumber : point number
+ * @param {number|Array(number)} pointNumber : point number. May be a length-2 array
+ *     [row, col] to dig into 2D arrays
  */
 exports.appendArrayPointValue = function(pointData, trace, pointNumber) {
     var arrayAttrs = trace._arrayAttrs;
@@ -111,7 +112,17 @@ exports.appendArrayPointValue = function(pointData, trace, pointNumber) {
     }
 };
 
-exports.appendArrayPointValues = function(pointData, trace, pointNumbers) {
+/**
+ * Appends values inside array attributes corresponding to given point number array
+ * For use when pointData references a plot entity that arose (or potentially arose)
+ * from multiple points in the input data
+ *
+ * @param {object} pointData : point data object (gets mutated here)
+ * @param {object} trace : full trace object
+ * @param {Array(number)|Array(Array(number))} pointNumbers : Array of point numbers.
+ *     Each entry in the array may itself be a length-2 array [row, col] to dig into 2D arrays
+ */
+exports.appendArrayMultiPointValues = function(pointData, trace, pointNumbers) {
     var arrayAttrs = trace._arrayAttrs;
 
     if(!arrayAttrs) {

src/traces/pie/event_data.js

@@ -9,7 +9,7 @@
 
 'use strict';
 
-var appendArrayPointValues = require('../../components/fx/helpers').appendArrayPointValues;
+var appendArrayMultiPointValues = require('../../components/fx/helpers').appendArrayMultiPointValues;
 
 
 // Note: like other eventData routines, this creates the data for hover/unhover/click events
@@ -35,7 +35,7 @@ module.exports = function eventData(pt, trace) {
     // Add extra data arrays to the output
     // notice that this is the multi-point version ('s' on the end!)
     // so added data will be arrays matching the pointNumbers array.
-    appendArrayPointValues(out, trace, pt.pts);
+    appendArrayMultiPointValues(out, trace, pt.pts);
 
     return out;
 };