coerce hovertemplate at trace-level, starting with scatter(gl)

Author: antoinerg

src/components/fx/hover.js

@@ -765,11 +765,13 @@ function createHoverText(hoverData, opts, gd) {
             if(allHaveZ && hoverData[i].zLabel === undefined) allHaveZ = false;
 
             traceHoverinfo = hoverData[i].hoverinfo || hoverData[i].trace.hoverinfo;
-            var parts = Array.isArray(traceHoverinfo) ? traceHoverinfo : traceHoverinfo.split('+');
-            if(parts.indexOf('all') === -1 &&
-                parts.indexOf(hovermode) === -1) {
-                showCommonLabel = false;
-                break;
+            if(traceHoverinfo) {
+                var parts = Array.isArray(traceHoverinfo) ? traceHoverinfo : traceHoverinfo.split('+');
+                if(parts.indexOf('all') === -1 &&
+                    parts.indexOf(hovermode) === -1) {
+                    showCommonLabel = false;
+                    break;
+                }
             }
         }
 
@@ -953,7 +955,8 @@ function createHoverText(hoverData, opts, gd) {
         }
 
         // hovertemplate
-        var trace = d.trace, hovertemplate = opts.hovertemplate || trace.hovertemplate || false;
+        var trace = d.trace;
+        var hovertemplate = opts.hovertemplate || hoverData[curveNumber].hovertemplate || false;
         if(hovertemplate) {
             text = Lib.hovertemplateString(hovertemplate, d, gd._hoverdata[curveNumber], trace);
         }
@@ -1356,7 +1359,7 @@ function cleanPoint(d, hovermode) {
 
     var infomode = d.hoverinfo || d.trace.hoverinfo;
 
-    if(infomode !== 'all') {
+    if(infomode && infomode !== 'all') {
         infomode = Array.isArray(infomode) ? infomode : infomode.split('+');
         if(infomode.indexOf('x') === -1) d.xLabel = undefined;
         if(infomode.indexOf('y') === -1) d.yLabel = undefined;

src/plots/plots.js

@@ -1170,8 +1170,6 @@ plots.supplyTraceDefaults = function(traceIn, traceOut, colorIndex, layout, trac
             if(!traceOut.hovertemplate) Lib.coerceHoverinfo(traceIn, traceOut, layout);
         }
 
-        coerce('hovertemplate');
-
         if(!Registry.traceIs(traceOut, 'noOpacity')) coerce('opacity');
 
         if(Registry.traceIs(traceOut, 'notLegendIsolatable')) {

src/traces/scatter/attributes.js

@@ -8,6 +8,7 @@
 
 'use strict';
 
+var plotAttrs = require('../../plots/attributes');
 var colorAttributes = require('../../components/colorscale/attributes');
 var colorbarAttrs = require('../../components/colorbar/attributes');
 var fontAttrs = require('../../plots/font_attributes');
@@ -203,6 +204,7 @@ module.exports = {
             'or text, then the default is *fills*, otherwise it is *points*.'
         ].join(' ')
     },
+    hovertemplate: extendFlat({}, plotAttrs.hovertemplate),
     line: {
         color: {
             valType: 'color',

src/traces/scatter/defaults.js

@@ -38,6 +38,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         'lines+markers' : 'lines';
     coerce('text');
     coerce('hovertext');
+    coerce('hovertemplate');
     coerce('mode', defaultMode);
 
     if(subTypes.hasLines(traceOut)) {

src/traces/scatter/hover.js

@@ -93,7 +93,8 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
                 y1: yc + rad,
                 yLabelVal: yLabelVal,
 
-                spikeDistance: dxy(di)
+                spikeDistance: dxy(di),
+                hovertemplate: trace.hovertemplate
             });
 
             fillHoverText(di, trace, pointData);
@@ -177,7 +178,8 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
                 x1: xmax,
                 y0: yAvg,
                 y1: yAvg,
-                color: color
+                color: color,
+                hovertemplate: '%{name}'
             });
 
             delete pointData.index;

src/traces/scattergl/attributes.js

@@ -97,3 +97,4 @@ var attrs = module.exports = overrideAll({
 }, 'calc', 'nested');
 
 attrs.x.editType = attrs.y.editType = attrs.x0.editType = attrs.y0.editType = 'calc+clearAxisTypes';
+attrs.hovertemplate = extendFlat({}, plotAttrs.hovertemplate);

src/traces/scattergl/defaults.js

@@ -37,6 +37,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
 
     coerce('text');
     coerce('hovertext');
+    coerce('hovertemplate');
     coerce('mode', defaultMode);
 
     if(subTypes.hasLines(traceOut)) {

src/traces/scattergl/index.js

@@ -830,7 +830,9 @@ function calcHover(pointData, x, y, trace) {
 
         cd: fakeCd,
         distance: minDist,
-        spikeDistance: dxy
+        spikeDistance: dxy,
+
+        hovertemplate: trace.hovertemplate
     });
 
     if(di.htx) pointData.text = di.htx;

test/jasmine/tests/hover_label_test.js

@@ -1572,6 +1572,7 @@ describe('hover info', function() {
 
                 assertHoverLabelContent({
                     nums: '$1.00',
+                    name: 'PV learning ...',
                     axis: '0.388'
                 });
             })