Add 'hovertext' attribute in scatter* traces

src/traces/bar/arrays_to_calcdata.js

@@ -15,6 +15,7 @@ var mergeArray = require('../../lib').mergeArray;
 // arrayOk attributes, merge them into calcdata array
 module.exports = function arraysToCalcdata(cd, trace) {
     mergeArray(trace.text, cd, 'tx');
+    mergeArray(trace.hovertext, cd, 'htx');
 
     var marker = trace.marker;
     if(marker) {

src/traces/bar/attributes.js

@@ -49,6 +49,7 @@ module.exports = {
     dy: scatterAttrs.dy,
 
     text: scatterAttrs.text,
+    hovertext: scatterAttrs.hovertext,
 
     textposition: {
         valType: 'enumerated',

src/traces/bar/defaults.js

@@ -37,6 +37,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('width');
 
     coerce('text');
+    coerce('hovertext');
 
     var textPosition = coerce('textposition');
 

src/traces/bar/hover.js

@@ -83,7 +83,10 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
         pointData.xLabelVal = di.p;
     }
 
-    if(di.tx) pointData.text = di.tx;
+    if(di.htx) pointData.text = di.htx;
+    else if(trace.hovertext) pointData.text = trace.hovertext;
+    else if(di.tx) pointData.text = di.tx;
+    else if(trace.text) pointData.text = trace.text;
 
     ErrorBars.hoverInfo(di, trace, pointData);
 

src/traces/pie/attributes.js

@@ -79,7 +79,27 @@ module.exports = {
 
     text: {
         valType: 'data_array',
-        description: 'Sets text elements associated with each sector.'
+        description: [
+            'Sets text elements associated with each sector.',
+            'If trace `textinfo` contains a *text* flag, these elements will seen',
+            'on the chart.',
+            'If trace `hoverinfo` contains a *text* flag and *hovertext* is not set,',
+            'these elements will be seen in the hover labels.'
+        ].join(' ')
+    },
+    hovertext: {
+        valType: 'string',
+        role: 'info',
+        dflt: '',
+        arrayOk: true,
+        description: [
+            'Sets hover text elements associated with each sector.',
+            'If a single string, the same string appears for',
+            'all data points.',
+            'If an array of string, the items are mapped in order of',
+            'this trace\'s sectors.',
+            'To be seen, trace `hoverinfo` must contain a *text* flag.'
+        ].join(' ')
     },
 
 // 'see eg:'

src/traces/pie/defaults.js

@@ -45,6 +45,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
 
     var textData = coerce('text');
     var textInfo = coerce('textinfo', Array.isArray(textData) ? 'text+percent' : 'percent');
+    coerce('hovertext');
 
     coerce('hoverinfo', (layout._dataLength === 1) ? 'label+text+value+percent' : undefined);
 

src/traces/pie/plot.js

@@ -110,8 +110,16 @@ module.exports = function plot(gd, cdpie) {
                         thisText = [];
 
                     if(hoverinfo.indexOf('label') !== -1) thisText.push(pt.label);
-                    if(trace2.text && trace2.text[pt.i] && hoverinfo.indexOf('text') !== -1) {
-                        thisText.push(trace2.text[pt.i]);
+                    if(hoverinfo.indexOf('text') !== -1) {
+                        if(trace2.hovertext) {
+                            thisText.push(
+                                Array.isArray(trace2.hovertext) ?
+                                    trace2.hovertext[pt.i] :
+                                    trace2.hovertext
+                            );
+                        } else if(trace2.text && trace2.text[pt.i]) {
+                            thisText.push(trace2.text[pt.i]);
+                        }
                     }
                     if(hoverinfo.indexOf('value') !== -1) thisText.push(helpers.formatPieValue(pt.v, separators));
                     if(hoverinfo.indexOf('percent') !== -1) thisText.push(helpers.formatPiePercent(pt.v / cd0.vTotal, separators));

src/traces/scatter/arrays_to_calcdata.js

@@ -16,6 +16,7 @@ var Lib = require('../../lib');
 module.exports = function arraysToCalcdata(cd, trace) {
 
     Lib.mergeArray(trace.text, cd, 'tx');
+    Lib.mergeArray(trace.hovertext, cd, 'htx');
     Lib.mergeArray(trace.customdata, cd, 'data');
     Lib.mergeArray(trace.textposition, cd, 'tp');
     if(trace.textfont) {

src/traces/scatter/attributes.js

@@ -83,7 +83,23 @@ module.exports = {
             'If a single string, the same string appears over',
             'all the data points.',
             'If an array of string, the items are mapped in order to the',
-            'this trace\'s (x,y) coordinates.'
+            'this trace\'s (x,y) coordinates.',
+            'If trace `hoverinfo` contains a *text* flag and *hovertext* is not set,',
+            'these elements will be seen in the hover labels.'
+        ].join(' ')
+    },
+    hovertext: {
+        valType: 'string',
+        role: 'info',
+        dflt: '',
+        arrayOk: true,
+        description: [
+            'Sets hover text elements associated with each (x,y) pair.',
+            'If a single string, the same string appears over',
+            'all the data points.',
+            'If an array of string, the items are mapped in order to the',
+            'this trace\'s (x,y) coordinates.',
+            'To be seen, trace `hoverinfo` must contain a *text* flag.'
         ].join(' ')
     },
     mode: {

src/traces/scatter/defaults.js

@@ -38,6 +38,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
 
     coerce('customdata');
     coerce('text');
+    coerce('hovertext');
     coerce('mode', defaultMode);
     coerce('ids');
 

src/traces/scatter/hover.js

@@ -72,7 +72,9 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
                 yLabelVal: di.y
             });
 
-            if(di.tx) pointData.text = di.tx;
+            if(di.htx) pointData.text = di.htx;
+            else if(trace.hovertext) pointData.text = trace.hovertext;
+            else if(di.tx) pointData.text = di.tx;
             else if(trace.text) pointData.text = trace.text;
 
             ErrorBars.hoverInfo(di, trace, pointData);

src/traces/scatter3d/attributes.js

@@ -72,9 +72,22 @@ module.exports = {
             'If a single string, the same string appears over',
             'all the data points.',
             'If an array of string, the items are mapped in order to the',
-            'this trace\'s (x,y,z) coordinates.'
+            'this trace\'s (x,y,z) coordinates.',
+            'If trace `hoverinfo` contains a *text* flag and *hovertext* is not set,',
+            'these elements will be seen in the hover labels.'
         ].join(' ')
     }),
+    hovertext: extendFlat({}, scatterAttrs.hovertext, {
+        description: [
+            'Sets text elements associated with each (x,y,z) triplet.',
+            'If a single string, the same string appears over',
+            'all the data points.',
+            'If an array of string, the items are mapped in order to the',
+            'this trace\'s (x,y,z) coordinates.',
+            'To be seen, trace `hoverinfo` must contain a *text* flag.'
+        ].join(' ')
+    }),
+
     mode: extendFlat({}, scatterAttrs.mode,  // shouldn't this be on-par with 2D?
         {dflt: 'lines+markers'}),
     surfaceaxis: {

src/traces/scatter3d/convert.js

@@ -58,8 +58,12 @@ proto.handlePick = function(selection) {
             selection.object = this.scatterPlot;
             this.scatterPlot.highlight(selection.data);
         }
-        if(this.textLabels && this.textLabels[selection.data.index] !== undefined) {
-            selection.textLabel = this.textLabels[selection.data.index];
+        if(this.textLabels) {
+            if(this.textLabels[selection.data.index] !== undefined) {
+                selection.textLabel = this.textLabels[selection.data.index];
+            } else {
+                selection.textLabel = this.textLabels;
+            }
         }
         else selection.textLabel = '';
 
@@ -371,7 +375,7 @@ proto.update = function(data) {
         opacity: data.opacity
     };
 
-    this.textLabels = options.text;
+    this.textLabels = data.hovertext || data.text;
 
     if(this.mode.indexOf('text') !== -1) {
         if(this.textMarkers) this.textMarkers.update(textOptions);

src/traces/scatter3d/defaults.js

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

src/traces/scattermapbox/attributes.js

@@ -27,27 +27,35 @@ module.exports = {
     // locations
     // locationmode
 
-    mode: {
-        valType: 'flaglist',
-        flags: ['lines', 'markers', 'text'],
+    mode: extendFlat({}, scatterAttrs.mode, {
         dflt: 'markers',
-        extras: ['none'],
-        role: 'info',
         description: [
             'Determines the drawing mode for this scatter trace.',
             'If the provided `mode` includes *text* then the `text` elements',
             'appear at the coordinates. Otherwise, the `text` elements',
             'appear on hover.'
         ].join(' ')
-    },
+    }),
 
     text: extendFlat({}, scatterAttrs.text, {
         description: [
             'Sets text elements associated with each (lon,lat) pair',
             'If a single string, the same string appears over',
             'all the data points.',
             'If an array of string, the items are mapped in order to the',
-            'this trace\'s (lon,lat) coordinates.'
+            'this trace\'s (lon,lat) coordinates.',
+            'If trace `hoverinfo` contains a *text* flag and *hovertext* is not set,',
+            'these elements will be seen in the hover labels.'
+        ].join(' ')
+    }),
+    hovertext: extendFlat({}, scatterAttrs.hovertext, {
+        description: [
+            'Sets hover text elements associated with each (lon,lat) pair',
+            'If a single string, the same string appears over',
+            'all the data points.',
+            'If an array of string, the items are mapped in order to the',
+            'this trace\'s (lon,lat) coordinates.',
+            'To be seen, trace `hoverinfo` must contain a *text* flag.'
         ].join(' ')
     }),
 

src/traces/scattermapbox/calc.js

@@ -27,7 +27,8 @@ module.exports = function calc(gd, trace) {
         hasColorArray = (hasMarkers && Array.isArray(marker.color)),
         hasSizeArray = (hasMarkers && Array.isArray(marker.size)),
         hasSymbolArray = (hasMarkers && Array.isArray(marker.symbol)),
-        hasTextArray = Array.isArray(trace.text);
+        hasTextArray = Array.isArray(trace.text),
+        hasHoverTextArray = Array.isArray(trace.hovertext);
 
     calcMarkerColorscale(trace);
 
@@ -94,6 +95,11 @@ module.exports = function calc(gd, trace) {
             calcPt.tx = (typeof tx === 'string') ? tx : '';
         }
 
+        if(hasHoverTextArray) {
+            var htx = trace.hovertext[i];
+            calcPt.htx = (typeof htx === 'string') ? htx : '';
+        }
+
         calcTrace.push(calcPt);
     }
 

src/traces/scattermapbox/defaults.js

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

src/traces/scattermapbox/hover.js

@@ -86,7 +86,13 @@ function getExtraText(trace, di) {
     else if(hasLat) text.push('lat: ' + format(lonlat[1]));
 
     if(isAll || hoverinfo.indexOf('text') !== -1) {
-        var tx = di.tx || trace.text;
+        var tx;
+
+        if(di.htx) tx = di.htx;
+        else if(trace.hovertext) tx = trace.hovertext;
+        else if(di.tx) tx = di.tx;
+        else if(trace.text) tx = trace.text;
+
         if(!Array.isArray(tx)) text.push(tx);
     }
 

src/traces/scatterternary/attributes.js

@@ -70,7 +70,19 @@ module.exports = {
             'If a single string, the same string appears over',
             'all the data points.',
             'If an array of strings, the items are mapped in order to the',
-            'the data points in (a,b,c).'
+            'the data points in (a,b,c).',
+            'If trace `hoverinfo` contains a *text* flag and *hovertext* is not set,',
+            'these elements will be seen in the hover labels.'
+        ].join(' ')
+    }),
+    hovertext: extendFlat({}, scatterAttrs.hovertext, {
+        description: [
+            'Sets hover text elements associated with each (a,b,c) point.',
+            'If a single string, the same string appears over',
+            'all the data points.',
+            'If an array of strings, the items are mapped in order to the',
+            'the data points in (a,b,c).',
+            'To be seen, trace `hoverinfo` must contain a *text* flag.'
         ].join(' ')
     }),
     line: {

src/traces/scatterternary/defaults.js

@@ -63,6 +63,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('sum');
 
     coerce('text');
+    coerce('hovertext');
 
     var defaultMode = len < constants.PTS_LINESONLY ? 'lines+markers' : 'lines';
     coerce('mode', defaultMode);

test/image/mocks/text_chart_arrays.json

@@ -40,6 +40,11 @@
                 "top left",
                 "top left"
             ],
+            "hovertext": [
+                "Hover text\nA",
+                "Hover text\rB",
+                "Hover text\r\nC"
+            ],
             "type": "scatter",
             "uid": "459c77"
         },
@@ -83,6 +88,11 @@
                 "bottom left",
                 "bottom left"
             ],
+            "hovertext": [
+                "Hover text G",
+                "Hover text H",
+                "Hover text I"
+            ],
             "type": "scatter",
             "uid": "f8361c"
         },
@@ -103,6 +113,11 @@
                 "a",
                 "",
                 "b"
+            ],
+            "hovertext": [
+                "a (hover)",
+                "",
+                "b (hover)"
             ]
         }
     ],