Simplify map trace colorbar edit types

Author: yqtian-se

draftlogs/5616_fix.md

@@ -0,0 +1 @@
+- Preserve `colorbars` edit types for colorbar attributes on map traces [[#7864](https://github.com/plotly/plotly.js/pull/7864)]

draftlogs/7864_fix.md

@@ -19,39 +19,7 @@ const breakingChangeWarning = [
     'Country names in existing plots may not work in the new version.'
 ].join(' ');
 
-function restoreColorbarEditTypes(attrs) {
-    function restoreEditTypes(obj) {
-        for(var key in obj) {
-            var val = obj[key];
-            if(val && typeof val === 'object') {
-                if(val.editType === 'calc') {
-                    val.editType = 'colorbars';
-                }
-                if(!val.valType) {
-                    restoreEditTypes(val);
-                }
-                if(Array.isArray(val.items)) {
-                    for(var i = 0; i < val.items.length; i++) {
-                        if(val.items[i] && typeof val.items[i] === 'object') {
-                            if(val.items[i].editType === 'calc') {
-                                val.items[i].editType = 'colorbars';
-                            }
-                            if(!val.items[i].valType) {
-                                restoreEditTypes(val.items[i]);
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-    if(attrs && attrs.marker && attrs.marker.colorbar) {
-        restoreEditTypes(attrs.marker.colorbar);
-    }
-    return attrs;
-}
-
-module.exports = restoreColorbarEditTypes(overrideAll(
+var attrs = overrideAll(
     {
         lon: {
             valType: 'data_array',
@@ -207,4 +175,8 @@ module.exports = restoreColorbarEditTypes(overrideAll(
     },
     'calc',
     'nested'
-));
+);
+
+attrs.marker.colorbar = require('../../components/colorbar/attributes');
+
+module.exports = attrs;

src/traces/scattergeo/attributes.js

@@ -15,39 +15,7 @@ var mapLayoutAtributes = require('../../plots/map/layout_attributes');
 var lineAttrs = scatterGeoAttrs.line;
 var markerAttrs = scatterGeoAttrs.marker;
 
-function restoreColorbarEditTypes(attrs) {
-    function restoreEditTypes(obj) {
-        for(var key in obj) {
-            var val = obj[key];
-            if(val && typeof val === 'object') {
-                if(val.editType === 'calc') {
-                    val.editType = 'colorbars';
-                }
-                if(!val.valType) {
-                    restoreEditTypes(val);
-                }
-                if(Array.isArray(val.items)) {
-                    for(var i = 0; i < val.items.length; i++) {
-                        if(val.items[i] && typeof val.items[i] === 'object') {
-                            if(val.items[i].editType === 'calc') {
-                                val.items[i].editType = 'colorbars';
-                            }
-                            if(!val.items[i].valType) {
-                                restoreEditTypes(val.items[i]);
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-    if(attrs && attrs.marker && attrs.marker.colorbar) {
-        restoreEditTypes(attrs.marker.colorbar);
-    }
-    return attrs;
-}
-
-module.exports = restoreColorbarEditTypes(overrideAll(
+var attrs = overrideAll(
     {
         lon: scatterGeoAttrs.lon,
         lat: scatterGeoAttrs.lat,
@@ -209,4 +177,8 @@ module.exports = restoreColorbarEditTypes(overrideAll(
     },
     'calc',
     'nested'
-));
+);
+
+attrs.marker.colorbar = require('../../components/colorbar/attributes');
+
+module.exports = attrs;

src/traces/scattermap/attributes.js

@@ -15,39 +15,7 @@ var mapboxLayoutAtributes = require('../../plots/mapbox/layout_attributes');
 var lineAttrs = scatterGeoAttrs.line;
 var markerAttrs = scatterGeoAttrs.marker;
 
-function restoreColorbarEditTypes(attrs) {
-    function restoreEditTypes(obj) {
-        for(var key in obj) {
-            var val = obj[key];
-            if(val && typeof val === 'object') {
-                if(val.editType === 'calc') {
-                    val.editType = 'colorbars';
-                }
-                if(!val.valType) {
-                    restoreEditTypes(val);
-                }
-                if(Array.isArray(val.items)) {
-                    for(var i = 0; i < val.items.length; i++) {
-                        if(val.items[i] && typeof val.items[i] === 'object') {
-                            if(val.items[i].editType === 'calc') {
-                                val.items[i].editType = 'colorbars';
-                            }
-                            if(!val.items[i].valType) {
-                                restoreEditTypes(val.items[i]);
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-    if(attrs && attrs.marker && attrs.marker.colorbar) {
-        restoreEditTypes(attrs.marker.colorbar);
-    }
-    return attrs;
-}
-
-module.exports = restoreColorbarEditTypes(overrideAll(
+var attrs = overrideAll(
     {
         lon: scatterGeoAttrs.lon,
         lat: scatterGeoAttrs.lat,
@@ -209,4 +177,8 @@ module.exports = restoreColorbarEditTypes(overrideAll(
     },
     'calc',
     'nested'
-));
+);
+
+attrs.marker.colorbar = require('../../components/colorbar/attributes');
+
+module.exports = attrs;

src/traces/scattermapbox/attributes.js

@@ -0,0 +1,31 @@
+var traceAttrs = {
+    scattergeo: require('../../../src/traces/scattergeo/attributes'),
+    scattermap: require('../../../src/traces/scattermap/attributes'),
+    scattermapbox: require('../../../src/traces/scattermapbox/attributes')
+};
+
+describe('map trace colorbar edit types', function() {
+    'use strict';
+
+    Object.keys(traceAttrs).forEach(function(name) {
+        var attrs = traceAttrs[name];
+
+        it(name + ' should preserve colorbar edit types', function() {
+            function assertColorbarEditTypes(obj, path) {
+                Object.keys(obj).forEach(function(key) {
+                    var val = obj[key];
+                    var attrPath = path ? path + '.' + key : key;
+
+                    if(val && typeof val === 'object') {
+                        if(val.editType) {
+                            expect(val.editType).withContext(attrPath).toBe('colorbars');
+                        }
+                        if(!val.valType) assertColorbarEditTypes(val, attrPath);
+                    }
+                });
+            }
+
+            assertColorbarEditTypes(attrs.marker.colorbar, 'marker.colorbar');
+        });
+    });
+});

test/jasmine/tests/colorbar_edit_types_test.js

@@ -67535,7 +67535,7 @@
               },
               "valType": "any"
             },
-            "editType": "calc",
+            "editType": "colorbars",
             "exponentformat": {
               "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
               "dflt": "B",
@@ -72317,7 +72317,7 @@
               },
               "valType": "any"
             },
-            "editType": "calc",
+            "editType": "colorbars",
             "exponentformat": {
               "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
               "dflt": "B",
@@ -73873,7 +73873,7 @@
               },
               "valType": "any"
             },
-            "editType": "calc",
+            "editType": "colorbars",
             "exponentformat": {
               "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
               "dflt": "B",