use editTypes for contour/contourcarpet-specific attributes

alexcjohnson · alexcjohnson · commit e5a2f91e0c5e · 2017-06-27T18:03:45.000-04:00
and validate `editTypes` in plotschema_test - one more step to cleaning
the morass of attribute string literals out of restyle/relayout
diff --git a/src/plot_api/edit_types.js b/src/plot_api/edit_types.js
@@ -0,0 +1,84 @@
+/**
+* Copyright 2012-2017, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var isPlainObject = require('../lib/is_plain_object');
+
+module.exports = {
+    /*
+     * default (all false) edit flags for restyle (traces)
+     * creates a new object each call, so the caller can mutate freely
+     */
+    traces: function() {
+        return {
+            docalc: false,
+            docalcAutorange: false,
+            doplot: false,
+            dostyle: false,
+            docolorbars: false,
+            autorangeOn: false,
+            clearCalc: false,
+            fullReplot: false
+        };
+    },
+
+    /*
+     * default (all false) edit flags for relayout
+     * creates a new object each call, so the caller can mutate freely
+     */
+    layout: function() {
+        return {
+            dolegend: false,
+            doticks: false,
+            dolayoutstyle: false,
+            doplot: false,
+            docalc: false,
+            domodebar: false,
+            docamera: false,
+            layoutReplot: false
+        };
+    },
+
+    /*
+     * update `flags` with the `editType` values found in `attr`
+     *
+     * If `attr` itself contains an `editType`, we just use that.
+     * If it doesn't, we recurse into any other objects contained
+     * in `attr` and update with all `editType` values found in
+     * *any* of them.
+     *
+     * So container objects may not need their own `editType`,
+     * if they're content to delegate to their members, but they
+     * may provide one either for performance or, in case of arrays,
+     * if adding/removing entries requires different flags than
+     * simply changing attributes of an existing entry.
+     */
+    update: function(flags, attr) {
+        function extend(attr1) {
+            var editType = attr1.editType;
+            if(editType === undefined) {
+                // if there's no editType defined, recurse into
+                Object.keys(attr1).forEach(function(attrName) {
+                    var attr2 = attr1[attrName];
+                    if(attrName.charAt(0) !== '_' && isPlainObject(attr2)) {
+                        extend(attr2);
+                    }
+                });
+            }
+            else {
+                var editTypeParts = editType.split('+');
+                editTypeParts.forEach(function(part) {
+                    flags[part] = true;
+                });
+            }
+        }
+
+        extend(attr);
+    }
+};
diff --git a/src/plot_api/plot_api.js b/src/plot_api/plot_api.js
@@ -31,6 +31,8 @@ var svgTextUtils = require('../lib/svg_text_utils');
 var manageArrays = require('./manage_arrays');
 var helpers = require('./helpers');
 var subroutines = require('./subroutines');
+var editTypes = require('./edit_types');
+
 var cartesianConstants = require('../plots/cartesian/constants');
 var axisConstraints = require('../plots/cartesian/constraints');
 var enforceAxisConstraints = axisConstraints.enforce;
@@ -1264,16 +1266,7 @@ function _restyle(gd, aobj, _traces) {
     var traces = helpers.coerceTraceIndices(gd, _traces);
 
     // initialize flags
-    var flags = {
-        docalc: false,
-        docalcAutorange: false,
-        doplot: false,
-        dostyle: false,
-        docolorbars: false,
-        autorangeOn: false,
-        clearCalc: false,
-        fullReplot: false
-    };
+    var flags = editTypes.traces();
 
     // copies of the change (and previous values of anything affected)
     // for the undo / redo queue
@@ -1304,8 +1297,6 @@ function _restyle(gd, aobj, _traces) {
         'reversescale', 'marker.reversescale',
         'autobinx', 'nbinsx', 'xbins', 'xbins.start', 'xbins.end', 'xbins.size',
         'autobiny', 'nbinsy', 'ybins', 'ybins.start', 'ybins.end', 'ybins.size',
-        'autocontour', 'ncontours', 'contours', 'contours.coloring',
-        'contours.operation', 'contours.value', 'contours.type', 'contours.value[0]', 'contours.value[1]',
         'error_y', 'error_y.visible', 'error_y.value', 'error_y.type',
         'error_y.traceref', 'error_y.array', 'error_y.symmetric',
         'error_y.arrayminus', 'error_y.valueminus', 'error_y.tracerefminus',
@@ -1373,9 +1364,6 @@ function _restyle(gd, aobj, _traces) {
         'marker.cmin', 'marker.cmax', 'marker.cauto',
         'line.cmin', 'line.cmax',
         'marker.line.cmin', 'marker.line.cmax',
-        'contours.start', 'contours.end', 'contours.size',
-        'contours.showlines', 'contours.showlabels', 'contours.labelformat',
-        'contours.font', 'contours.font.family', 'contours.font.size',
         'line', 'line.smoothing', 'line.shape',
         'error_y.width', 'error_x.width', 'error_x.copy_ystyle',
         'marker.maxdisplayed'
@@ -1620,23 +1608,35 @@ function _restyle(gd, aobj, _traces) {
                 flags.docalc = true;
             }
             else {
-                var moduleAttrs = (contFull._module || {}).attributes || {};
-                var valObject = Lib.nestedProperty(moduleAttrs, ai).get() ||
-                    Lib.nestedProperty(Plots.attributes, ai).get() ||
-                    {};
+                var aiHead = param.parts[0];
+                var moduleAttrs = (contFull._module || {}).attributes;
+                var valObject = moduleAttrs && moduleAttrs[aiHead];
+                if(!valObject) valObject = Plots.attributes[aiHead];
+                if(valObject) {
+                    /*
+                     * In occasional cases we can't the innermost valObject
+                     * doesn't exist, for example `valType: 'any'` items like
+                     * contourcarpet `contours.value` where we might set
+                     * `contours.value[0]`. In that case, stop at the deepest
+                     * valObject we *do* find.
+                     */
+                    for(var parti = 1; parti < param.parts.length; parti++) {
+                        var newValObject = valObject[param.parts[parti]];
+                        if(newValObject) valObject = newValObject;
+                        else break;
+                    }
 
-                // if restyling entire attribute container, assume worse case
-                if(!valObject.valType) {
-                    flags.docalc = true;
-                }
+                    // must redo calcdata when restyling array values of arrayOk attributes
+                    if(valObject.arrayOk && (Array.isArray(newVal) || Array.isArray(oldVal))) {
+                        flags.docalc = true;
+                    }
 
-                // must redo calcdata when restyling array values of arrayOk attributes
-                if(valObject.arrayOk && (Array.isArray(newVal) || Array.isArray(oldVal))) {
-                    flags.docalc = true;
+                    // some attributes declare an 'editType' flaglist
+                    editTypes.update(flags, valObject);
                 }
-
-                // some attributes declare an 'editType' flaglist
-                if(valObject.editType === 'docalc') {
+                else {
+                    // if we couldn't find valObject even at the root,
+                    // assume a full recalc.
                     flags.docalc = true;
                 }
 
@@ -1864,16 +1864,7 @@ function _relayout(gd, aobj) {
     }
 
     // initialize flags
-    var flags = {
-        dolegend: false,
-        doticks: false,
-        dolayoutstyle: false,
-        doplot: false,
-        docalc: false,
-        domodebar: false,
-        docamera: false,
-        layoutReplot: false
-    };
+    var flags = editTypes.layout();
 
     // copies of the change (and previous values of anything affected)
     // for the undo / redo queue
diff --git a/src/plot_api/plot_schema.js b/src/plot_api/plot_schema.js
@@ -21,6 +21,8 @@ var animationAttributes = require('../plots/animation_attributes');
 var polarAreaAttrs = require('../plots/polar/area_attributes');
 var polarAxisAttrs = require('../plots/polar/axis_attributes');
 
+var editTypes = require('./edit_types');
+
 var extendFlat = Lib.extendFlat;
 var extendDeep = Lib.extendDeep;
 
@@ -62,7 +64,11 @@ exports.get = function() {
     return {
         defs: {
             valObjects: Lib.valObjects,
-            metaKeys: UNDERSCORE_ATTRS.concat(['description', 'role'])
+            metaKeys: UNDERSCORE_ATTRS.concat(['description', 'role']),
+            editTypes: {
+                traces: editTypes.traces(),
+                layout: editTypes.layout()
+            }
         },
 
         traces: traces,
diff --git a/src/traces/contour/attributes.js b/src/traces/contour/attributes.js
@@ -37,6 +37,7 @@ module.exports = extendFlat({}, {
         valType: 'boolean',
         dflt: true,
         role: 'style',
+        editType: 'docalc',
         description: [
             'Determines whether or not the contour level attributes are',
             'picked by an algorithm.',
@@ -49,6 +50,7 @@ module.exports = extendFlat({}, {
         dflt: 15,
         min: 1,
         role: 'style',
+        editType: 'docalc',
         description: [
             'Sets the maximum number of contour levels. The actual number',
             'of contours will be chosen automatically to be less than or',
@@ -63,6 +65,7 @@ module.exports = extendFlat({}, {
             valType: 'number',
             dflt: null,
             role: 'style',
+            editType: 'doplot',
             description: [
                 'Sets the starting contour level value.',
                 'Must be less than `contours.end`'
@@ -72,6 +75,7 @@ module.exports = extendFlat({}, {
             valType: 'number',
             dflt: null,
             role: 'style',
+            editType: 'doplot',
             description: [
                 'Sets the end contour level value.',
                 'Must be more than `contours.start`'
@@ -82,6 +86,7 @@ module.exports = extendFlat({}, {
             dflt: null,
             min: 0,
             role: 'style',
+            editType: 'doplot',
             description: [
                 'Sets the step between each contour level.',
                 'Must be positive.'
@@ -92,6 +97,7 @@ module.exports = extendFlat({}, {
             values: ['fill', 'heatmap', 'lines', 'none'],
             dflt: 'fill',
             role: 'style',
+            editType: 'docalc',
             description: [
                 'Determines the coloring method showing the contour values.',
                 'If *fill*, coloring is done evenly between each contour level',
@@ -105,6 +111,7 @@ module.exports = extendFlat({}, {
             valType: 'boolean',
             dflt: true,
             role: 'style',
+            editType: 'doplot',
             description: [
                 'Determines whether or not the contour lines are drawn.',
                 'Has an effect only if `contours.coloring` is set to *fill*.'
@@ -114,6 +121,7 @@ module.exports = extendFlat({}, {
             valType: 'boolean',
             dflt: false,
             role: 'style',
+            editType: 'doplot',
             description: [
                 'Determines whether to label the contour lines with their values.'
             ].join(' ')
@@ -123,12 +131,16 @@ module.exports = extendFlat({}, {
                 'Sets the font used for labeling the contour levels.',
                 'The default color comes from the lines, if shown.',
                 'The default family and size come from `layout.font`.'
-            ].join(' ')
+            ].join(' '),
+            family: extendFlat({}, fontAttrs.family, {editType: 'doplot'}),
+            size: extendFlat({}, fontAttrs.size, {editType: 'doplot'}),
+            color: extendFlat({}, fontAttrs.color, {editType: 'dostyle'})
         }),
         labelformat: {
             valType: 'string',
             dflt: '',
             role: 'style',
+            editType: 'doplot',
             description: [
                 'Sets the contour label formatting rule using d3 formatting',
                 'mini-language which is very similar to Python, see:',
@@ -141,7 +153,7 @@ module.exports = extendFlat({}, {
         color: extendFlat({}, scatterLineAttrs.color, {
             description: [
                 'Sets the color of the contour level.',
-                'Has no if `contours.coloring` is set to *lines*.'
+                'Has no effect if `contours.coloring` is set to *lines*.'
             ].join(' ')
         }),
         width: scatterLineAttrs.width,
diff --git a/src/traces/contourcarpet/attributes.js b/src/traces/contourcarpet/attributes.js
@@ -69,6 +69,7 @@ module.exports = extendFlat({}, {
             values: ['levels', 'constraint'],
             dflt: 'levels',
             role: 'info',
+            editType: 'docalc',
             description: [
                 'If `levels`, the data is represented as a contour plot with multiple',
                 'levels displayed. If `constraint`, the data is represented as constraints',
@@ -85,6 +86,7 @@ module.exports = extendFlat({}, {
             values: ['fill', 'lines', 'none'],
             dflt: 'fill',
             role: 'style',
+            editType: 'docalc',
             description: [
                 'Determines the coloring method showing the contour values.',
                 'If *fill*, coloring is done evenly between each contour level',
@@ -101,6 +103,7 @@ module.exports = extendFlat({}, {
             values: [].concat(constants.INEQUALITY_OPS).concat(constants.INTERVAL_OPS).concat(constants.SET_OPS),
             role: 'info',
             dflt: '=',
+            editType: 'docalc',
             description: [
                 'Sets the filter operation.',
 
@@ -127,6 +130,7 @@ module.exports = extendFlat({}, {
             valType: 'any',
             dflt: 0,
             role: 'info',
+            editType: 'docalc',
             description: [
                 'Sets the value or values by which to filter by.',
 
diff --git a/test/jasmine/tests/plot_api_test.js b/test/jasmine/tests/plot_api_test.js
diff --git a/test/jasmine/tests/plotschema_test.js b/test/jasmine/tests/plotschema_test.js
