Add zhoverformat to contour plots

Author: jdugge

src/components/fx/hover.js

@@ -1095,7 +1095,8 @@ function cleanPoint(d, hovermode) {
         d.yVal = d.ya.c2d(d.yLabelVal);
     }
 
-    if(d.zLabelVal !== undefined && d.zLabel === undefined) { // Traces like heatmaps generate the zLabel in their hoverPoints function
+    // Traces like heatmaps generate the zLabel in their hoverPoints function
+    if(d.zLabelVal !== undefined && d.zLabel === undefined) {
         d.zLabel = String(d.zLabelVal);
     }
 

src/traces/contour/attributes.js

@@ -30,6 +30,7 @@ module.exports = extendFlat({
     transpose: heatmapAttrs.transpose,
     xtype: heatmapAttrs.xtype,
     ytype: heatmapAttrs.ytype,
+    zhoverformat: heatmapAttrs.zhoverformat,
 
     connectgaps: heatmapAttrs.connectgaps,
 

src/traces/contour/defaults.js

@@ -34,4 +34,8 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
 
     handleContoursDefaults(traceIn, traceOut, coerce);
     handleStyleDefaults(traceIn, traceOut, coerce, layout);
+
+    coerce('zhoverformat');
+    // Needed for formatting of hoverlabel if format is not explicitly specified
+    traceOut._separators = layout.separators;
 };

src/traces/heatmap/hover.js

@@ -27,8 +27,7 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode, contour)
         y = cd0.y,
         z = cd0.z,
         zmask = cd0.zmask,
-        zmin = trace.zmin,
-        zmax = trace.zmax,
+        range = [trace.zmin, trace.zmax],
         zhoverformat = trace.zhoverformat,
         _separators = trace._separators,
         x2 = x,
@@ -105,9 +104,10 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode, contour)
     }
 
     var zLabel;
-    var dummyAx = { // dummy axis for formatting the z value
+    // dummy axis for formatting the z value
+    var dummyAx = {
         type: 'linear',
-        range: [zmin, zmax],
+        range: range,
         hoverformat: zhoverformat,
         _separators: _separators
     };

test/jasmine/tests/heatmap_test.js

@@ -616,11 +616,10 @@ describe('heatmap hover', function() {
         return hoverData;
     }
 
-    function assertLabels(hoverPoint, xLabelVal, yLabelVal, zLabelVal, zLabel, text) {
-        expect(hoverPoint.xLabelVal).toEqual(xLabelVal, 'have correct x label value');
-        expect(hoverPoint.yLabelVal).toEqual(yLabelVal, 'have correct y label value');
-        expect(hoverPoint.zLabelVal).toEqual(zLabelVal, 'have correct z label value');
-        expect(hoverPoint.zLabel).toEqual(zLabel, 'have correct z label');
+    function assertLabels(hoverPoint, xLabel, yLabel, zLabel, text) {
+        expect(hoverPoint.xLabelVal).toEqual(xLabel, 'have correct x label');
+        expect(hoverPoint.yLabelVal).toEqual(yLabel, 'have correct y label');
+        expect(hoverPoint.zLabelVal).toEqual(zLabel, 'have correct z label');
         expect(hoverPoint.text).toEqual(text, 'have correct text label');
     }
 
@@ -641,14 +640,14 @@ describe('heatmap hover', function() {
             var pt = _hover(gd, 0.5, 0.5)[0];
 
             expect(pt.index).toEqual([1, 0], 'have correct index');
-            assertLabels(pt, 1, 1, 4, '4');
+            assertLabels(pt, 1, 1, 4);
         });
 
         it('should find closest point (case 2) and should', function() {
             var pt = _hover(gd, 1.5, 0.5)[0];
 
             expect(pt.index).toEqual([0, 0], 'have correct index');
-            assertLabels(pt, 2, 0.2, 6, '6');
+            assertLabels(pt, 2, 0.2, 6);
         });
     });
 
@@ -674,47 +673,13 @@ describe('heatmap hover', function() {
             var pt = _hover(gd, 0.5, 0.5)[0];
 
             expect(pt.index).toEqual([0, 0], 'have correct index');
-            assertLabels(pt, 1, 1, 10, '10', 'a');
+            assertLabels(pt, 1, 1, 10, 'a');
 
             Plotly.relayout(gd, 'xaxis.range', [1, 2]).then(function() {
                 var pt2 = _hover(gd, 1.5, 0.5)[0];
 
                 expect(pt2.index).toEqual([0, 1], 'have correct index');
-                assertLabels(pt2, 2, 1, 4, '4', 'b');
-            })
-            .then(done);
-        });
-
-    });
-
-    describe('for hovering with specific number format', function() {
-
-        beforeAll(function(done) {
-            gd = createGraphDiv();
-
-            Plotly.plot(gd, [{
-                type: 'heatmap',
-                x: [1, 2, 3],
-                y: [1, 1, 1],
-                z: [0.123456789, 2.9999, 4],
-                zhoverformat: '.2f'
-            }])
-            .then(done);
-        });
-
-        afterAll(destroyGraphDiv);
-
-        it('should find closest point and should', function(done) {
-            var pt = _hover(gd, 0.5, 0.5)[0];
-
-            expect(pt.index).toEqual([0, 0], 'have correct index');
-            assertLabels(pt, 1, 1, 0.123456789, '0.12');
-
-            Plotly.relayout(gd, 'xaxis.range', [1, 2]).then(function() {
-                var pt2 = _hover(gd, 1.5, 0.5)[0];
-
-                expect(pt2.index).toEqual([0, 1], 'have correct index');
-                assertLabels(pt2, 2, 1, 2.9999, '3.00');
+                assertLabels(pt2, 2, 1, 4, 'b');
             })
             .then(done);
         });