wip

Author: etpinard

src/components/fx/helpers.js

@@ -87,7 +87,7 @@ function quadrature(dx, dy) {
 
 /** Appends values inside array attributes corresponding to given point number
  *
- * @param {object} pointData : point data object (gets mutated here
+ * @param {object} pointData : point data object (gets mutated here)
  * @param {object} trace : full trace object
  * @param {number} ptNumber : point number
  */
@@ -99,11 +99,14 @@ exports.appendArrayPointValue = function(pointData, trace, ptNumber) {
         var key;
 
         if(astr === 'ids') key = 'id';
-        else if(astr === 'location') key = 'location';
+        else if(astr === 'locations') key = 'location';
         else key = astr;
 
         if(pointData[key] === undefined) {
-            pointData[key] = Lib.nestedProperty(trace, astr).get()[ptNumber];
+            var val = Lib.nestedProperty(trace, astr).get();
+            pointData[key] = Array.isArray(ptNumber) ?
+                val[ptNumber[0]][ptNumber[1]] :
+                val[ptNumber];
         }
     }
 };

src/components/fx/hover.js

@@ -447,19 +447,17 @@ function _hover(gd, evt, subplot) {
             pointNumber: pt.index
         };
 
-        // could maybe :hocho: _module.eventData
         if(pt.trace._module.eventData) out = pt.trace._module.eventData(out, pt);
         else {
             out.x = pt.xVal;
             out.y = pt.yVal;
-
             out.xaxis = pt.xa;
             out.yaxis = pt.ya;
 
             if(pt.zLabelVal !== undefined) out.z = pt.zLabelVal;
         }
 
-        helpers.appendArrayPointValue(out, trace, pt.index);
+        helpers.appendArrayPointValue(out, pt.trace, pt.index);
         newhoverdata.push(out);
     }
 

src/plot_api/plot_schema.js

@@ -157,7 +157,9 @@ exports.findArrayAttributes = function(trace) {
     }
 
     exports.crawl(baseAttributes, callback);
-    exports.crawl(trace._module.attributes, callback);
+    if(trace._module && trace._module.attributes) {
+        exports.crawl(trace._module.attributes, callback);
+    }
 
     if(trace.transforms) {
         var transforms = trace.transforms;
@@ -177,9 +179,8 @@ exports.findArrayAttributes = function(trace) {
     // At the moment, we need this block to make sure that
     // ohlc and candlestick 'open', 'high', 'low', 'close' can be
     // used with filter ang groupby transforms.
-    if(trace._fullInput) {
+    if(trace._fullInput && trace._fullInput._module && trace._fullInput._module.attributes) {
         exports.crawl(trace._fullInput._module.attributes, callback);
-
         arrayAttributes = Lib.filterUnique(arrayAttributes);
     }
 

src/plots/attributes.js

@@ -69,6 +69,22 @@ module.exports = {
         role: 'info',
         dflt: ''
     },
+    ids: {
+        valType: 'data_array',
+        description: [
+            'Assigns id labels to each datum.',
+            'These ids for object constancy of data points during animation.'
+        ].join(' ')
+    },
+    customdata: {
+        valType: 'data_array',
+        description: [
+            'Assigns extra data each datum.',
+            'This may be useful when listening to hover, click and selection events.',
+            'Note that, *scatter* traces also appends customdata items in the markers',
+            'DOM elements'
+        ].join(' ')
+    },
     hoverinfo: {
         valType: 'flaglist',
         role: 'info',

src/plots/cartesian/select.js

@@ -11,6 +11,7 @@
 
 var polygon = require('../../lib/polygon');
 var color = require('../../components/color');
+var appendArrayPointValue = require('../../components/fx/helpers').appendArrayPointValue;
 
 var axes = require('./axes');
 var constants = require('./constants');
@@ -196,3 +197,7 @@ module.exports = function prepSelect(e, startX, startY, dragOptions, mode) {
         }
     };
 };
+
+function makePointData(selection) {
+    // appendArrayPointValue()
+}

src/plots/gl3d/scene.js

@@ -112,7 +112,7 @@ function render(scene) {
             pointNumber: ptNumber
         };
 
-        Fx.appendArrayPointValue(pointData);
+        Fx.appendArrayPointValue(pointData, trace, ptNumber);
 
         var eventData = {points: [pointData]};
 

src/plots/plots.js

@@ -521,7 +521,7 @@ plots.supplyDefaults = function(gd) {
 
 function remapTransformedArrays(cd0, newTrace) {
     var oldTrace = cd0.trace;
-    var arrayAttrs = PlotSchema.findArrayAttributes(oldTrace);
+    var arrayAttrs = oldTrace._arrayAttrs;
     var transformedArrayHash = {};
     var i, astr;
 
@@ -676,9 +676,6 @@ plots.supplyDataDefaults = function(dataIn, dataOut, layout, fullLayout) {
         Lib.pushUnique(modules, _module);
         Lib.pushUnique(basePlotModules, fullTrace._module.basePlotModule);
 
-        // TODO remove findArrayAttributes calls downstream
-        fullTrace._arrayAttrs = PlotSchema.findArrayAttributes(fullTrace);
-
         cnt++;
     }
 
@@ -865,6 +862,9 @@ plots.supplyTraceDefaults = function(traceIn, traceOutIndex, layout, traceInInde
     }
 
     if(visible) {
+        coerce('customdata');
+        coerce('ids');
+
         var _module = plots.getModule(traceOut);
         traceOut._module = _module;
 
@@ -2035,6 +2035,12 @@ plots.doCalcdata = function(gd, traces) {
         }
     }
 
+    // find array attributes in trace
+    for(i = 0; i < fullData.length; i++) {
+        trace = fullData[i];
+        trace._arrayAttrs = PlotSchema.findArrayAttributes(trace);
+    }
+
     initCategories(axList);
 
     var hasCalcTransform = false;

src/traces/scatter/attributes.js

@@ -57,10 +57,6 @@ module.exports = {
             'where `y0` is the starting coordinate and `dy` the step.'
         ].join(' ')
     },
-    customdata: {
-        valType: 'data_array',
-        description: 'Assigns extra data to each scatter point DOM element'
-    },
     dy: {
         valType: 'number',
         dflt: 1,
@@ -70,10 +66,6 @@ module.exports = {
             'See `y0` for more info.'
         ].join(' ')
     },
-    ids: {
-        valType: 'data_array',
-        description: 'A list of keys for object constancy of data points during animation'
-    },
     text: {
         valType: 'string',
         role: 'info',

src/traces/scatter/defaults.js

@@ -36,11 +36,9 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         return;
     }
 
-    coerce('customdata');
     coerce('text');
     coerce('hovertext');
     coerce('mode', defaultMode);
-    coerce('ids');
 
     if(subTypes.hasLines(traceOut)) {
         handleLineDefaults(traceIn, traceOut, defaultColor, layout, coerce);

src/transforms/filter.js

@@ -10,7 +10,6 @@
 
 var Lib = require('../lib');
 var Registry = require('../registry');
-var PlotSchema = require('../plot_api/plot_schema');
 var Axes = require('../plots/cartesian/axes');
 
 var COMPARISON_OPS = ['=', '!=', '<', '>=', '>', '<='];
@@ -148,6 +147,7 @@ exports.calcTransform = function(gd, trace, opts) {
     var target = opts.target;
     var len = targetArray.length;
     var targetCalendar = opts.targetcalendar;
+    var arrayAttrs = trace._arrayAttrs;
 
     // even if you provide targetcalendar, if target is a string and there
     // is a calendar attribute matching target it will get used instead.
@@ -158,7 +158,6 @@ exports.calcTransform = function(gd, trace, opts) {
 
     var d2c = Axes.getDataToCoordFunc(gd, trace, target, targetArray);
     var filterFunc = getFilterFunc(opts, d2c, targetCalendar);
-    var arrayAttrs = PlotSchema.findArrayAttributes(trace);
     var originalArrays = {};
 
     function forAllAttrs(fn, index) {

src/transforms/groupby.js

@@ -122,17 +122,14 @@ function transformOne(trace, state) {
         return trace;
     }
 
-    var groupNames = Lib.filterUnique(groups),
-        newData = new Array(groupNames.length),
-        len = groups.length;
-
+    var groupNames = Lib.filterUnique(groups);
+    var newData = new Array(groupNames.length);
+    var len = groups.length;
     var arrayAttrs = PlotSchema.findArrayAttributes(trace);
-
     var style = opts.style || {};
 
     for(var i = 0; i < groupNames.length; i++) {
         var groupName = groupNames[i];
-
         var newTrace = newData[i] = Lib.extendDeepNoArrays({}, trace);
 
         arrayAttrs.forEach(initializeArray.bind(null, newTrace));

src/transforms/sort.js

@@ -9,7 +9,6 @@
 'use strict';
 
 var Lib = require('../lib');
-var PlotSchema = require('../plot_api/plot_schema');
 var Axes = require('../plots/cartesian/axes');
 
 exports.moduleType = 'transform';
@@ -78,7 +77,7 @@ exports.calcTransform = function(gd, trace, opts) {
 
     var target = opts.target;
     var len = targetArray.length;
-    var arrayAttrs = PlotSchema.findArrayAttributes(trace);
+    var arrayAttrs = trace._arrayAttrs;
     var d2c = Axes.getDataToCoordFunc(gd, trace, target, targetArray);
     var indices = getIndices(opts, targetArray, d2c);
 

test/jasmine/tests/geo_test.js

@@ -536,7 +536,7 @@ describe('Test geo interactions', function() {
             it('should contain the correct fields', function() {
                 expect(Object.keys(ptData)).toEqual([
                     'data', 'fullData', 'curveNumber', 'pointNumber',
-                    'lon', 'lat', 'location'
+                    'lon', 'lat', 'location', 'marker.size'
                 ]);
                 expect(cnt).toEqual(1);
             });
@@ -547,6 +547,7 @@ describe('Test geo interactions', function() {
                 expect(ptData.location).toBe(null);
                 expect(ptData.curveNumber).toEqual(0);
                 expect(ptData.pointNumber).toEqual(0);
+                expect(ptData['marker.size']).toEqual(20);
                 expect(cnt).toEqual(1);
             });
 
@@ -598,7 +599,7 @@ describe('Test geo interactions', function() {
             it('should contain the correct fields', function() {
                 expect(Object.keys(ptData)).toEqual([
                     'data', 'fullData', 'curveNumber', 'pointNumber',
-                    'lon', 'lat', 'location'
+                    'lon', 'lat', 'location', 'marker.size'
                 ]);
             });
 
@@ -608,6 +609,7 @@ describe('Test geo interactions', function() {
                 expect(ptData.location).toBe(null);
                 expect(ptData.curveNumber).toEqual(0);
                 expect(ptData.pointNumber).toEqual(0);
+                expect(ptData['marker.size']).toEqual(20);
             });
         });
 
@@ -629,7 +631,7 @@ describe('Test geo interactions', function() {
             it('should contain the correct fields', function() {
                 expect(Object.keys(ptData)).toEqual([
                     'data', 'fullData', 'curveNumber', 'pointNumber',
-                    'lon', 'lat', 'location'
+                    'lon', 'lat', 'location', 'marker.size'
                 ]);
             });
 
@@ -639,6 +641,7 @@ describe('Test geo interactions', function() {
                 expect(ptData.location).toBe(null);
                 expect(ptData.curveNumber).toEqual(0);
                 expect(ptData.pointNumber).toEqual(0);
+                expect(ptData['marker.size']).toEqual(20);
             });
         });
 
@@ -1100,7 +1103,7 @@ describe('Test event property of interactions on a geo plot:', function() {
 
             expect(Object.keys(pt)).toEqual([
                 'data', 'fullData', 'curveNumber', 'pointNumber', 'lon', 'lat',
-                'location'
+                'location', 'text', 'marker.size'
             ]);
 
             expect(pt.curveNumber).toEqual(0, 'points[0].curveNumber');
@@ -1110,6 +1113,8 @@ describe('Test event property of interactions on a geo plot:', function() {
             expect(pt.lon).toEqual(57.75, 'points[0].lon');
             expect(pt.location).toEqual(57.75, 'points[0].location');
             expect(pt.pointNumber).toEqual(0, 'points[0].pointNumber');
+            expect(pt.text).toEqual(20, 'points[0].text');
+            expect(pt['marker.size']).toEqual(20, 'points[0][\'marker.size\']');
 
             expect(evt.clientX).toEqual(pointPos[0], 'event.clientX');
             expect(evt.clientY).toEqual(pointPos[1], 'event.clientY');
@@ -1146,7 +1151,7 @@ describe('Test event property of interactions on a geo plot:', function() {
 
             expect(Object.keys(pt)).toEqual([
                 'data', 'fullData', 'curveNumber', 'pointNumber', 'lon', 'lat',
-                'location'
+                'location', 'text', 'marker.size'
             ]);
 
             expect(pt.curveNumber).toEqual(0, 'points[0].curveNumber');
@@ -1156,6 +1161,8 @@ describe('Test event property of interactions on a geo plot:', function() {
             expect(pt.lon).toEqual(57.75, 'points[0].lon');
             expect(pt.location).toEqual(57.75, 'points[0].location');
             expect(pt.pointNumber).toEqual(0, 'points[0].pointNumber');
+            expect(pt.text).toEqual(20, 'points[0].text');
+            expect(pt['marker.size']).toEqual(20, 'points[0][\'marker.size\']');
 
             expect(evt.clientX).toEqual(pointPos[0], 'event.clientX');
             expect(evt.clientY).toEqual(pointPos[1], 'event.clientY');
@@ -1185,7 +1192,7 @@ describe('Test event property of interactions on a geo plot:', function() {
 
             expect(Object.keys(pt)).toEqual([
                 'data', 'fullData', 'curveNumber', 'pointNumber', 'lon', 'lat',
-                'location'
+                'location', 'text', 'marker.size'
             ]);
 
             expect(pt.curveNumber).toEqual(0, 'points[0].curveNumber');
@@ -1195,6 +1202,8 @@ describe('Test event property of interactions on a geo plot:', function() {
             expect(pt.lon).toEqual(57.75, 'points[0].lon');
             expect(pt.location).toEqual(57.75, 'points[0].location');
             expect(pt.pointNumber).toEqual(0, 'points[0].pointNumber');
+            expect(pt.text).toEqual(20, 'points[0].text');
+            expect(pt['marker.size']).toEqual(20, 'points[0][\'marker.size\']');
 
             expect(evt.clientX).toEqual(pointPos[0], 'event.clientX');
             expect(evt.clientY).toEqual(pointPos[1], 'event.clientY');
@@ -1219,7 +1228,7 @@ describe('Test event property of interactions on a geo plot:', function() {
 
                 expect(Object.keys(pt)).toEqual([
                     'data', 'fullData', 'curveNumber', 'pointNumber', 'lon', 'lat',
-                    'location'
+                    'location', 'text', 'marker.size'
                 ]);
 
                 expect(pt.curveNumber).toEqual(0, 'points[0].curveNumber');
@@ -1229,6 +1238,8 @@ describe('Test event property of interactions on a geo plot:', function() {
                 expect(pt.lon).toEqual(57.75, 'points[0].lon');
                 expect(pt.location).toEqual(57.75, 'points[0].location');
                 expect(pt.pointNumber).toEqual(0, 'points[0].pointNumber');
+                expect(pt.text).toEqual(20, 'points[0].text');
+                expect(pt['marker.size']).toEqual(20, 'points[0][\'marker.size\']');
 
                 expect(evt.clientX).toEqual(nearPos[0], 'event.clientX');
                 expect(evt.clientY).toEqual(nearPos[1], 'event.clientY');

test/jasmine/tests/gl2d_click_test.js

@@ -114,10 +114,10 @@ describe('Test hover and click interactions', function() {
 
         var pt = actual.points[0];
 
-        expect(Object.keys(pt)).toEqual([
+        expect(Object.keys(pt)).toEqual(jasmine.arrayContaining([
             'x', 'y', 'curveNumber', 'pointNumber',
             'data', 'fullData', 'xaxis', 'yaxis'
-        ], 'event data keys');
+        ]), 'event data keys');
 
         expect(typeof pt.data.uid).toEqual('string', 'uid');
         expect(pt.xaxis.domain.length).toEqual(2, 'xaxis');