Merge pull request #3553 from plotly/more-hovertext

Add 'hovertext' attribute to all traces that support hover 'text'

Author: etpinard

src/traces/barpolar/attributes.js

@@ -58,7 +58,9 @@ module.exports = {
             'this trace\'s coordinates.'
         ].join(' ')
     }),
-    // hovertext: barAttrs.hovertext,
+    hovertext: extendFlat({}, barAttrs.hovertext, {
+        description: 'Same as `text`.'
+    }),
 
     // textposition: {},
     // textfont: {},

src/traces/barpolar/defaults.js

@@ -33,8 +33,8 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('width');
 
     coerce('text');
+    coerce('hovertext');
     coerce('hovertemplate');
-    // coerce('hovertext');
 
     // var textPosition = coerce('textposition');
     // var hasBoth = Array.isArray(textPosition) || textPosition === 'auto';

src/traces/box/attributes.js

@@ -73,6 +73,9 @@ module.exports = {
             'To be seen, trace `hoverinfo` must contain a *text* flag.'
         ].join(' ')
     }),
+    hovertext: extendFlat({}, scatterAttrs.hovertext, {
+        description: 'Same as `text`.'
+    }),
     whiskerwidth: {
         valType: 'number',
         min: 0,

src/traces/box/calc.js

@@ -212,7 +212,8 @@ function initNestedArray(len) {
 
 function arraysToCalcdata(pt, trace, i) {
     var trace2calc = {
-        text: 'tx'
+        text: 'tx',
+        hovertext: 'htx'
     };
 
     for(var k in trace2calc) {

src/traces/box/defaults.js

@@ -100,6 +100,7 @@ function handlePointsDefaults(traceIn, traceOut, coerce, opts) {
         coerce('unselected.marker.size');
 
         coerce('text');
+        coerce('hovertext');
     } else {
         delete traceOut.marker;
     }

src/traces/candlestick/attributes.js

@@ -50,6 +50,7 @@ module.exports = {
     decreasing: directionAttrs(OHLCattrs.decreasing.line.color.dflt),
 
     text: OHLCattrs.text,
+    hovertext: OHLCattrs.hovertext,
     whiskerwidth: extendFlat({}, boxAttrs.whiskerwidth, { dflt: 0 }),
 
     hoverlabel: OHLCattrs.hoverlabel,

src/traces/candlestick/defaults.js

@@ -31,6 +31,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     handleDirection(traceIn, traceOut, coerce, 'decreasing');
 
     coerce('text');
+    coerce('hovertext');
     coerce('whiskerwidth');
 
     layout._requestRangeslider[traceOut.xaxis] = true;

src/traces/choropleth/attributes.js

@@ -36,6 +36,9 @@ module.exports = extendFlat({
     text: extendFlat({}, scatterGeoAttrs.text, {
         description: 'Sets the text elements associated with each location.'
     }),
+    hovertext: extendFlat({}, scatterGeoAttrs.hovertext, {
+        description: 'Same as `text`.'
+    }),
     marker: {
         line: {
             color: scatterGeoMarkerLineAttrs.color,

src/traces/choropleth/defaults.js

@@ -30,6 +30,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('locationmode');
 
     coerce('text');
+    coerce('hovertext');
     coerce('hovertemplate');
 
     coerce('marker.line.color');

src/traces/cone/attributes.js

@@ -159,6 +159,14 @@ var attrs = {
             'these elements will be seen in the hover labels.'
         ].join(' ')
     },
+    hovertext: {
+        valType: 'string',
+        role: 'info',
+        dflt: '',
+        arrayOk: true,
+        editType: 'calc',
+        description: 'Same as `text`.'
+    },
     hovertemplate: hovertemplateAttrs({editType: 'calc'}, {keys: ['norm']})
 };
 

src/traces/cone/convert.js

@@ -40,7 +40,7 @@ proto.handlePick = function(selection) {
             Math.sqrt(uu * uu + vv * vv + ww * ww)
         ];
 
-        var text = this.data.text;
+        var text = this.data.hovertext || this.data.text;
         if(Array.isArray(text) && text[selectIndex] !== undefined) {
             selection.textLabel = text[selectIndex];
         } else if(text) {

src/traces/cone/defaults.js

@@ -52,6 +52,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     colorscaleDefaults(traceIn, traceOut, layout, coerce, {prefix: '', cLetter: 'c'});
 
     coerce('text');
+    coerce('hovertext');
     coerce('hovertemplate');
 
     // disable 1D transforms (for now)

src/traces/contour/attributes.js

@@ -31,6 +31,7 @@ module.exports = extendFlat({
     y0: heatmapAttrs.y0,
     dy: heatmapAttrs.dy,
     text: heatmapAttrs.text,
+    hovertext: heatmapAttrs.hovertext,
     transpose: heatmapAttrs.transpose,
     xtype: heatmapAttrs.xtype,
     ytype: heatmapAttrs.ytype,

src/traces/contour/defaults.js

@@ -33,6 +33,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     coerce('text');
+    coerce('hovertext');
     coerce('hovertemplate');
 
     var isConstraint = (coerce('contours.type') === 'constraint');

src/traces/contourcarpet/attributes.js

@@ -36,6 +36,7 @@ module.exports = extendFlat({
     b0: heatmapAttrs.y0,
     db: heatmapAttrs.dy,
     text: heatmapAttrs.text,
+    hovertext: heatmapAttrs.hovertext,
     transpose: heatmapAttrs.transpose,
     atype: heatmapAttrs.xtype,
     btype: heatmapAttrs.ytype,

src/traces/heatmap/attributes.js

@@ -33,6 +33,11 @@ module.exports = extendFlat({
         editType: 'calc',
         description: 'Sets the text elements associated with each z value.'
     },
+    hovertext: {
+        valType: 'data_array',
+        editType: 'calc',
+        description: 'Same as `text`.'
+    },
     transpose: {
         valType: 'boolean',
         dflt: false,

src/traces/heatmap/calc.js

@@ -131,7 +131,8 @@ module.exports = function calc(gd, trace) {
         x: xArray,
         y: yArray,
         z: z,
-        text: trace._text || trace.text
+        text: trace._text || trace.text,
+        hovertext: trace._hovertext || trace.hovertext
     };
 
     if(xIn && xIn.length === xArray.length - 1) cd0.xCenter = xIn;

src/traces/heatmap/convert_column_xyz.js

@@ -18,6 +18,8 @@ module.exports = function convertColumnData(trace, ax1, ax2, var1Name, var2Name,
     var col2 = ax2.makeCalcdata(trace, var2Name);
     var textCol = trace.text;
     var hasColumnText = (textCol !== undefined && Lib.isArray1D(textCol));
+    var hoverTextCol = trace.hovertext;
+    var hasColumnHoverText = (hoverTextCol !== undefined && Lib.isArray1D(hoverTextCol));
     var i, j;
 
     var col1dv = Lib.distinctVals(col1);
@@ -26,6 +28,7 @@ module.exports = function convertColumnData(trace, ax1, ax2, var1Name, var2Name,
     var col2vals = col2dv.vals;
     var newArrays = [];
     var text;
+    var hovertext;
 
     for(i = 0; i < arrayVarNames.length; i++) {
         newArrays[i] = Lib.init2dArray(col2vals.length, col1vals.length);
@@ -34,6 +37,9 @@ module.exports = function convertColumnData(trace, ax1, ax2, var1Name, var2Name,
     if(hasColumnText) {
         text = Lib.init2dArray(col2vals.length, col1vals.length);
     }
+    if(hasColumnHoverText) {
+        hovertext = Lib.init2dArray(col2vals.length, col1vals.length);
+    }
 
     for(i = 0; i < colLen; i++) {
         if(col1[i] !== BADNUM && col2[i] !== BADNUM) {
@@ -48,6 +54,7 @@ module.exports = function convertColumnData(trace, ax1, ax2, var1Name, var2Name,
             }
 
             if(hasColumnText) text[i2][i1] = textCol[i];
+            if(hasColumnHoverText) hovertext[i2][i1] = hoverTextCol[i];
         }
     }
 
@@ -57,4 +64,5 @@ module.exports = function convertColumnData(trace, ax1, ax2, var1Name, var2Name,
         trace['_' + arrayVarNames[j]] = newArrays[j];
     }
     if(hasColumnText) trace._text = text;
+    if(hasColumnHoverText) trace._hovertext = hovertext;
 };

src/traces/heatmap/defaults.js

@@ -29,6 +29,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     coerce('text');
+    coerce('hovertext');
     coerce('hovertemplate');
 
     handleStyleDefaults(traceIn, traceOut, coerce, layout);

src/traces/heatmap/hover.js

@@ -93,7 +93,9 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode, hoverLay
     if(zmask && !zmask[ny][nx]) zVal = undefined;
 
     var text;
-    if(Array.isArray(cd0.text) && Array.isArray(cd0.text[ny])) {
+    if(Array.isArray(cd0.hovertext) && Array.isArray(cd0.hovertext[ny])) {
+        text = cd0.hovertext[ny][nx];
+    } else if(Array.isArray(cd0.text) && Array.isArray(cd0.text[ny])) {
         text = cd0.text[ny][nx];
     }
 

src/traces/histogram/attributes.js

@@ -12,6 +12,7 @@ var barAttrs = require('../bar/attributes');
 var hovertemplateAttrs = require('../../components/fx/hovertemplate_attributes');
 var makeBinAttrs = require('./bin_attributes');
 var constants = require('./constants');
+var extendFlat = require('../../lib/extend').extendFlat;
 
 module.exports = {
     x: {
@@ -29,7 +30,17 @@ module.exports = {
         ].join(' ')
     },
 
-    text: barAttrs.text,
+    text: extendFlat({}, barAttrs.text, {
+        description: [
+            'Sets hover text elements associated with each bar.',
+            'If a single string, the same string appears over all bars.',
+            'If an array of string, the items are mapped in order to the',
+            'this trace\'s coordinates.'
+        ].join(' ')
+    }),
+    hovertext: extendFlat({}, barAttrs.hovertext, {
+        description: 'Same as `text`.'
+    }),
     orientation: barAttrs.orientation,
 
     histfunc: {

src/traces/histogram/defaults.js

@@ -30,6 +30,8 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     coerce('text');
+    coerce('hovertext');
+    coerce('hovertemplate');
 
     var orientation = coerce('orientation', (y && !x) ? 'h' : 'v');
     var sampleLetter = orientation === 'v' ? 'x' : 'y';
@@ -57,8 +59,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     // autobin(x|y) are only included here to appease Plotly.validate
     coerce('autobin' + sampleLetter);
 
-    coerce('hovertemplate');
-
     handleStyleDefaults(traceIn, traceOut, coerce, defaultColor, layout);
 
     Lib.coerceSelectionMarkerOpacity(traceOut, coerce);

src/traces/isosurface/attributes.js

@@ -226,6 +226,13 @@ var attrs = module.exports = overrideAll(extendFlat({
             'these elements will be seen in the hover labels.'
         ].join(' ')
     },
+    hovertext: {
+        valType: 'string',
+        role: 'info',
+        dflt: '',
+        arrayOk: true,
+        description: 'Same as `text`.'
+    },
     hovertemplate: hovertemplateAttrs()
 },
 

src/traces/isosurface/convert.js

@@ -73,7 +73,7 @@ proto.handlePick = function(selection) {
             this.data.value[selectIndex]
         ];
 
-        var text = this.data.text;
+        var text = this.data.hovertext || this.data.text;
         if(Array.isArray(text) && text[selectIndex] !== undefined) {
             selection.textLabel = text[selectIndex];
         } else if(text) {

src/traces/isosurface/defaults.js

@@ -84,6 +84,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     // Coerce remaining properties
     [
         'text',
+        'hovertext',
         'hovertemplate',
         'lighting.ambient',
         'lighting.diffuse',

src/traces/mesh3d/attributes.js

@@ -90,6 +90,14 @@ module.exports = extendFlat({
             'these elements will be seen in the hover labels.'
         ].join(' ')
     },
+    hovertext: {
+        valType: 'string',
+        role: 'info',
+        dflt: '',
+        arrayOk: true,
+        editType: 'calc',
+        description: 'Same as `text`.'
+    },
     hovertemplate: hovertemplateAttrs({editType: 'calc'}),
 
     delaunayaxis: {

src/traces/mesh3d/convert.js

@@ -40,7 +40,7 @@ proto.handlePick = function(selection) {
             this.data.z[selectIndex]
         ];
 
-        var text = this.data.text;
+        var text = this.data.hovertext || this.data.text;
         if(Array.isArray(text) && text[selectIndex] !== undefined) {
             selection.textLabel = text[selectIndex];
         } else if(text) {

src/traces/mesh3d/defaults.js

@@ -88,6 +88,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     coerce('text');
+    coerce('hovertext');
     coerce('hovertemplate');
 
     // disable 1D transforms

src/traces/ohlc/attributes.js

@@ -104,6 +104,14 @@ module.exports = {
             'this trace\'s sample points.'
         ].join(' ')
     },
+    hovertext: {
+        valType: 'string',
+        role: 'info',
+        dflt: '',
+        arrayOk: true,
+        editType: 'calc',
+        description: 'Same as `text`.'
+    },
 
     tickwidth: {
         valType: 'number',

src/traces/ohlc/calc.js

@@ -56,6 +56,7 @@ function calcCommon(gd, trace, x, ya, ptFunc) {
     var c = ya.makeCalcdata(trace, 'close');
 
     var hasTextArray = Array.isArray(trace.text);
+    var hasHovertextArray = Array.isArray(trace.hovertext);
 
     // we're optimists - before we have any changing data, assume increasing
     var increasing = true;
@@ -87,6 +88,7 @@ function calcCommon(gd, trace, x, ya, ptFunc) {
             pt.dir = increasing ? 'increasing' : 'decreasing';
 
             if(hasTextArray) pt.tx = trace.text[i];
+            if(hasHovertextArray) pt.htx = trace.hovertext[i];
 
             cd.push(pt);
         } else {

src/traces/ohlc/defaults.js

@@ -31,6 +31,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     handleDirection(traceIn, traceOut, coerce, 'decreasing');
 
     coerce('text');
+    coerce('hovertext');
     coerce('tickwidth');
 
     layout._requestRangeslider[traceOut.xaxis] = true;