add Lib.coerceHoverinfo shortcut

- which handles the 1-vs-multi-trace dflt logic for all
  trace types
- call it once (!) during defaults
- call it again during fx/calc to coerce arrayOk hoverinfo items

Author: etpinard

src/components/fx/calc.js

@@ -10,31 +10,14 @@
 
 var Lib = require('../../lib');
 var Registry = require('../../registry');
-var baseAttrs = require('../../plots/attributes');
 
 module.exports = function calc(gd) {
     var calcdata = gd.calcdata;
     var fullLayout = gd._fullLayout;
 
-    function makeCoerceHoverInfo(fullTrace) {
-        var moduleAttrs = fullTrace._module.attributes;
-        var attrs = moduleAttrs.hoverinfo ?
-            {hoverinfo: moduleAttrs.hoverinfo} :
-            baseAttrs;
-        var valObj = attrs.hoverinfo;
-        var dflt;
-
-        if(fullLayout._dataLength === 1) {
-            var flags = valObj.dflt === 'all' ?
-                valObj.flags.slice() :
-                valObj.dflt.split('+');
-
-            flags.splice(flags.indexOf('name'), 1);
-            dflt = flags.join('+');
-        }
-
+    function makeCoerceHoverInfo(trace) {
         return function(val) {
-            return Lib.coerce({hoverinfo: val}, {}, attrs, 'hoverinfo', dflt);
+            return Lib.coerceHoverinfo({hoverinfo: val}, {_module: trace._module}, fullLayout);
         };
     }
 

src/lib/coerce.js

@@ -12,6 +12,7 @@
 var isNumeric = require('fast-isnumeric');
 var tinycolor = require('tinycolor2');
 
+var baseTraceAttrs = require('../plots/attributes');
 var getColorscale = require('../components/colorscale/get_scale');
 var colorscaleNames = Object.keys(require('../components/colorscale/scales'));
 var nestedProperty = require('./nested_property');
@@ -338,6 +339,35 @@ exports.coerceFont = function(coerce, attr, dfltObj) {
     return out;
 };
 
+/** Coerce shortcut for 'hoverinfo'
+ * handling 1-vs-multi-trace dflt logic
+ *
+ * @param {object} traceIn : user trace object
+ * @param {object} traceOut : full trace object (requires _module ref)
+ * @param {object} layoutOut : full layout object (require _dataLength ref)
+ * @return {any} : the coerced value
+ */
+exports.coerceHoverinfo = function(traceIn, traceOut, layoutOut) {
+    var moduleAttrs = traceOut._module.attributes;
+    var attrs = moduleAttrs.hoverinfo ?
+        {hoverinfo: moduleAttrs.hoverinfo} :
+        baseTraceAttrs;
+
+    var valObj = attrs.hoverinfo;
+    var dflt;
+
+    if(layoutOut._dataLength === 1) {
+        var flags = valObj.dflt === 'all' ?
+            valObj.flags.slice() :
+            valObj.dflt.split('+');
+
+        flags.splice(flags.indexOf('name'), 1);
+        dflt = flags.join('+');
+    }
+
+    return exports.coerce(traceIn, traceOut, attrs, 'hoverinfo', dflt);
+};
+
 exports.validate = function(value, opts) {
     var valObject = exports.valObjects[opts.valType];
 

src/lib/index.js

@@ -31,6 +31,7 @@ lib.valObjects = coerceModule.valObjects;
 lib.coerce = coerceModule.coerce;
 lib.coerce2 = coerceModule.coerce2;
 lib.coerceFont = coerceModule.coerceFont;
+lib.coerceHoverinfo = coerceModule.coerceHoverinfo;
 lib.validate = coerceModule.validate;
 
 var datesModule = require('./dates');
@@ -355,7 +356,6 @@ lib.noneOrAll = function(containerIn, containerOut, attrList) {
  * @param {object} cd : calcdata trace
  * @param {string} cdAttr : calcdata key
  * @param {function} [fn] : optional function to apply to each array item
- *
  */
 lib.mergeArray = function(traceAttr, cd, cdAttr, fn) {
     fn = fn || lib.identity;

src/plots/plots.js

@@ -865,9 +865,6 @@ plots.supplyTraceDefaults = function(traceIn, traceOutIndex, layout, traceInInde
         var _module = plots.getModule(traceOut);
         traceOut._module = _module;
 
-        // gets overwritten in pie, geo and ternary modules
-        coerce('hoverinfo', (layout._dataLength === 1) ? 'x+y+z+text' : undefined);
-
         if(plots.traceIs(traceOut, 'showLegend')) {
             coerce('showlegend');
             coerce('legendgroup');
@@ -880,7 +877,10 @@ plots.supplyTraceDefaults = function(traceIn, traceOutIndex, layout, traceInInde
 
         // TODO add per-base-plot-module trace defaults step
 
-        if(_module) _module.supplyDefaults(traceIn, traceOut, defaultColor, layout);
+        if(_module) {
+            _module.supplyDefaults(traceIn, traceOut, defaultColor, layout);
+            Lib.coerceHoverinfo(traceIn, traceOut, layout);
+        }
 
         if(!plots.traceIs(traceOut, 'noOpacity')) coerce('opacity');
 

src/traces/choropleth/defaults.js

@@ -48,6 +48,4 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     colorscaleDefaults(
         traceIn, traceOut, layout, coerce, {prefix: '', cLetter: 'z'}
     );
-
-    coerce('hoverinfo', (layout._dataLength === 1) ? 'location+z+text' : undefined);
 };

src/traces/pie/defaults.js

@@ -47,8 +47,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     var textInfo = coerce('textinfo', Array.isArray(textData) ? 'text+percent' : 'percent');
     coerce('hovertext');
 
-    coerce('hoverinfo', (layout._dataLength === 1) ? 'label+text+value+percent' : undefined);
-
     if(textInfo && textInfo !== 'none') {
         var textPosition = coerce('textposition'),
             hasBoth = Array.isArray(textPosition) || textPosition === 'auto',

src/traces/sankey/defaults.js

@@ -15,7 +15,6 @@ var Color = require('../../components/color');
 var tinycolor = require('tinycolor2');
 
 module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
-
     function coerce(attr, dflt) {
         return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
@@ -45,8 +44,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
             'rgba(0, 0, 0, 0.2)';
     }));
 
-    coerce('hoverinfo', layout._dataLength === 1 ? 'label+text+value+percent' : undefined);
-
     coerce('domain.x');
     coerce('domain.y');
     coerce('orientation');

src/traces/scattercarpet/defaults.js

@@ -82,8 +82,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         if(!subTypes.hasLines(traceOut)) handleLineShapeDefaults(traceIn, traceOut, coerce);
     }
 
-    coerce('hoverinfo', (layout._dataLength === 1) ? 'a+b+text' : undefined);
-
     if(traceOut.fill === 'tonext' || traceOut.fill === 'toself') {
         dfltHoverOn.push('fills');
     }

src/traces/scattergeo/defaults.js

@@ -52,8 +52,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     if(traceOut.fill !== 'none') {
         handleFillColorDefaults(traceIn, traceOut, defaultColor, coerce);
     }
-
-    coerce('hoverinfo', (layout._dataLength === 1) ? 'lon+lat+location+text' : undefined);
 };
 
 function handleLonLatLocDefaults(traceIn, traceOut, coerce) {

src/traces/scattermapbox/defaults.js

@@ -63,8 +63,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     if(traceOut.fill !== 'none') {
         handleFillColorDefaults(traceIn, traceOut, defaultColor, coerce);
     }
-
-    coerce('hoverinfo', (layout._dataLength === 1) ? 'lon+lat+text' : undefined);
 };
 
 function handleLonLatDefaults(traceIn, traceOut, coerce) {

src/traces/scatterternary/defaults.js

@@ -95,8 +95,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         if(!subTypes.hasLines(traceOut)) handleLineShapeDefaults(traceIn, traceOut, coerce);
     }
 
-    coerce('hoverinfo', (layout._dataLength === 1) ? 'a+b+c+text' : undefined);
-
     if(traceOut.fill === 'tonext' || traceOut.fill === 'toself') {
         dfltHoverOn.push('fills');
     }

test/jasmine/tests/scatterternary_test.js

@@ -1,4 +1,5 @@
 var Plotly = require('@lib');
+var Plots = require('@src/plots/plots');
 var Lib = require('@src/lib');
 var ScatterTernary = require('@src/traces/scatterternary');
 
@@ -135,28 +136,33 @@ describe('scatterternary defaults', function() {
         expect(traceOut.b).toEqual([1]);
         expect(traceOut.c).toEqual([1]);
     });
+
     it('should include \'name\' in \'hoverinfo\' default if multi trace graph', function() {
         traceIn = {
+            type: 'scatterternary',
             a: [1, 2, 3],
             b: [1, 2, 3],
             c: [1, 2, 3]
         };
-        layout._dataLength = 2;
 
-        supplyDefaults(traceIn, traceOut, defaultColor, layout);
-        expect(traceOut.hoverinfo).toBe('all');
+        var gd = {data: [traceIn, {}]};
+        Plots.supplyDefaults(gd);
+
+        expect(gd._fullData[0].hoverinfo).toBe('all');
     });
 
     it('should not include \'name\' in \'hoverinfo\' default if single trace graph', function() {
         traceIn = {
+            type: 'scatterternary',
             a: [1, 2, 3],
             b: [1, 2, 3],
             c: [1, 2, 3]
         };
-        layout._dataLength = 1;
 
-        supplyDefaults(traceIn, traceOut, defaultColor, layout);
-        expect(traceOut.hoverinfo).toBe('a+b+c+text');
+        var gd = {data: [traceIn]};
+        Plots.supplyDefaults(gd);
+
+        expect(gd._fullData[0].hoverinfo).toBe('a+b+c+text');
     });
 
     it('should correctly assign \'hoveron\' default', function() {