add 'hovertext' to bar traces

Author: etpinard

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);
 

test/jasmine/tests/bar_test.js

@@ -9,6 +9,7 @@ var Axes = PlotlyInternal.Axes;
 
 var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
+var fail = require('../assets/fail_test');
 var customMatchers = require('../assets/custom_matchers');
 
 describe('Bar.supplyDefaults', function() {
@@ -1197,7 +1198,8 @@ describe('bar hover', function() {
 
         return {
             style: [pt.index, pt.color, pt.xLabelVal, pt.yLabelVal],
-            pos: [pt.x0, pt.x1, pt.y0, pt.y1]
+            pos: [pt.x0, pt.x1, pt.y0, pt.y1],
+            text: pt.text
         };
     }
 
@@ -1274,6 +1276,41 @@ describe('bar hover', function() {
         });
     });
 
+    describe('text labels', function() {
+
+        it('should show \'hovertext\' items when present, \'text\' if not', function(done) {
+            gd = createGraphDiv();
+
+            var mock = Lib.extendDeep({}, require('@mocks/text_chart_arrays'));
+            mock.data.forEach(function(t) { t.type = 'bar'; });
+
+            Plotly.plot(gd, mock).then(function() {
+                var out = _hover(gd, -0.25, 0.5, 'closest');
+                expect(out.text).toEqual('Hover text\nA', 'hover text');
+
+                return Plotly.restyle(gd, 'hovertext', null);
+            })
+            .then(function() {
+                var out = _hover(gd, -0.25, 0.5, 'closest');
+                expect(out.text).toEqual('Text\nA', 'hover text');
+
+                return Plotly.restyle(gd, 'text', ['APPLE', 'BANANA', 'ORANGE']);
+            })
+            .then(function() {
+                var out = _hover(gd, -0.25, 0.5, 'closest');
+                expect(out.text).toEqual('APPLE', 'hover text');
+
+                return Plotly.restyle(gd, 'hovertext', ['apple', 'banana', 'orange']);
+            })
+            .then(function() {
+                var out = _hover(gd, -0.25, 0.5, 'closest');
+                expect(out.text).toEqual('apple', 'hover text');
+            })
+            .catch(fail)
+            .then(done);
+        });
+    });
+
 });
 
 function mockBarPlot(dataWithoutTraceType, layout) {