fix sankey attributes and add better test

Author: antoinerg

src/traces/sankey/attributes.js

@@ -122,7 +122,7 @@ var attrs = module.exports = overrideAll({
             role: 'style',
             description: 'Sets the thickness (in px) of the `nodes`.'
         },
-        hoverinfo: extendFlat({}, plotAttrs.hoverinfo, {flags: []}),
+        hoverinfo: extendFlat({}, plotAttrs.hoverinfo, {valtype: 'enumerated', values: ['all', 'none', 'skip'], flags: [], arrayOk: false }),
         hoverlabel: fxAttrs.hoverlabel, // needs editType override,
         description: 'The nodes of the Sankey plot.'
     },
@@ -182,10 +182,10 @@ var attrs = module.exports = overrideAll({
             role: 'info',
             description: 'A numeric value representing the flow volume value.'
         },
-        hoverinfo: extendFlat({}, plotAttrs.hoverinfo, {flags: []}),
+        hoverinfo: extendFlat({}, plotAttrs.hoverinfo, {valtype: 'enumerated', values: ['all', 'none', 'skip'], flags: [], arrayOk: false }),
         hoverlabel: fxAttrs.hoverlabel, // needs editType override,
         description: 'The links of the Sankey plot.'
-    },
+    }
 }, 'calc', 'nested');
 // hide unsupported top-level properties from plot-schema
 attrs.hoverinfo = undefined;

src/traces/sankey/defaults.js

@@ -13,7 +13,7 @@ var attributes = require('./attributes');
 var Color = require('../../components/color');
 var tinycolor = require('tinycolor2');
 var handleDomainDefaults = require('../../plots/domain').defaults;
-var Registry = require('../../registry');
+var handleFxDefaults = require('../../components/fx/defaults');
 
 module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     function coerce(attr, dflt) {
@@ -26,10 +26,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('node.line.color');
     coerce('node.line.width');
     coerce('node.hoverinfo');
-    Registry.getComponentMethod(
-        'fx',
-        'supplyDefaults'
-    )(traceIn.node, traceOut.node, defaultColor, layout);
+    handleFxDefaults(traceIn.node, traceOut.node, defaultColor, layout);
 
     var colors = layout.colorway;
 
@@ -46,10 +43,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('link.line.color');
     coerce('link.line.width');
     coerce('link.hoverinfo');
-    Registry.getComponentMethod(
-        'fx',
-        'supplyDefaults'
-    )(traceIn.link, traceOut.link, defaultColor, layout);
+    handleFxDefaults(traceIn.link, traceOut.link, defaultColor, layout);
 
     coerce('link.color', traceOut.link.value.map(function() {
         return tinycolor(layout.paper_bgcolor).getLuminance() < 0.333 ?

test/jasmine/tests/sankey_test.js

@@ -440,10 +440,10 @@ describe('sankey tests', function() {
                     'node.hoverlabel.bordercolor': 'blue',
                     'node.hoverlabel.font.size': 20,
                     'node.hoverlabel.font.color': 'black',
-                    'link.hoverlabel.bgcolor': 'red',
-                    'link.hoverlabel.bordercolor': 'blue',
-                    'link.hoverlabel.font.size': 20,
-                    'link.hoverlabel.font.color': 'black'
+                    'link.hoverlabel.bgcolor': 'yellow',
+                    'link.hoverlabel.bordercolor': 'magenta',
+                    'link.hoverlabel.font.size': 18,
+                    'link.hoverlabel.font.color': 'green'
                 });
             })
             .then(function() {
@@ -459,7 +459,7 @@ describe('sankey tests', function() {
 
                 assertLabel(
                     ['source: Solid', 'target: Industry', '46TWh'],
-                    ['rgb(255, 0, 0)', 'rgb(0, 0, 255)', 20, 'Roboto', 'rgb(0, 0, 0)']
+                    ['rgb(255, 255, 0)', 'rgb(255, 0, 255)', 18, 'Roboto', 'rgb(0, 128, 0)']
                 );
             })
             .catch(failTest)
@@ -547,6 +547,21 @@ describe('sankey tests', function() {
             .catch(failTest)
             .then(done);
         });
+
+        it('should not show link labels if link.hoverinfo is skip', function(done) {
+            var gd = createGraphDiv();
+            var mockCopy = Lib.extendDeep({}, mock);
+
+            Plotly.plot(gd, mockCopy).then(function() {
+                return Plotly.restyle(gd, 'link.hoverinfo', 'skip');
+            })
+            .then(function() {
+                _hover(link[0], link[1]);
+                assertNoLabel();
+            })
+            .catch(failTest)
+            .then(done);
+        });
     });
 
     describe('Test hover/click event data:', function() {
@@ -667,24 +682,26 @@ describe('sankey tests', function() {
         });
 
         function assertNoHoverEvents(type) {
-            return Promise.resolve()
-            .then(function() { return _hover(type); })
-            .then(failTest).catch(function(err) {
-                expect(err).toBe('plotly_hover did not get called!');
-            })
-            .then(function() { return _unhover(type); })
-            .then(failTest).catch(function(err) {
-                expect(err).toBe('plotly_unhover did not get called!');
-            });
+            return function() {
+                return Promise.resolve()
+                .then(function() { return _hover(type); })
+                .then(failTest).catch(function(err) {
+                    expect(err).toBe('plotly_hover did not get called!');
+                })
+                .then(function() { return _unhover(type); })
+                .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(function() { return assertNoHoverEvents('node');})
-            .then(function() { return assertNoHoverEvents('link');})
+            .then(assertNoHoverEvents('node'))
+            .then(assertNoHoverEvents('link'))
             .catch(failTest)
             .then(done);
         });
@@ -694,7 +711,9 @@ describe('sankey tests', function() {
 
             Plotly.plot(gd, fig)
             .then(function() { return Plotly.restyle(gd, 'link.hoverinfo', 'skip'); })
-            .then(function() { return assertNoHoverEvents('link');})
+            .then(assertNoHoverEvents('link'))
+            .then(function() { return Plotly.restyle(gd, 'node.hoverinfo', 'skip'); })
+            .then(assertNoHoverEvents('node'))
             .catch(failTest)
             .then(done);
         });