test that event data has correct fields in bar, scatter, histogram

Author: antoinerg

test/jasmine/assets/check_event_data.js

@@ -0,0 +1,42 @@
+var Plotly = require('@lib/index');
+var createGraphDiv = require('../assets/create_graph_div');
+var destroyGraphDiv = require('../assets/destroy_graph_div');
+var Lib = require('@src/lib');
+
+var hover = require('../assets/hover');
+
+'use strict';
+
+module.exports = function checkEventData(mock, x, y, additionalFields) {
+    var mockCopy = Lib.extendDeep({}, mock),
+        gd;
+
+    beforeEach(function(done) {
+        gd = createGraphDiv();
+
+        Plotly.plot(gd, mockCopy.data, mockCopy.layout)
+                .then(done);
+    });
+
+    afterEach(destroyGraphDiv);
+
+    it('should contain the correct fields', function() {
+        var hoverData;
+
+        gd.on('plotly_hover', function(data) {
+            hoverData = data;
+        });
+
+        hover(x, y);
+
+        var fields = [
+            'curveNumber',
+            'data', 'fullData',
+            'xaxis', 'yaxis', 'x', 'y',
+        ].concat(additionalFields);
+
+        fields.forEach(function(field) {
+            expect(Object.keys(hoverData.points[0])).toContain(field);
+        });
+    });
+};

test/jasmine/tests/bar_test.js

@@ -13,6 +13,8 @@ var failTest = require('../assets/fail_test');
 var checkTicks = require('../assets/custom_assertions').checkTicks;
 var supplyAllDefaults = require('../assets/supply_defaults');
 
+var checkEventData = require('../assets/check_event_data');
+
 var customAssertions = require('../assets/custom_assertions');
 var assertClip = customAssertions.assertClip;
 var assertNodeDisplay = customAssertions.assertNodeDisplay;
@@ -1857,6 +1859,11 @@ describe('bar hover', function() {
     });
 });
 
+describe('event data', function() {
+    var mock = require('@mocks/stacked_bar');
+    checkEventData(mock, 0, 309, []);
+});
+
 function mockBarPlot(dataWithoutTraceType, layout) {
     var traceTemplate = { type: 'bar' };
 

test/jasmine/tests/histogram_test.js

@@ -13,6 +13,7 @@ var destroyGraphDiv = require('../assets/destroy_graph_div');
 var supplyAllDefaults = require('../assets/supply_defaults');
 var failTest = require('../assets/fail_test');
 
+var checkEventData = require('../assets/check_event_data');
 
 describe('Test histogram', function() {
     'use strict';
@@ -1060,3 +1061,8 @@ describe('getBinSpanLabelRound', function() {
         ]);
     });
 });
+
+describe('event data', function() {
+    var mock = require('@mocks/hist_category');
+    checkEventData(mock, 100, 200, ['binNumber']);
+});

test/jasmine/tests/scatter_test.js

@@ -14,7 +14,7 @@ var transitions = require('../assets/transitions');
 var assertClip = customAssertions.assertClip;
 var assertNodeDisplay = customAssertions.assertNodeDisplay;
 var assertMultiNodeOrder = customAssertions.assertMultiNodeOrder;
-var hover = require('../assets/hover');
+var checkEventData = require('../assets/check_event_data');
 
 var getOpacity = function(node) { return Number(node.style.opacity); };
 var getFillOpacity = function(node) { return Number(node.style['fill-opacity']); };
@@ -1812,39 +1812,5 @@ describe('Test scatter *clipnaxis*:', function() {
 
 describe('event data', function() {
     var mock = require('@mocks/12');
-    var mockCopy = Lib.extendDeep({}, mock),
-        gd;
-
-    beforeEach(function(done) {
-        gd = createGraphDiv();
-
-        Plotly.plot(gd, mockCopy.data, mockCopy.layout)
-            .then(done);
-    });
-
-    afterEach(destroyGraphDiv);
-
-    it('should contain the correct fields', function() {
-
-        var hoverData;
-
-        gd.on('plotly_hover', function(data) {
-            hoverData = data;
-        });
-
-        hover(130, 350);
-
-        expect(hoverData.points.length).toEqual(1);
-
-        var fields = [
-            'curveNumber', 'pointNumber',
-            'data', 'fullData',
-            'xaxis', 'yaxis', 'x', 'y',
-            'marker.size'
-        ];
-
-        fields.forEach(function(field) {
-            expect(Object.keys(hoverData.points[0])).toContain(field);
-        });
-    });
+    checkEventData(mock, 130, 350, ['marker.size']);
 });