revert heatmap hover and only return early when z is undefined and hoverongaps is false

- adjust new tests to make sure plotly_hover is not triggered on gaps when hoverongaps is false

Author: archmoj

src/traces/heatmap/hover.js

@@ -88,14 +88,30 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode, hoverLay
         }
     }
 
+    var zVal = z[ny][nx];
+    if(zmask && !zmask[ny][nx]) zVal = undefined;
+
+    if(zVal === undefined && !trace.hoverongaps) return;
+
     var text;
     if(Array.isArray(cd0.hovertext) && Array.isArray(cd0.hovertext[ny])) {
         text = cd0.hovertext[ny][nx];
     } else if(Array.isArray(cd0.text) && Array.isArray(cd0.text[ny])) {
         text = cd0.text[ny][nx];
     }
 
-    var obj = {
+    // dummy axis for formatting the z value
+    var cOpts = extractOpts(trace);
+    var dummyAx = {
+        type: 'linear',
+        range: [cOpts.min, cOpts.max],
+        hoverformat: zhoverformat,
+        _separators: xa._separators,
+        _numFormat: xa._numFormat
+    };
+    var zLabel = Axes.tickText(dummyAx, zVal, 'hover').text;
+
+    return [Lib.extendFlat(pointData, {
         index: [ny, nx],
         // never let a 2D override 1D type as closest point
         distance: pointData.maxHoverDistance,
@@ -106,26 +122,8 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode, hoverLay
         y1: y1,
         xLabelVal: xl,
         yLabelVal: yl,
+        zLabelVal: zVal,
+        zLabel: zLabel,
         text: text
-    };
-
-    var zVal = z[ny][nx];
-    if(zmask && !zmask[ny][nx]) zVal = undefined;
-
-    if(zVal !== undefined || trace.hoverongaps) {
-        // dummy axis for formatting the z value
-        var cOpts = extractOpts(trace);
-        var dummyAx = {
-            type: 'linear',
-            range: [cOpts.min, cOpts.max],
-            hoverformat: zhoverformat,
-            _separators: xa._separators,
-            _numFormat: xa._numFormat
-        };
-
-        obj.zLabelVal = zVal;
-        obj.zLabel = Axes.tickText(dummyAx, zVal, 'hover').text;
-    }
-
-    return [Lib.extendFlat(pointData, obj)];
+    })];
 };

test/jasmine/tests/contour_test.js

@@ -619,13 +619,6 @@ describe('contour hover', function() {
         return hoverData;
     }
 
-    function assertLabels(hoverPoint, xLabel, yLabel, zLabel, text) {
-        expect(hoverPoint.xLabelVal).toBe(xLabel, 'have correct x label');
-        expect(hoverPoint.yLabelVal).toBe(yLabel, 'have correct y label');
-        expect(hoverPoint.zLabelVal).toBe(zLabel, 'have correct z label');
-        expect(hoverPoint.text).toBe(text, 'have correct text label');
-    }
-
     describe('missing data', function() {
         beforeAll(function(done) {
             gd = createGraphDiv();
@@ -643,11 +636,16 @@ describe('contour hover', function() {
         });
         afterAll(destroyGraphDiv);
 
-        it('should not create zLabels when hovering on missing data and hoverongaps is disabled', function() {
+        it('should not display hover on missing data and hoverongaps is disabled', function() {
             var pt = _hover(gd, 10, 100)[0];
 
-            expect(pt.index).toEqual([0, 0], 'have correct index');
-            assertLabels(pt, 10, 100, undefined);
+            var hoverData;
+            gd.on('plotly_hover', function(data) {
+                hoverData = data;
+            });
+
+            expect(hoverData).toEqual(undefined);
+            expect(pt).toEqual(undefined);
         });
     });
 });

test/jasmine/tests/heatmap_test.js

@@ -994,11 +994,16 @@ describe('heatmap hover', function() {
         });
         afterAll(destroyGraphDiv);
 
-        it('should not create zLabels when hovering on missing data and hoverongaps is disabled', function() {
+        it('should not display hover on missing data and hoverongaps is disabled', function() {
             var pt = _hover(gd, 10, 100)[0];
 
-            expect(pt.index).toEqual([0, 0], 'have correct index');
-            assertLabels(pt, 10, 100, undefined);
+            var hoverData;
+            gd.on('plotly_hover', function(data) {
+                hoverData = data;
+            });
+
+            expect(hoverData).toEqual(undefined);
+            expect(pt).toEqual(undefined);
         });
     });
 });