Genericize heatmap xyz variable names

Author: rreusser

src/traces/heatmap/calc.js

@@ -16,7 +16,7 @@ var Axes = require('../../plots/cartesian/axes');
 var histogram2dCalc = require('../histogram2d/calc');
 var colorscaleCalc = require('../../components/colorscale/calc');
 var hasColumns = require('./has_columns');
-var convertColumnXYZ = require('./convert_column_xyz');
+var convertColumnData = require('./convert_column_xyz');
 var maxRowLength = require('./max_row_length');
 var clean2dArray = require('./clean_2d_array');
 var interp2d = require('./interp2d');
@@ -57,7 +57,7 @@ module.exports = function calc(gd, trace) {
         z = binned.z;
     }
     else {
-        if(hasColumns(trace)) convertColumnXYZ(trace, xa, ya);
+        if(hasColumns(trace)) convertColumnData(trace, xa, ya, 'x', 'y', ['z']);
 
         x = trace.x ? xa.makeCalcdata(trace, 'x') : [];
         y = trace.y ? ya.makeCalcdata(trace, 'y') : [];

src/traces/heatmap/convert_column_xyz.js

@@ -12,49 +12,68 @@
 var Lib = require('../../lib');
 var BADNUM = require('../../constants/numerical').BADNUM;
 
+module.exports = function convertColumnData(trace, ax1, ax2, var1Name, var2Name, arrayVarNames) {
+    var1Name = var1Name || 'x';
+    var2Name = var2Name || 'y';
+    arrayVarNames = arrayVarNames || ['z'];
 
-module.exports = function convertColumnXYZ(trace, xa, ya) {
-    var xCol = trace.x.slice(),
-        yCol = trace.y.slice(),
-        zCol = trace.z,
+    var col1 = trace[var1Name].slice(),
+        col2 = trace[var2Name].slice(),
         textCol = trace.text,
-        colLen = Math.min(xCol.length, yCol.length, zCol.length),
+        colLen = Math.min(col1.length, col2.length),
         hasColumnText = (textCol !== undefined && !Array.isArray(textCol[0])),
-        xcalendar = trace.xcalendar,
-        ycalendar = trace.ycalendar;
+        col1Calendar = trace[var1Name + 'calendar'],
+        col2Calendar = trace[var2Name + 'calendar'];
 
-    var i;
+    var i, j, arrayVar, newArray, arrayVarName;
 
-    if(colLen < xCol.length) xCol = xCol.slice(0, colLen);
-    if(colLen < yCol.length) yCol = yCol.slice(0, colLen);
+    for(i = 0; i < arrayVarNames.length; i++) {
+        arrayVar = trace[arrayVarNames[i]];
+        if(arrayVar) colLen = Math.min(colLen, arrayVar.length);
+    }
+
+    if(colLen < col1.length) col1 = col1.slice(0, colLen);
+    if(colLen < col2.length) col2 = col2.slice(0, colLen);
 
     for(i = 0; i < colLen; i++) {
-        xCol[i] = xa.d2c(xCol[i], 0, xcalendar);
-        yCol[i] = ya.d2c(yCol[i], 0, ycalendar);
+        col1[i] = ax1.d2c(col1[i], 0, col1Calendar);
+        col2[i] = ax2.d2c(col2[i], 0, col2Calendar);
     }
 
-    var xColdv = Lib.distinctVals(xCol),
-        x = xColdv.vals,
-        yColdv = Lib.distinctVals(yCol),
-        y = yColdv.vals,
-        z = Lib.init2dArray(y.length, x.length);
+    var col1dv = Lib.distinctVals(col1),
+        col1vals = col1dv.vals,
+        col2dv = Lib.distinctVals(col2),
+        col2vals = col2dv.vals,
+        newArrays = [];
+
+    for(i = 0; i < arrayVarNames.length; i++) {
+        newArrays[i] = Lib.init2dArray(col2vals.length, col1vals.length);
+    }
 
-    var text;
+    var i1, i2, text;
 
-    if(hasColumnText) text = Lib.init2dArray(y.length, x.length);
+    if(hasColumnText) text = Lib.init2dArray(col2vals.length, col1vals.length);
 
     for(i = 0; i < colLen; i++) {
-        if(xCol[i] !== BADNUM && yCol[i] !== BADNUM) {
-            var ix = Lib.findBin(xCol[i] + xColdv.minDiff / 2, x);
-            var iy = Lib.findBin(yCol[i] + yColdv.minDiff / 2, y);
+        if(col1[i] !== BADNUM && col2[i] !== BADNUM) {
+            i1 = Lib.findBin(col1[i] + col1dv.minDiff / 2, col1vals);
+            i2 = Lib.findBin(col2[i] + col2dv.minDiff / 2, col2vals);
+
+            for(j = 0; j < arrayVarNames.length; j++) {
+                arrayVarName = arrayVarNames[j];
+                arrayVar = trace[arrayVarName];
+                newArray = newArrays[j];
+                newArray[i2][i1] = arrayVar[i];
+            }
 
-            z[iy][ix] = zCol[i];
-            if(hasColumnText) text[iy][ix] = textCol[i];
+            if(hasColumnText) text[i2][i1] = textCol[i];
         }
     }
 
-    trace.x = x;
-    trace.y = y;
-    trace.z = z;
+    trace[var1Name] = col1vals;
+    trace[var2Name] = col2vals;
+    for(j = 0; j < arrayVarNames.length; j++) {
+        trace[arrayVarNames[j]] = newArrays[j];
+    }
     if(hasColumnText) trace.text = text;
 };

src/traces/heatmap/xyz_defaults.js

@@ -15,22 +15,24 @@ var Registry = require('../../registry');
 var hasColumns = require('./has_columns');
 
 
-module.exports = function handleXYZDefaults(traceIn, traceOut, coerce, layout) {
+module.exports = function handleXYZDefaults(traceIn, traceOut, coerce, layout, xName, yName) {
     var z = coerce('z');
+    xName = xName || 'x';
+    yName = yName || 'y';
     var x, y;
 
     if(z === undefined || !z.length) return 0;
 
     if(hasColumns(traceIn)) {
-        x = coerce('x');
-        y = coerce('y');
+        x = coerce(xName);
+        y = coerce(yName);
 
-        // column z must be accompanied by 'x' and 'y' arrays
+        // column z must be accompanied by xName and yName arrays
         if(!x || !y) return 0;
     }
     else {
-        x = coordDefaults('x', coerce);
-        y = coordDefaults('y', coerce);
+        x = coordDefaults(xName, coerce);
+        y = coordDefaults(yName, coerce);
 
         // TODO put z validation elsewhere
         if(!isValidZ(z)) return 0;
@@ -39,7 +41,7 @@ module.exports = function handleXYZDefaults(traceIn, traceOut, coerce, layout) {
     }
 
     var handleCalendarDefaults = Registry.getComponentMethod('calendars', 'handleTraceDefaults');
-    handleCalendarDefaults(traceIn, traceOut, ['x', 'y'], layout);
+    handleCalendarDefaults(traceIn, traceOut, [xName, yName], layout);
 
     return traceOut.z.length;
 };