get rid of (x|y)LabelVal(0|1), in favor of (x|y)Label

and move range-or-single-value logic into Axes.hoverLabelText

Author: alexcjohnson

src/components/fx/hover.js

@@ -1065,11 +1065,11 @@ function cleanPoint(d, hovermode) {
 
     // and convert the x and y label values into formatted text
     if(d.xLabelVal !== undefined) {
-        d.xLabel = ('xLabel' in d) ? d.xLabel : getDimText(d, 'x');
+        d.xLabel = ('xLabel' in d) ? d.xLabel : Axes.hoverLabelText(d.xa, d.xLabelVal);
         d.xVal = d.xa.c2d(d.xLabelVal);
     }
     if(d.yLabelVal !== undefined) {
-        d.yLabel = ('yLabel' in d) ? d.yLabel : getDimText(d, 'y');
+        d.yLabel = ('yLabel' in d) ? d.yLabel : Axes.hoverLabelText(d.ya, d.yLabelVal);
         d.yVal = d.ya.c2d(d.yLabelVal);
     }
     if(d.zLabelVal !== undefined) d.zLabel = String(d.zLabelVal);
@@ -1112,24 +1112,6 @@ function cleanPoint(d, hovermode) {
     return d;
 }
 
-// get text for either a value range (val0 .. val1) if it exists,
-// or single value (val) if the range does not exist
-function getDimText(d, axLetter) {
-    var val = d[axLetter + 'LabelVal'];
-    var val0 = d[axLetter + 'LabelVal0'];
-    var val1 = d[axLetter + 'LabelVal1'];
-    var ax = d[axLetter + 'a'];
-
-    if(val0 !== undefined && val1 !== undefined) {
-        var text0 = Axes.hoverLabelText(ax, val0);
-        var text1 = Axes.hoverLabelText(ax, val1);
-
-        if(text0 === text1) return text0;
-        return text0 + ' - ' + text1;
-    }
-    return Axes.hoverLabelText(ax, val);
-}
-
 function createSpikelines(hoverData, opts) {
     var hovermode = opts.hovermode;
     var container = opts.container;

src/plots/cartesian/axes.js

@@ -28,6 +28,7 @@ var ONEHOUR = constants.ONEHOUR;
 var ONEMIN = constants.ONEMIN;
 var ONESEC = constants.ONESEC;
 var MINUS_SIGN = constants.MINUS_SIGN;
+var BADNUM = constants.BADNUM;
 
 var MID_SHIFT = require('../../constants/alignment').MID_SHIFT;
 
@@ -1216,7 +1217,23 @@ axes.tickText = function(ax, x, hover) {
     return out;
 };
 
-axes.hoverLabelText = function(ax, val) {
+/**
+ * create text for a hover label on this axis, with special handling of
+ * log axes (where negative values can't be displayed but can appear in hover text)
+ *
+ * @param {object} ax: the axis to format text for
+ * @param {number} val: calcdata value to format
+ * @param {Optional(number)} val2: a second value to display
+ *
+ * @returns {string} `val` formatted as a string appropriate to this axis, or
+ *     `val` and `val2` as a range (ie '<val> - <val2>') if `val2` is provided and
+ *     it's different from `val`.
+ */
+axes.hoverLabelText = function(ax, val, val2) {
+    if(val2 !== BADNUM && val2 !== val) {
+        return axes.hoverLabelText(ax, val) + ' - ' + axes.hoverLabelText(ax, val2);
+    }
+
     var logOffScale = (ax.type === 'log' && val <= 0);
     var tx = axes.tickText(ax, ax.c2l(logOffScale ? -val : val), 'hover').text;
 

src/traces/histogram/hover.js

@@ -10,6 +10,7 @@
 'use strict';
 
 var barHover = require('../bar/hover');
+var hoverLabelText = require('../../plots/cartesian/axes').hoverLabelText;
 
 module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
     var pts = barHover(pointData, xval, yval, hovermode);
@@ -23,8 +24,7 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
     if(!trace.cumulative.enabled) {
         var posLetter = trace.orientation === 'h' ? 'y' : 'x';
 
-        pointData[posLetter + 'LabelVal0'] = di.p0;
-        pointData[posLetter + 'LabelVal1'] = di.p1;
+        pointData[posLetter + 'Label'] = hoverLabelText(pointData[posLetter + 'a'], di.p0, di.p1);
         pointData.pts = di.pts;
     }
 

src/traces/histogram2d/hover.js

@@ -10,6 +10,7 @@
 'use strict';
 
 var heatmapHover = require('../heatmap/hover');
+var hoverLabelText = require('../../plots/cartesian/axes').hoverLabelText;
 
 module.exports = function hoverPoints(pointData, xval, yval, hovermode, contour) {
     var pts = heatmapHover(pointData, xval, yval, hovermode, contour);
@@ -21,11 +22,11 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode, contour)
     var ny = indices[0];
     var nx = indices[1];
     var cd0 = pointData.cd[0];
+    var xRange = cd0.xRanges[nx];
+    var yRange = cd0.yRanges[ny];
 
-    pointData.xLabelVal0 = cd0.xRanges[nx][0];
-    pointData.xLabelVal1 = cd0.xRanges[nx][1];
-    pointData.yLabelVal0 = cd0.yRanges[ny][0];
-    pointData.yLabelVal1 = cd0.yRanges[ny][1];
+    pointData.xLabel = hoverLabelText(pointData.xa, xRange[0], xRange[1]);
+    pointData.yLabel = hoverLabelText(pointData.ya, yRange[0], yRange[1]);
     pointData.pts = cd0.pts[ny][nx];
 
     return pts;