add 'hovertext' to scatterternary traces

Author: etpinard

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/jasmine/tests/scatterternary_test.js

@@ -299,9 +299,7 @@ describe('scatterternary plot and hover', function() {
 describe('scatterternary hover', function() {
     'use strict';
 
-    var hoverPoints = ScatterTernary.hoverPoints;
-
-    var gd, pointData;
+    var gd;
 
     beforeAll(function(done) {
         gd = createGraphDiv();
@@ -310,17 +308,20 @@ describe('scatterternary hover', function() {
             type: 'scatterternary',
             a: [0.1, 0.2, 0.3],
             b: [0.3, 0.2, 0.1],
-            c: [0.1, 0.4, 0.5]
+            c: [0.1, 0.4, 0.5],
+            text: ['A', 'B', 'C']
         }];
 
         Plotly.plot(gd, data).then(done);
     });
 
-    beforeEach(function() {
-        var cd = gd.calcdata,
-            ternary = gd._fullLayout.ternary._subplot;
+    afterAll(destroyGraphDiv);
+
+    function _hover(gd, xval, yval, hovermode) {
+        var cd = gd.calcdata;
+        var ternary = gd._fullLayout.ternary._subplot;
 
-        pointData = {
+        var pointData = {
             index: false,
             distance: 20,
             cd: cd[0],
@@ -329,23 +330,41 @@ describe('scatterternary hover', function() {
             ya: ternary.yaxis
         };
 
-    });
-
-    afterAll(destroyGraphDiv);
+        return ScatterTernary.hoverPoints(pointData, xval, yval, hovermode);
+    }
 
-    it('should generate extra text field on hover', function() {
-        var xval = 0.42,
-            yval = 0.37,
-            hovermode = 'closest';
+    it('should generate extra text field on hover', function(done) {
+        var xval = 0.42;
+        var yval = 0.37;
+        var hovermode = 'closest';
+        var scatterPointData;
 
-        var scatterPointData = hoverPoints(pointData, xval, yval, hovermode);
+        scatterPointData = _hover(gd, xval, yval, hovermode);
 
         expect(scatterPointData[0].extraText).toEqual(
             'Component A: 0.3333333<br>Component B: 0.1111111<br>Component C: 0.5555556'
         );
 
         expect(scatterPointData[0].xLabelVal).toBeUndefined();
         expect(scatterPointData[0].yLabelVal).toBeUndefined();
+        expect(scatterPointData[0].text).toEqual('C');
+
+        Plotly.restyle(gd, {
+            text: null,
+            hovertext: [['apple', 'banana', 'orange']]
+        })
+        .then(function() {
+            scatterPointData = _hover(gd, xval, yval, hovermode);
+
+            expect(scatterPointData[0].extraText).toEqual(
+                'Component A: 0.3333333<br>Component B: 0.1111111<br>Component C: 0.5555556'
+            );
+
+            expect(scatterPointData[0].xLabelVal).toBeUndefined();
+            expect(scatterPointData[0].yLabelVal).toBeUndefined();
+            expect(scatterPointData[0].text).toEqual('orange');
+        })
+        .then(done);
     });
 
 });