add 'text' attribute to box traces

- associated with each sample pt
- only visible on hover (for now)

Author: etpinard

src/traces/box/attributes.js

@@ -62,6 +62,16 @@ module.exports = {
             'missing and the position axis is categorical'
         ].join(' ')
     },
+    text: extendFlat({}, scatterAttrs.text, {
+        description: [
+            'Sets the text elements associated with each sample value.',
+            '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(' ')
+    }),
     whiskerwidth: {
         valType: 'number',
         min: 0,

src/traces/box/calc.js

@@ -56,6 +56,7 @@ module.exports = function calc(gd, trace) {
         var n = Lib.findBin(pos[i], posBins);
         if(n >= 0 && n < pLen) {
             var pt = {v: v, i: i};
+            arraysToCalcdata(pt, trace, i);
             ptsPerBin[n].push(pt);
         }
     }
@@ -176,6 +177,18 @@ function initNestedArray(len) {
     return arr;
 }
 
+function arraysToCalcdata(pt, trace, i) {
+    var trace2calc = {
+        text: 'tx'
+    };
+
+    for(var k in trace2calc) {
+        if(Array.isArray(trace[k])) {
+            pt[trace2calc[k]] = trace[k][i];
+        }
+    }
+}
+
 function sortByVal(a, b) { return a.v - b.v; }
 
 function extractVal(o) { return o.v; }

src/traces/box/defaults.js

@@ -72,5 +72,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         }
     }
 
+    coerce('text');
     coerce('hoveron');
 };

src/traces/box/hover.js

@@ -12,6 +12,7 @@ var Axes = require('../../plots/cartesian/axes');
 var Lib = require('../../lib');
 var Fx = require('../../components/fx');
 var Color = require('../../components/color');
+var fillHoverText = require('../scatter/fill_hover_text');
 
 module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
     var cd = pointData.cd;
@@ -170,6 +171,7 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
                         yLabelVal: pt.y
                     });
 
+                    fillHoverText(pt, trace, pointData2);
                     closeData.push(pointData2);
                 }
             }

test/jasmine/tests/box_test.js

@@ -216,6 +216,33 @@ describe('Test box hover:', function() {
             '', '', '', '', '', '', '', '', '', '', 'radishes'
         ],
         axis: 'day 1'
+    }, {
+        desc: 'text items on hover',
+        patch: function(fig) {
+            fig.data.forEach(function(trace) {
+                trace.boxpoints = 'all';
+                trace.hoveron = 'points';
+                trace.text = trace.y.map(function(v) { return 'look:' + v; });
+            });
+            fig.layout.hovermode = 'closest';
+            return fig;
+        },
+        nums: ['(day 1, 0.7)\nlook:0.7', '(day 1, 0.6)\nlook:0.6', '(day 1, 0.6)\nlook:0.6'],
+        name: ['radishes', 'radishes', 'radishes']
+    }, {
+        desc: 'only text items on hover',
+        patch: function(fig) {
+            fig.data.forEach(function(trace) {
+                trace.boxpoints = 'all';
+                trace.hoveron = 'points';
+                trace.text = trace.y.map(function(v) { return 'look:' + v; });
+                trace.hoverinfo = 'text';
+            });
+            fig.layout.hovermode = 'closest';
+            return fig;
+        },
+        nums: ['look:0.7', 'look:0.6', 'look:0.6'],
+        name: ['', '', '']
     }].forEach(function(specs) {
         it('should generate correct hover labels ' + specs.desc, function(done) {
             run(specs).catch(fail).then(done);