transforms: allow 'filtersrc' to be an arbitrary attr string

- so that filters can be applied to ALL possible data array
  e.g `filtersrc: 'marker.color'`
- add tests for geo 'lon' / 'lat' and 'marker.color'

Author: etpinard

src/transforms/filter.js

@@ -28,12 +28,17 @@ exports.attributes = {
         ].join(' ')
     },
     filtersrc: {
-        valType: 'enumerated',
-        values: ['x', 'y', 'z', 'ids'],
+        valType: 'string',
+        strict: true,
+        noBlank: true,
         dflt: 'x',
         description: [
             'Sets the variable in the parent trace object',
-            'by which the filter will be applied.'
+            'by which the filter will be applied.',
+
+            'To filter about nested variables, use *.* to access them.',
+            'For example, set `filtersrc` to *marker.color* to filter',
+            'about the marker color array.'
         ].join(' ')
     },
     operation: {
@@ -110,14 +115,15 @@ exports.supplyDefaults = function(transformIn) {
 };
 
 exports.calcTransform = function(gd, trace, opts) {
-    var filtersrc = opts.filtersrc;
+    var filtersrc = opts.filtersrc,
+        filtersrcOk = filtersrc && Array.isArray(Lib.nestedProperty(trace, filtersrc).get());
 
-    if(!opts.enabled || !trace[filtersrc]) return;
+    if(!opts.enabled || !filtersrcOk) return;
 
     var dataToCoord = getDataToCoordFunc(gd, filtersrc),
         filterFunc = getFilterFunc(opts, dataToCoord);
 
-    var filterArr = trace[filtersrc],
+    var filterArr = Lib.nestedProperty(trace, filtersrc).get(),
         len = filterArr.length;
 
     var arrayAttrs = Lib.findArrayAttributes(trace),

test/jasmine/tests/transform_filter_test.js

@@ -49,6 +49,31 @@ describe('filter transforms defaults:', function() {
             enabled: false,
         }]);
     });
+
+    it('supplyTraceDefaults should coerce *filtersrc* as a strict / noBlank string', function() {
+        traceIn = {
+            x: [1, 2, 3],
+            transforms: [{
+                type: 'filter',
+            }, {
+                type: 'filter',
+                filtersrc: 0
+            }, {
+                type: 'filter',
+                filtersrc: ''
+            }, {
+                type: 'filter',
+                filtersrc: 'marker.color'
+            }]
+        };
+
+        traceOut = Plots.supplyTraceDefaults(traceIn, 0, {});
+
+        expect(traceOut.transforms[0].filtersrc).toEqual('x');
+        expect(traceOut.transforms[1].filtersrc).toEqual('x');
+        expect(traceOut.transforms[2].filtersrc).toEqual('x');
+        expect(traceOut.transforms[3].filtersrc).toEqual('marker.color');
+    });
 });
 
 describe('filter transforms calc:', function() {
@@ -95,6 +120,55 @@ describe('filter transforms calc:', function() {
         expect(out[0].y).toEqual(base.y);
     });
 
+    it('filters should handle geographical *lon* data', function() {
+        var trace0 = {
+            type: 'scattergeo',
+            lon: [-90, -40, 100, 120, 130],
+            lat: [-50, -40, 10, 20, 30],
+            transforms: [{
+                type: 'filter',
+                operation: '>',
+                value: 0,
+                filtersrc: 'lon'
+            }]
+        };
+
+        var trace1 = {
+            type: 'scattermapbox',
+            lon: [-90, -40, 100, 120, 130],
+            lat: [-50, -40, 10, 20, 30],
+            transforms: [{
+                type: 'filter',
+                operation: '<',
+                value: 0,
+                filtersrc: 'lat'
+            }]
+        };
+
+        var out = _transform([trace0, trace1]);
+
+        expect(out[0].lon).toEqual([100, 120, 130]);
+        expect(out[0].lat).toEqual([10, 20, 30]);
+
+        expect(out[1].lon).toEqual([-90, -40]);
+        expect(out[1].lat).toEqual([-50, -40]);
+    });
+
+    it('filters should handle nested attributes', function() {
+        var out = _transform([Lib.extendDeep({}, base, {
+            transforms: [{
+                type: 'filter',
+                operation: '>',
+                value: 0.2,
+                filtersrc: 'marker.color'
+            }]
+        })]);
+
+        expect(out[0].x).toEqual([-2, 2, 3]);
+        expect(out[0].y).toEqual([3, 3, 1]);
+        expect(out[0].marker.color).toEqual([0.3, 0.3, 0.4]);
+    });
+
     it('filters should skip if *enabled* is false', function() {
         var out = _transform([Lib.extendDeep({}, base, {
             transforms: [{