🔒 down 'hovertext' / 'text' logic for scatter traces

Author: etpinard

test/jasmine/tests/scatter_test.js

@@ -7,6 +7,7 @@ var Lib = require('@src/lib');
 var Plotly = require('@lib/index');
 var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
+var customMatchers = require('../assets/custom_matchers');
 var fail = require('../assets/fail_test');
 
 describe('Test scatter', function() {
@@ -372,3 +373,76 @@ describe('end-to-end scatter tests', function() {
         }).catch(fail).then(done);
     });
 });
+
+describe('scatter hoverPoints', function() {
+
+    beforeAll(function() {
+        jasmine.addMatchers(customMatchers);
+    });
+
+    afterEach(destroyGraphDiv);
+
+    function _hover(gd, xval, yval, hovermode) {
+        return gd._fullData.map(function(trace, i) {
+            var cd = gd.calcdata[i];
+            var subplot = gd._fullLayout._plots.xy;
+
+            var out = Scatter.hoverPoints({
+                index: false,
+                distance: 20,
+                cd: cd,
+                trace: trace,
+                xa: subplot.xaxis,
+                ya: subplot.yaxis
+            }, xval, yval, hovermode);
+
+            return Array.isArray(out) ? out[0] : null;
+        });
+    }
+
+    it('should show \'hovertext\' items when present, \'text\' if not', function(done) {
+        var gd = createGraphDiv();
+        var mock = Lib.extendDeep({}, require('@mocks/text_chart_arrays'));
+
+        Plotly.plot(gd, mock).then(function() {
+            var pts = _hover(gd, 0, 1, 'x');
+
+            // as in 'hovertext' arrays
+            expect(pts[0].text).toEqual('Hover text\nA', 'hover text');
+            expect(pts[1].text).toEqual('Hover text G', 'hover text');
+            expect(pts[2].text).toEqual('a (hover)', 'hover text');
+
+            return Plotly.restyle(gd, 'hovertext', null);
+        })
+        .then(function() {
+            var pts = _hover(gd, 0, 1, 'x');
+
+            // as in 'text' arrays
+            expect(pts[0].text).toEqual('Text\nA', 'hover text');
+            expect(pts[1].text).toEqual('Text G', 'hover text');
+            expect(pts[2].text).toEqual('a', 'hover text');
+
+            return Plotly.restyle(gd, 'text', ['APPLE', 'BANANA', 'ORANGE']);
+        })
+        .then(function() {
+            var pts = _hover(gd, 1, 1, 'x');
+
+            // as in 'text' values
+            expect(pts[0].text).toEqual('APPLE', 'hover text');
+            expect(pts[1].text).toEqual('BANANA', 'hover text');
+            expect(pts[2].text).toEqual('ORANGE', 'hover text');
+
+            return Plotly.restyle(gd, 'hovertext', ['apple', 'banana', 'orange']);
+        })
+        .then(function() {
+            var pts = _hover(gd, 1, 1, 'x');
+
+            // as in 'hovertext' values
+            expect(pts[0].text).toEqual('apple', 'hover text');
+            expect(pts[1].text).toEqual('banana', 'hover text');
+            expect(pts[2].text).toEqual('orange', 'hover text');
+        })
+        .catch(fail)
+        .then(done);
+    });
+});