Dynamic behavior draft

(cherry picked from commit ebf6e9f)

Author: mboorstin

src/plot_api/plot_api.js

@@ -54,6 +54,9 @@ var numericNameWarningCountLimit = 5;
  *      all the stuff that doesn't pertain to any individual trace
  * @param {object} config
  *      configuration options (see ./plot_config.js for more info)
+ * @param {object} dynamicBehavior
+ *      object containing Javascript functions that mirror the behavior of options
+ *      in data, layout, and config.
  *
  * OR
  *
@@ -63,7 +66,7 @@ var numericNameWarningCountLimit = 5;
  *      object containing `data`, `layout`, `config`, and `frames` members
  *
  */
-function plot(gd, data, layout, config) {
+function plot(gd, data, layout, config, dynamicBehavior) {
     var frames;
 
     gd = Lib.getGraphDiv(gd);
@@ -79,7 +82,7 @@ function plot(gd, data, layout, config) {
         frames = obj.frames;
     }
 
-    var okToPlot = Events.triggerHandler(gd, 'plotly_beforeplot', [data, layout, config]);
+    var okToPlot = Events.triggerHandler(gd, 'plotly_beforeplot', [data, layout, config, dynamicBehavior]);
     if(okToPlot === false) return Promise.reject();
 
     // if there's no data or layout, and this isn't yet a plotly plot
@@ -88,6 +91,8 @@ function plot(gd, data, layout, config) {
         Lib.warn('Calling Plotly.plot as if redrawing ' +
             'but this container doesn\'t yet have a plot.', gd);
     }
+    
+    gd.dynamicBehavior = dynamicBehavior || {};
 
     function addFrames() {
         if(frames) {
@@ -97,7 +102,7 @@ function plot(gd, data, layout, config) {
 
     // transfer configuration options to gd until we move over to
     // a more OO like model
-    setPlotContext(gd, config);
+    setPlotContext(gd, config, dynamicBehavior.config);
 
     if(!layout) layout = {};
 
@@ -136,7 +141,7 @@ function plot(gd, data, layout, config) {
         gd.layout = helpers.cleanLayout(layout);
     }
 
-    Plots.supplyDefaults(gd);
+    Plots.supplyDefaults(gd, dynamicBehavior);
 
     var fullLayout = gd._fullLayout;
     var hasCartesian = fullLayout._has('cartesian');
@@ -405,7 +410,7 @@ function opaqueSetBackground(gd, bgColor) {
     setBackground(gd, blend);
 }
 
-function setPlotContext(gd, config) {
+function setPlotContext(gd, config, dynamicConfig) {
     if(!gd._context) {
         gd._context = Lib.extendDeep({}, dfltConfig);
 
@@ -434,6 +439,17 @@ function setPlotContext(gd, config) {
             }
         }
 
+        if (dynamicConfig) {
+            keys = Object.keys(dynamicConfig);
+            for(i = 0; i < keys.length; i++) {
+                key = keys[i];
+                // Prefer dynamic functions over static options
+                if(key in context && typeof dynamicConfig[key] === 'function') {
+                    context[key] = dynamicConfig[key];
+                }
+            }
+        }
+
         // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
         if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
             context.plotGlPixelRatio = context.plot3dPixelRatio;
@@ -631,15 +647,16 @@ function redraw(gd) {
  * @param {Object[]} data
  * @param {Object} layout
  * @param {Object} config
+ * @param {Object} dynamicBehavior
  */
-function newPlot(gd, data, layout, config) {
+function newPlot(gd, data, layout, config, dynamicBehavior) {
     gd = Lib.getGraphDiv(gd);
 
     // remove gl contexts
     Plots.cleanPlot([], {}, gd._fullData || [], gd._fullLayout || {});
 
     Plots.purge(gd);
-    return exports.plot(gd, data, layout, config);
+    return exports.plot(gd, data, layout, config, dynamicBehavior);
 }
 
 /**
@@ -2338,6 +2355,8 @@ function update(gd, traceUpdate, layoutUpdate, _traces) {
     gd = Lib.getGraphDiv(gd);
     helpers.clearPromiseQueue(gd);
 
+    var dynamicBehavior = gd.dynamicBehavior;
+
     if(gd.framework && gd.framework.isPolar) {
         return Promise.resolve(gd);
     }
@@ -2371,7 +2390,7 @@ function update(gd, traceUpdate, layoutUpdate, _traces) {
         seq.push(exports.plot);
     } else {
         seq.push(Plots.previousPromises);
-        axRangeSupplyDefaultsByPass(gd, relayoutFlags, relayoutSpecs) || Plots.supplyDefaults(gd);
+        axRangeSupplyDefaultsByPass(gd, relayoutFlags, relayoutSpecs) || Plots.supplyDefaults(gd, dynamicBehavior);
 
         if(restyleFlags.style) seq.push(subroutines.doTraceStyle);
         if(restyleFlags.colorbars || relayoutFlags.colorbars) seq.push(subroutines.doColorBars);

src/plot_api/subroutines.js

@@ -536,7 +536,7 @@ exports.doColorBars = function(gd) {
 exports.layoutReplot = function(gd) {
     var layout = gd.layout;
     gd.layout = undefined;
-    return Registry.call('plot', gd, '', layout);
+    return Registry.call('plot', gd, '', layout, gd.dynamicBehavior);
 };
 
 exports.doLegend = function(gd) {

src/plots/cartesian/axes.js

@@ -1316,6 +1316,9 @@ function numFormat(v, ax, fmtoverride, hover) {
     var tickformat = axes.getTickFormat(ax);
     var separatethousands = ax.separatethousands;
 
+    // Dynamic tickformat function
+    if(typeof tickformat === 'function') return tickformat(v);
+
     // special case for hover: set exponent just for this value, and
     // add a couple more digits of precision over tick labels
     if(hover) {

src/plots/plots.js

@@ -235,6 +235,28 @@ plots.sendDataToCloud = function(gd) {
     return false;
 };
 
+// Recursively copy any function properties of b into a if a
+// already has the corresponding key.
+// If a = {key1: "val1", key2: "val2"} and b = {key1: func1, key3: func2},
+// sets a to {key1: func1, key2: "val2"}.
+function recursivelyCopyFunctions(a, b) {
+    if(!b) return;
+
+    Object.keys(a).forEach(function(key) {
+        // If a[key] and b[key] are objects, recurse down.
+        // Note that typeof returns 'object' on arrays.
+        if(typeof a[key] === 'object') {
+            if(typeof b[key] === 'object') {
+                recursivelyCopyFunctions(a[key], b[key]);
+            }
+        // If a[key] is anything besides an object and
+        // b[key] is a funciton, replace a[key] with b[key]
+        } else if(typeof b[key] === 'function') {
+            a[key] = b[key];
+        }
+    });
+}
+
 var d3FormatKeys = [
     'days', 'shortDays', 'months', 'shortMonths', 'periods',
     'dateTime', 'date', 'time',
@@ -277,10 +299,12 @@ var extraFormatKeys = [
  *   is a list of all the transform modules invoked.
  *
  */
-plots.supplyDefaults = function(gd, opts) {
+plots.supplyDefaults = function(gd, opts, dynamicBehavior) {
     var skipUpdateCalc = opts && opts.skipUpdateCalc;
     var oldFullLayout = gd._fullLayout || {};
 
+    dynamicBehavior = dynamicBehavior || {};
+
     if(oldFullLayout._skipDefaults) {
         delete oldFullLayout._skipDefaults;
         return;
@@ -425,7 +449,7 @@ plots.supplyDefaults = function(gd, opts) {
         }
     }
 
-    // finally, fill in the pieces of layout that may need to look at data
+    // fill in the pieces of layout that may need to look at data
     plots.supplyLayoutModuleDefaults(newLayout, newFullLayout, newFullData, gd._transitionData);
 
     // Special cases that introduce interactions between traces.
@@ -465,6 +489,10 @@ plots.supplyDefaults = function(gd, opts) {
     // relink / initialize subplot axis objects
     plots.linkSubplots(newFullData, newFullLayout, oldFullData, oldFullLayout);
 
+    // finally, fill in any functions from dynamicBehavior.data and .layout
+    recursivelyCopyFunctions(newFullData, dynamicBehavior.data);
+    recursivelyCopyFunctions(newFullLayout, dynamicBehavior.layout);
+
     // clean subplots and other artifacts from previous plot calls
     plots.cleanPlot(newFullData, newFullLayout, oldFullData, oldFullLayout);