Merge pull request #499 from plotly/transform-plugins

Introducing transform plugins

Author: etpinard

devtools/test_dashboard/devtools.js

@@ -5,6 +5,7 @@
 var Fuse = require('fuse.js');
 var mocks = require('../../build/test_dashboard_mocks.json');
 var credentials = require('../../build/credentials.json');
+var Lib = require('@src/lib');
 
 // put d3 in window scope
 var d3 = window.d3 = Plotly.d3;
@@ -149,6 +150,7 @@ var Tabs = {
 
 // Bind things to the window
 window.Tabs = Tabs;
+window.Lib = Lib;
 setInterval(function() {
     window.gd = Tabs.getGraph() || Tabs.fresh();
     window.fullLayout = window.gd._fullLayout;

devtools/test_dashboard/server.js

@@ -8,6 +8,7 @@ var watchify = require('watchify');
 
 var constants = require('../../tasks/util/constants');
 var compress = require('../../tasks/util/compress_attributes');
+var shortcutPaths = require('../../tasks/util/shortcut_paths');
 
 var PORT = process.argv[2] || 3000;
 
@@ -32,7 +33,9 @@ b.on('update', bundlePlotly);
 
 // Bundle devtools code
 var devtoolsPath = path.join(constants.pathToRoot, 'devtools/test_dashboard');
-var devtools = browserify(path.join(devtoolsPath, 'devtools.js'), {});
+var devtools = browserify(path.join(devtoolsPath, 'devtools.js'), {
+    transform: [shortcutPaths]
+});
 
 var firstBundle = true;
 

src/plot_api/plot_api.js

@@ -850,9 +850,8 @@ Plotly.newPlot = function(gd, data, layout, config) {
 function doCalcdata(gd) {
     var axList = Plotly.Axes.list(gd),
         fullData = gd._fullData,
-        fullLayout = gd._fullLayout;
-
-    var i, trace, module, cd;
+        fullLayout = gd._fullLayout,
+        i;
 
     var calcdata = gd.calcdata = new Array(fullData.length);
 
@@ -878,12 +877,12 @@ function doCalcdata(gd) {
     }
 
     for(i = 0; i < fullData.length; i++) {
-        trace = fullData[i];
-        module = trace._module;
-        cd = [];
+        var trace = fullData[i],
+            _module = trace._module,
+            cd = [];
 
-        if(module && trace.visible === true) {
-            if(module.calc) cd = module.calc(gd, trace);
+        if(_module && trace.visible === true) {
+            if(_module.calc) cd = _module.calc(gd, trace);
         }
 
         // make sure there is a first point
@@ -1555,7 +1554,7 @@ Plotly.restyle = function restyle(gd, astr, val, traces) {
 
     if(isNumeric(traces)) traces = [traces];
     else if(!Array.isArray(traces) || !traces.length) {
-        traces = gd._fullData.map(function(v, i) { return i; });
+        traces = gd.data.map(function(v, i) { return i; });
     }
 
     // recalcAttrs attributes need a full regeneration of calcdata
@@ -1730,6 +1729,9 @@ Plotly.restyle = function restyle(gd, astr, val, traces) {
             continue;
         }
 
+        // take no chances on transforms
+        if(ai.substr(0, 10) === 'transforms') docalc = true;
+
         // set attribute in gd.data
         undoit[ai] = a0();
         for(i = 0; i < traces.length; i++) {

src/plot_api/plot_schema.js

@@ -29,6 +29,7 @@ var UNDERSCORE_ATTRS = [IS_SUBPLOT_OBJ, IS_LINKED_TO_ARRAY, DEPRECATED];
 var plotSchema = {
     traces: {},
     layout: {},
+    transforms: {},
     defs: {}
 };
 
@@ -45,7 +46,11 @@ PlotSchema.get = function() {
         .forEach(getTraceAttributes);
 
     getLayoutAttributes();
+
+    Object.keys(Plots.transformsRegistry).forEach(getTransformAttributes);
+
     getDefs();
+
     return plotSchema;
 };
 
@@ -136,6 +141,18 @@ function getLayoutAttributes() {
     plotSchema.layout = { layoutAttributes: layoutAttributes };
 }
 
+function getTransformAttributes(name) {
+    var _module = Plots.transformsRegistry[name],
+        _schema = {};
+
+    _schema = coupleAttrs(_schema, _module.attributes || {}, 'attributes', '*');
+    _schema = removeUnderscoreAttrs(_schema);
+    mergeValTypeAndRole(_schema);
+    handleLinkedToArray(_schema);
+
+    plotSchema.transforms[name] = { attributes: _schema };
+}
+
 function getDefs() {
     plotSchema.defs = {
         valObjects: Lib.valObjects,

src/plot_api/validate.js

@@ -102,6 +102,39 @@ module.exports = function valiate(data, layout) {
         }
 
         crawl(traceIn, traceOut, traceSchema, errorList, base);
+
+        var transformsIn = traceIn.transforms,
+            transformsOut = traceOut.transforms;
+
+        if(transformsIn) {
+            if(!isArray(transformsIn)) {
+                errorList.push(format('array', base, ['transforms']));
+            }
+
+            base.push('transforms');
+
+            for(var j = 0; j < transformsIn.length; j++) {
+                var path = ['transforms', j],
+                    transformType = transformsIn[j].type;
+
+                if(!isPlainObject(transformsIn[j])) {
+                    errorList.push(format('object', base, path));
+                    continue;
+                }
+
+                var transformSchema = schema.transforms[transformType] ?
+                    schema.transforms[transformType].attributes :
+                    {};
+
+                // add 'type' to transform schema to validate the transform type
+                transformSchema.type = {
+                    valType: 'enumerated',
+                    values: Object.keys(schema.transforms)
+                };
+
+                crawl(transformsIn[j], transformsOut[j], transformSchema, errorList, base, path);
+            }
+        }
     }
 
     var layoutOut = gd._fullLayout,
@@ -121,6 +154,9 @@ function crawl(objIn, objOut, schema, list, base, path) {
     for(var i = 0; i < keys.length; i++) {
         var k = keys[i];
 
+        // transforms are handled separately
+        if(k === 'transforms') continue;
+
         var p = path.slice();
         p.push(k);
 
@@ -184,7 +220,7 @@ var code2msgFunc = {
         var prefix;
 
         if(base === 'layout' && astr === '') prefix = 'The layout argument';
-        else if(base[0] === 'data') {
+        else if(base[0] === 'data' && astr === '') {
             prefix = 'Trace ' + base[1] + ' in the data argument';
         }
         else prefix = inBase(base) + 'key ' + astr;

src/plotly.js

@@ -22,7 +22,7 @@
 require('es6-promise').polyfill();
 
 // lib functions
-exports.Lib = require('./lib');
+var Lib = exports.Lib = require('./lib');
 exports.util = require('./lib/svg_text_utils');
 exports.Queue = require('./lib/queue');
 
@@ -55,21 +55,51 @@ exports.ModeBar = require('./components/modebar');
 exports.register = function register(_modules) {
     if(!_modules) {
         throw new Error('No argument passed to Plotly.register.');
-    } else if(_modules && !Array.isArray(_modules)) {
+    }
+    else if(_modules && !Array.isArray(_modules)) {
         _modules = [_modules];
     }
 
     for(var i = 0; i < _modules.length; i++) {
         var newModule = _modules[i];
 
-        if(newModule && newModule.moduleType !== 'trace') {
+        if(!newModule) {
             throw new Error('Invalid module was attempted to be registered!');
-        } else {
-            Plots.register(newModule, newModule.name, newModule.categories, newModule.meta);
+        }
+
+        switch(newModule.moduleType) {
+            case 'trace':
+                Plots.register(newModule, newModule.name, newModule.categories, newModule.meta);
+
+                if(!Plots.subplotsRegistry[newModule.basePlotModule.name]) {
+                    Plots.registerSubplot(newModule.basePlotModule);
+                }
+
+                break;
+
+            case 'transform':
+                if(typeof newModule.name !== 'string') {
+                    throw new Error('Transform module *name* must be a string.');
+                }
+
+                var prefix = 'Transform module ' + newModule.name;
+
+                if(typeof newModule.transform !== 'function') {
+                    throw new Error(prefix + ' is missing a *transform* function.');
+                }
+                if(!Lib.isPlainObject(newModule.attributes)) {
+                    Lib.log(prefix + ' registered without an *attributes* object.');
+                }
+                if(typeof newModule.supplyDefaults !== 'function') {
+                    Lib.log(prefix + ' registered without a *supplyDefaults* function.');
+                }
+
+                Plots.transformsRegistry[newModule.name] = newModule;
+
+                break;
 
-            if(!Plots.subplotsRegistry[newModule.basePlotModule.name]) {
-                Plots.registerSubplot(newModule.basePlotModule);
-            }
+            default:
+                throw new Error('Invalid module was attempted to be registered!');
         }
     }
 };