revise funnel hovertemplate and hoverinfo based on comments

Author: archmoj

src/components/fx/hover.js

@@ -432,9 +432,6 @@ function _hover(gd, evt, subplot, noHoverEvent) {
             xLabelVal: undefined,
             yLabelVal: undefined,
             zLabelVal: undefined,
-            percentInitial: undefined,
-            percentPrevious: undefined,
-            percentTotal: undefined,
             text: undefined
         };
 
@@ -911,16 +908,6 @@ function createHoverText(hoverData, opts, gd) {
             text += (text ? '<br>' : '') + d.text;
         }
 
-        if(d.percentInitial !== undefined) {
-            text += (text ? '<br>' : '') + d.percentInitial + ' of initial';
-        }
-        if(d.percentPrevious !== undefined) {
-            text += (text ? '<br>' : '') + d.percentPrevious + ' of previous';
-        }
-        if(d.percentTotal !== undefined) {
-            text += (text ? '<br>' : '') + d.percentTotal + ' of total';
-        }
-
         // used by other modules (initially just ternary) that
         // manage their own hoverinfo independent of cleanPoint
         // the rest of this will still apply, so such modules
@@ -1396,9 +1383,6 @@ function cleanPoint(d, hovermode) {
         if(infomode.indexOf('z') === -1) d.zLabel = undefined;
         if(infomode.indexOf('text') === -1) d.text = undefined;
         if(infomode.indexOf('name') === -1) d.name = undefined;
-        if(infomode.indexOf('percentInitial') === -1) d.percentInitial = undefined;
-        if(infomode.indexOf('percentPrevious') === -1) d.percentPrevious = undefined;
-        if(infomode.indexOf('percentTotal') === -1) d.percentTotal = undefined;
     }
 
     return d;

src/traces/funnel/attributes.js

@@ -11,6 +11,8 @@
 var barAttrs = require('../bar/attributes');
 var lineAttrs = require('../scatter/attributes').line;
 var plotAttrs = require('../../plots/attributes');
+var hovertemplateAttrs = require('../../components/fx/hovertemplate_attributes');
+var constants = require('./constants');
 var extendFlat = require('../../lib/extend').extendFlat;
 var Color = require('../../components/color');
 
@@ -23,9 +25,12 @@ module.exports = {
     dy: barAttrs.dy,
 
     hovertext: barAttrs.hovertext,
-    hovertemplate: barAttrs.hovertemplate,
+    hovertemplate: hovertemplateAttrs({}, {
+        keys: constants.eventDataKeys
+    }),
+
     hoverinfo: extendFlat({}, plotAttrs.hoverinfo, {
-        flags: ['percentInitial', 'percentPrevious', 'percentTotal'].concat(plotAttrs.hoverinfo.flags)
+        flags: ['name', 'x', 'y', 'text', 'percent initial', 'percent previous', 'percent total']
     }),
 
     textinfo: {

src/traces/funnel/constants.js

@@ -0,0 +1,17 @@
+/**
+* Copyright 2012-2019, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+module.exports = {
+    eventDataKeys: [
+        'percentInitial',
+        'percentPrevious',
+        'percentTotal'
+    ]
+};

src/traces/funnel/hover.js

@@ -27,16 +27,34 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
     var sizeLetter = isHorizontal ? 'x' : 'y';
     point[sizeLetter + 'LabelVal'] = di.s;
 
-    var hoverinfo = trace.hoverinfo;
-    if(hoverinfo !== 'none' && hoverinfo !== 'skip') {
-        var parts = (hoverinfo || '').split('+');
-        var isAll = (hoverinfo === 'all') || (hoverinfo === undefined);
+    point.percentInitial = di.begR;
+    point.percentInitialLabel = formatPercent(di.begR, 1);
+
+    point.percentPrevious = di.difR;
+    point.percentPreviousLabel = formatPercent(di.difR, 1);
+
+    point.percentTotal = di.sumR;
+    point.percentTotalLabel = formatPercent(di.sumR, 1);
+
+    var hoverinfo = di.hi || trace.hoverinfo;
+    var text = [];
+    if(hoverinfo && hoverinfo !== 'none' && hoverinfo !== 'skip') {
+        var isAll = (hoverinfo === 'all');
+        var parts = hoverinfo.split('+');
+
         var hasFlag = function(flag) { return isAll || parts.indexOf(flag) !== -1; };
 
-        if(hasFlag('percentInitial')) point.percentInitial = formatPercent(di.begR, 1);
-        if(hasFlag('percentPrevious')) point.percentPrevious = formatPercent(di.difR, 1);
-        if(hasFlag('percentTotal')) point.percentTotal = formatPercent(di.sumR, 1);
+        if(hasFlag('percent initial')) {
+            text.push(point.percentInitialLabel + ' of initial');
+        }
+        if(hasFlag('percent previous')) {
+            text.push(point.percentPreviousLabel + ' of previous');
+        }
+        if(hasFlag('percent total')) {
+            text.push(point.percentTotalLabel + ' of total');
+        }
     }
+    point.extraText = text.join('<br>');
 
     point.color = getTraceColor(trace, di);