one source of truth for event data keys used for doc and test

Author: antoinerg

src/components/fx/hovertemplate_attributes.js

@@ -15,14 +15,15 @@ module.exports = function(opts, extra) {
     var descPart = extra.description ? ' ' + extra.description : '';
     var keys = extra.keys || [];
     if(keys.length > 0) {
+        var quotedKeys = [];
         for(var i = 0; i < keys.length; i++) {
-            keys[i] = '`' + keys[i] + '`';
+            quotedKeys[i] = '`' + keys[i] + '`';
         }
         descPart = descPart + 'This trace supports the additional ';
         if(keys.length === 1) {
-            descPart = 'variable ' + keys[0];
+            descPart = 'variable ' + quotedKeys[0];
         } else {
-            descPart = 'variables ' + keys.slice(0, -1).join(', ') + ' and ' + keys.slice(-1) + '.';
+            descPart = 'variables ' + quotedKeys.slice(0, -1).join(', ') + ' and ' + quotedKeys.slice(-1) + '.';
         }
     }
 

src/traces/bar/attributes.js

@@ -13,6 +13,7 @@ var hovertemplateAttrs = require('../../components/fx/hovertemplate_attributes')
 var colorAttributes = require('../../components/colorscale/attributes');
 var colorbarAttrs = require('../../components/colorbar/attributes');
 var fontAttrs = require('../../plots/font_attributes');
+var constants = require('./constants.js')
 
 var extendFlat = require('../../lib/extend').extendFlat;
 
@@ -60,7 +61,9 @@ module.exports = {
 
     text: scatterAttrs.text,
     hovertext: scatterAttrs.hovertext,
-    hovertemplate: hovertemplateAttrs(),
+    hovertemplate: hovertemplateAttrs({}, {
+        keys: constants.eventDataKeys
+    }),
 
     textposition: {
         valType: 'enumerated',

src/traces/bar/constants.js

@@ -0,0 +1,14 @@
+/**
+* Copyright 2012-2018, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+
+'use strict';
+
+module.exports = {
+    eventDataKeys: []
+};

src/traces/histogram/attributes.js

@@ -11,6 +11,7 @@
 var barAttrs = require('../bar/attributes');
 var hovertemplateAttrs = require('../../components/fx/hovertemplate_attributes');
 var makeBinAttrs = require('./bin_attributes');
+var constants = require('./constants');
 
 module.exports = {
     x: {
@@ -187,7 +188,7 @@ module.exports = {
     },
 
     hovertemplate: hovertemplateAttrs({}, {
-        keys: ['binNumber']
+        keys: constants.eventDataKeys
     }),
 
     marker: barAttrs.marker,

src/traces/histogram/constants.js

@@ -0,0 +1,14 @@
+/**
+* Copyright 2012-2018, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+
+'use strict';
+
+module.exports = {
+    eventDataKeys: ['binNumber']
+};

src/traces/scatter/attributes.js

@@ -205,7 +205,7 @@ module.exports = {
         ].join(' ')
     },
     hovertemplate: hovertemplateAttrs({}, {
-        keys: ['marker.size', 'marker.color']
+        keys: constants.eventDataKeys
     }),
     line: {
         color: {

src/traces/scatter/constants.js

@@ -21,5 +21,7 @@ module.exports = {
 
     // number of viewport sizes away from the visible region
     // at which we clip all lines to the perimeter
-    maxScreensAway: 20
+    maxScreensAway: 20,
+
+    eventDataKeys: ['marker.size', 'marker.color']
 };

test/jasmine/tests/bar_test.js

@@ -14,6 +14,7 @@ var checkTicks = require('../assets/custom_assertions').checkTicks;
 var supplyAllDefaults = require('../assets/supply_defaults');
 
 var checkEventData = require('../assets/check_event_data');
+var constants = require('@src/traces/bar/constants');
 
 var customAssertions = require('../assets/custom_assertions');
 var assertClip = customAssertions.assertClip;
@@ -1861,7 +1862,7 @@ describe('bar hover', function() {
 
 describe('event data', function() {
     var mock = require('@mocks/stacked_bar');
-    checkEventData(mock, 216, 309, []);
+    checkEventData(mock, 216, 309, constants.eventDataKeys);
 });
 
 function mockBarPlot(dataWithoutTraceType, layout) {

test/jasmine/tests/histogram_test.js

@@ -14,6 +14,7 @@ var supplyAllDefaults = require('../assets/supply_defaults');
 var failTest = require('../assets/fail_test');
 
 var checkEventData = require('../assets/check_event_data');
+var constants = require('@src/traces/histogram/constants');
 
 describe('Test histogram', function() {
     'use strict';
@@ -1064,5 +1065,5 @@ describe('getBinSpanLabelRound', function() {
 
 describe('event data', function() {
     var mock = require('@mocks/hist_category');
-    checkEventData(mock, 100, 200, ['binNumber']);
+    checkEventData(mock, 100, 200, constants.eventDataKeys);
 });

test/jasmine/tests/scatter_test.js

@@ -15,6 +15,7 @@ var assertClip = customAssertions.assertClip;
 var assertNodeDisplay = customAssertions.assertNodeDisplay;
 var assertMultiNodeOrder = customAssertions.assertMultiNodeOrder;
 var checkEventData = require('../assets/check_event_data');
+var constants = require('@src/traces/scatter/constants');
 
 var getOpacity = function(node) { return Number(node.style.opacity); };
 var getFillOpacity = function(node) { return Number(node.style['fill-opacity']); };
@@ -1812,5 +1813,5 @@ describe('Test scatter *clipnaxis*:', function() {
 
 describe('event data', function() {
     var mock = require('@mocks/scatter-colorscale-colorbar');
-    checkEventData(mock, 540, 260, ['marker.size', 'marker.color']);
+    checkEventData(mock, 540, 260, constants.eventDataKeys);
 });