fixup template defaults and modebar attributes

Author: archmoj

src/components/modebar/attributes.js

@@ -3,62 +3,58 @@
 module.exports = {
     editType: 'modebar',
 
-    modebar: {
+    orientation: {
+        valType: 'enumerated',
+        values: ['v', 'h'],
+        dflt: 'h',
         editType: 'modebar',
-
-        orientation: {
-            valType: 'enumerated',
-            values: ['v', 'h'],
-            dflt: 'h',
-            editType: 'modebar',
-            description: 'Sets the orientation of the modebar.'
-        },
-        bgcolor: {
-            valType: 'color',
-            editType: 'modebar',
-            description: 'Sets the background color of the modebar.'
-        },
-        color: {
-            valType: 'color',
-            editType: 'modebar',
-            description: 'Sets the color of the icons in the modebar.'
-        },
-        activecolor: {
-            valType: 'color',
-            editType: 'modebar',
-            description: 'Sets the color of the active or hovered on icons in the modebar.'
-        },
-        uirevision: {
-            valType: 'any',
-            editType: 'none',
-            description: [
-                'Controls persistence of user-driven changes related to the modebar,',
-                'including `hovermode`, `dragmode`, and `showspikes` at both the',
-                'root level and inside subplots. Defaults to `layout.uirevision`.'
-            ].join(' ')
-        },
-        buttonstoadd: {
-            valType: 'flaglist',
-            flags: [
-                'v1hovermode',
-                'hoverclosest',
-                'hovercompare',
-                'togglehover',
-                'togglespikelines',
-                'drawclosedpath',
-                'drawopenpath',
-                'drawline',
-                'drawrect',
-                'drawcircle',
-                'eraseshape',
-            ],
-            dflt: '',
-            editType: 'modebar',
-            description: [
-                'Determines which predefined modebar buttons to add.',
-                'Please note that these buttons will only be shown if they are compatible',
-                'with all trace types used in a graph.'
-            ].join(' ')
-        }
+        description: 'Sets the orientation of the modebar.'
+    },
+    bgcolor: {
+        valType: 'color',
+        editType: 'modebar',
+        description: 'Sets the background color of the modebar.'
+    },
+    color: {
+        valType: 'color',
+        editType: 'modebar',
+        description: 'Sets the color of the icons in the modebar.'
+    },
+    activecolor: {
+        valType: 'color',
+        editType: 'modebar',
+        description: 'Sets the color of the active or hovered on icons in the modebar.'
+    },
+    uirevision: {
+        valType: 'any',
+        editType: 'none',
+        description: [
+            'Controls persistence of user-driven changes related to the modebar,',
+            'including `hovermode`, `dragmode`, and `showspikes` at both the',
+            'root level and inside subplots. Defaults to `layout.uirevision`.'
+        ].join(' ')
+    },
+    buttonstoadd: {
+        valType: 'flaglist',
+        flags: [
+            'v1hovermode',
+            'hoverclosest',
+            'hovercompare',
+            'togglehover',
+            'togglespikelines',
+            'drawclosedpath',
+            'drawopenpath',
+            'drawline',
+            'drawrect',
+            'drawcircle',
+            'eraseshape',
+        ],
+        dflt: '',
+        editType: 'modebar',
+        description: [
+            'Determines which predefined modebar buttons to add.',
+            'Please note that these buttons will only be shown if they are compatible',
+            'with all trace types used in a graph.'
+        ].join(' ')
     }
 };

src/components/modebar/defaults.js

@@ -2,18 +2,22 @@
 
 var Lib = require('../../lib');
 var Color = require('../color');
+var Template = require('../../plot_api/plot_template');
 var attributes = require('./attributes');
 
 module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
+    var containerIn = layoutIn.modebar || {};
+    var containerOut = Template.newContainer(layoutOut, 'modebar');
+
     function coerce(attr, dflt) {
-        return Lib.coerce(layoutIn, layoutOut, attributes, attr, dflt);
+        return Lib.coerce(containerIn, containerOut, attributes, attr, dflt);
     }
 
-    coerce('modebar.orientation');
-    coerce('modebar.bgcolor', Color.addOpacity(layoutOut.paper_bgcolor, 0.5));
+    coerce('orientation');
+    coerce('bgcolor', Color.addOpacity(layoutOut.paper_bgcolor, 0.5));
     var defaultColor = Color.contrast(Color.rgb(layoutOut.modebar.bgcolor));
-    coerce('modebar.color', Color.addOpacity(defaultColor, 0.3));
-    coerce('modebar.activecolor', Color.addOpacity(defaultColor, 0.7));
-    coerce('modebar.uirevision', layoutOut.uirevision);
-    coerce('modebar.buttonstoadd');
+    coerce('color', Color.addOpacity(defaultColor, 0.3));
+    coerce('activecolor', Color.addOpacity(defaultColor, 0.7));
+    coerce('uirevision', layoutOut.uirevision);
+    coerce('buttonstoadd');
 };

test/jasmine/tests/modebar_test.js

@@ -1560,7 +1560,7 @@ describe('ModeBar', function() {
             .then(done, done.fail);
         });
 
-        it('add and remove predefined shape drawing and hover buttons via layout.modebar.buttonstoadd', function(done) {
+        it('add and remove predefined shape drawing and hover buttons via layout.modebar.buttonstoadd and template', function(done) {
             function countButtons() {
                 var modeBarEl = gd._fullLayout._modeBar.element;
                 return d3Select(modeBarEl).selectAll('a.modebar-btn').size();
@@ -1631,6 +1631,16 @@ describe('ModeBar', function() {
             })
             .then(function() {
                 expect(countButtons()).toBe(initial + 1, 'skip invalid');
+
+                return Plotly.relayout(gd, 'modebar.buttonstoadd', '');
+            })
+            .then(function() {
+                expect(countButtons()).toBe(initial);
+
+                return Plotly.relayout(gd, 'template.layout.modebar.buttonstoadd', 'v1hovermode');
+            })
+            .then(function() {
+                expect(countButtons()).toBe(initial + 2, 'via template');
             })
             .then(done, done.fail);
         });