Pass customdata through to scatter calcdata

Author: rreusser

src/traces/scatter/arrays_to_calcdata.js

@@ -16,6 +16,7 @@ var Lib = require('../../lib');
 module.exports = function arraysToCalcdata(cd, trace) {
 
     Lib.mergeArray(trace.text, cd, 'tx');
+    Lib.mergeArray(trace.customdata, cd, 'data');
     Lib.mergeArray(trace.textposition, cd, 'tp');
     if(trace.textfont) {
         Lib.mergeArray(trace.textfont.size, cd, 'ts');

src/traces/scatter/attributes.js

@@ -56,6 +56,10 @@ module.exports = {
             'where `y0` is the starting coordinate and `dy` the step.'
         ].join(' ')
     },
+    customdata: {
+        valType: 'data_array',
+        description: 'When markers present, assigns extra data to each scatter point DOM element'
+    },
     dy: {
         valType: 'number',
         dflt: 1,

src/traces/scatter/defaults.js

@@ -36,6 +36,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         return;
     }
 
+    coerce('customdata');
     coerce('text');
     coerce('mode', defaultMode);
     coerce('ids');

test/jasmine/tests/calcdata_test.js

@@ -862,4 +862,19 @@ describe('calculated data and points', function() {
             });
         });
     });
+
+    describe('customdata', function() {
+        it('should pass customdata to the calcdata points', function() {
+            Plotly.plot(gd, [{
+                x: [0, 1, 2, 3],
+                y: [4, 5, 6, 7],
+                customdata: ['a', 'b', 'c', 'd']
+            }], {});
+
+            expect(gd.calcdata[0][0]).toEqual(jasmine.objectContaining({data: 'a'}));
+            expect(gd.calcdata[0][1]).toEqual(jasmine.objectContaining({data: 'b'}));
+            expect(gd.calcdata[0][2]).toEqual(jasmine.objectContaining({data: 'c'}));
+            expect(gd.calcdata[0][3]).toEqual(jasmine.objectContaining({data: 'd'}));
+        });
+    });
 });