implement hoverinfo 'none' and 'skip' in sankey

Author: antoinerg

src/traces/sankey/plot.js

@@ -132,10 +132,13 @@ module.exports = function plot(gd, calcData) {
     var linkHover = function(element, d, sankey) {
         if(gd._fullLayout.hovermode === false) return;
         d3.select(element).call(linkHoveredStyle.bind(0, d, sankey, true));
-        gd.emit('plotly_hover', {
-            event: d3.event,
-            points: [d.link]
-        });
+        if(d.link.trace.hoverinfo !== 'skip') {
+            gd.emit('plotly_hover', {
+                event: d3.event,
+                points: [d.link]
+            });
+        }
+
     };
 
     var sourceLabel = _(gd, 'source:') + ' ';
@@ -146,6 +149,7 @@ module.exports = function plot(gd, calcData) {
     var linkHoverFollow = function(element, d) {
         if(gd._fullLayout.hovermode === false) return;
         var trace = d.link.trace;
+        if(trace.hoverinfo === 'none' || trace.hoverinfo === 'skip') return;
         var rootBBox = gd._fullLayout._paperdiv.node().getBoundingClientRect();
         var boundingBox = element.getBoundingClientRect();
         var hoverCenterX = boundingBox.left + boundingBox.width / 2;
@@ -179,10 +183,12 @@ module.exports = function plot(gd, calcData) {
     var linkUnhover = function(element, d, sankey) {
         if(gd._fullLayout.hovermode === false) return;
         d3.select(element).call(linkNonHoveredStyle.bind(0, d, sankey, true));
-        gd.emit('plotly_unhover', {
-            event: d3.event,
-            points: [d.link]
-        });
+        if(d.link.trace.hoverinfo !== 'skip') {
+            gd.emit('plotly_unhover', {
+                event: d3.event,
+                points: [d.link]
+            });
+        }
 
         Fx.loneUnhover(fullLayout._hoverlayer.node());
     };
@@ -198,15 +204,19 @@ module.exports = function plot(gd, calcData) {
     var nodeHover = function(element, d, sankey) {
         if(gd._fullLayout.hovermode === false) return;
         d3.select(element).call(nodeHoveredStyle, d, sankey);
-        gd.emit('plotly_hover', {
-            event: d3.event,
-            points: [d.node]
-        });
+        if(d.node.trace.hoverinfo !== 'skip') {
+            gd.emit('plotly_hover', {
+                event: d3.event,
+                points: [d.node]
+            });
+        }
     };
 
     var nodeHoverFollow = function(element, d) {
         if(gd._fullLayout.hovermode === false) return;
+
         var trace = d.node.trace;
+        if(trace.hoverinfo === 'none' || trace.hoverinfo === 'skip') return;
         var nodeRect = d3.select(element).select('.' + cn.nodeRect);
         var rootBBox = gd._fullLayout._paperdiv.node().getBoundingClientRect();
         var boundingBox = nodeRect.node().getBoundingClientRect();
@@ -243,10 +253,12 @@ module.exports = function plot(gd, calcData) {
     var nodeUnhover = function(element, d, sankey) {
         if(gd._fullLayout.hovermode === false) return;
         d3.select(element).call(nodeNonHoveredStyle, d, sankey);
-        gd.emit('plotly_unhover', {
-            event: d3.event,
-            points: [d.node]
-        });
+        if(d.node.trace.hoverinfo !== 'skip') {
+            gd.emit('plotly_unhover', {
+                event: d3.event,
+                points: [d.node]
+            });
+        }
 
         Fx.loneUnhover(fullLayout._hoverlayer.node());
     };

test/jasmine/tests/sankey_test.js

@@ -492,6 +492,38 @@ describe('sankey tests', function() {
             .catch(failTest)
             .then(done);
         });
+
+        it('should not show labels if hoverinfo is none', function(done) {
+            var gd = createGraphDiv();
+            var mockCopy = Lib.extendDeep({}, mock);
+
+            Plotly.plot(gd, mockCopy).then(function() {
+                return Plotly.restyle(gd, 'hoverinfo', 'none');
+            })
+            .then(function() {
+                _hover(404, 302);
+
+                assertNoLabel();
+            })
+            .catch(failTest)
+            .then(done);
+        });
+
+        it('should not show labels if hoverinfo is skip', function(done) {
+            var gd = createGraphDiv();
+            var mockCopy = Lib.extendDeep({}, mock);
+
+            Plotly.plot(gd, mockCopy).then(function() {
+                return Plotly.restyle(gd, 'hoverinfo', 'skip');
+            })
+            .then(function() {
+                _hover(404, 302);
+
+                assertNoLabel();
+            })
+            .catch(failTest)
+            .then(done);
+        });
     });
 
     describe('Test hover/click event data:', function() {
@@ -574,6 +606,7 @@ describe('sankey tests', function() {
             var fig = Lib.extendDeep({}, mock);
 
             Plotly.plot(gd, fig)
+            .then(function() { return Plotly.restyle(gd, 'hoverinfo', 'none'); })
             .then(function() { return _hover('node'); })
             .then(function(d) {
                 _assert(d, {
@@ -610,11 +643,8 @@ describe('sankey tests', function() {
             .then(done);
         });
 
-        it('should not output hover/unhover event data when hovermoder is false', function(done) {
-            var fig = Lib.extendDeep({}, mock);
-
-            Plotly.plot(gd, fig)
-            .then(function() { return Plotly.relayout(gd, 'hovermode', false); })
+        function assertNoHoverEvents() {
+            return Promise.resolve()
             .then(function() { return _hover('node'); })
             .then(failTest).catch(function(err) {
                 expect(err).toBe('plotly_hover did not get called!');
@@ -630,7 +660,26 @@ describe('sankey tests', function() {
             .then(function() { return _unhover('link'); })
             .then(failTest).catch(function(err) {
                 expect(err).toBe('plotly_unhover did not get called!');
-            })
+            });
+        }
+
+        it('should not output hover/unhover event data when hovermoder is false', function(done) {
+            var fig = Lib.extendDeep({}, mock);
+
+            Plotly.plot(gd, fig)
+            .then(function() { return Plotly.relayout(gd, 'hovermode', false); })
+            .then(assertNoHoverEvents)
+            .catch(failTest)
+            .then(done);
+        });
+
+        it('should not output hover/unhover event data when hoverinfo is skip', function(done) {
+            var fig = Lib.extendDeep({}, mock);
+
+            Plotly.plot(gd, fig)
+            .then(function() { return Plotly.restyle(gd, 'hoverinfo', 'skip'); })
+            .then(assertNoHoverEvents)
+            .catch(failTest)
             .then(done);
         });
     });