sub 'modebar' --> 'modeBar'

Author: etpinard

src/components/modebar/buttons.js

@@ -15,18 +15,19 @@ var Snapshot = require('../../snapshot');
 var Icons = require('../../../build/ploticon');
 
 
-var modebarButtons = module.exports = {};
+var modeBarButtons = module.exports = {};
 
 /**
- * Modebar buttons configuration
+ * ModeBar buttons configuration
  *
  * @param {string} name
  *      name / id of the buttons (for tracking)
  * @param {string} title
  *      text that appears while hovering over the button,
  *      enter null, false or '' for no hover text
  * @param {string} icon
- *      svg icon associated with the button
+ *      svg icon object associated with the button
+ *      can be linked to Plotly.Icons to use the default plotly icons
  * @param {string} [gravity]
  *      icon positioning
  * @param {function} click
@@ -42,7 +43,7 @@ var modebarButtons = module.exports = {};
  *      is the button a toggle button?
  */
 
-modebarButtons.toImage = {
+modeBarButtons.toImage = {
     name: 'toImage',
     title: 'Download plot as a png',
     icon: Icons.camera,
@@ -93,7 +94,7 @@ modebarButtons.toImage = {
     }
 };
 
-modebarButtons.sendDataToCloud = {
+modeBarButtons.sendDataToCloud = {
     name: 'sendDataToCloud',
     title: 'Save and edit plot in cloud',
     icon: Icons.disk,
@@ -102,7 +103,7 @@ modebarButtons.sendDataToCloud = {
     }
 };
 
-modebarButtons.zoom2d = {
+modeBarButtons.zoom2d = {
     name: 'zoom2d',
     title: 'Zoom',
     attr: 'dragmode',
@@ -111,7 +112,7 @@ modebarButtons.zoom2d = {
     click: handleCartesian
 };
 
-modebarButtons.pan2d = {
+modeBarButtons.pan2d = {
     name: 'pan2d',
     title: 'Pan',
     attr: 'dragmode',
@@ -120,7 +121,7 @@ modebarButtons.pan2d = {
     click: handleCartesian
 };
 
-modebarButtons.zoomIn2d = {
+modeBarButtons.zoomIn2d = {
     name: 'zoomIn2d',
     title: 'Zoom in',
     attr: 'zoom',
@@ -129,7 +130,7 @@ modebarButtons.zoomIn2d = {
     click: handleCartesian
 };
 
-modebarButtons.zoomOut2d = {
+modeBarButtons.zoomOut2d = {
     name: 'zoomOut2d',
     title: 'Zoom out',
     attr: 'zoom',
@@ -138,7 +139,7 @@ modebarButtons.zoomOut2d = {
     click: handleCartesian
 };
 
-modebarButtons.autoScale2d = {
+modeBarButtons.autoScale2d = {
     name: 'autoScale2d',
     title: 'Autoscale',
     attr: 'zoom',
@@ -147,7 +148,7 @@ modebarButtons.autoScale2d = {
     click: handleCartesian
 };
 
-modebarButtons.resetScale2d = {
+modeBarButtons.resetScale2d = {
     name: 'resetScale2d',
     title: 'Reset axes',
     attr: 'zoom',
@@ -156,7 +157,7 @@ modebarButtons.resetScale2d = {
     click: handleCartesian
 };
 
-modebarButtons.hoverClosestCartesian = {
+modeBarButtons.hoverClosestCartesian = {
     name: 'hoverClosestCartesian',
     title: 'Show closest data on hover',
     attr: 'hovermode',
@@ -166,7 +167,7 @@ modebarButtons.hoverClosestCartesian = {
     click: handleCartesian
 };
 
-modebarButtons.hoverCompareCartesian = {
+modeBarButtons.hoverCompareCartesian = {
     name: 'hoverCompareCartesian',
     title: 'Compare data on hover',
     attr: 'hovermode',
@@ -237,7 +238,7 @@ function handleCartesian(gd, ev) {
     });
 }
 
-modebarButtons.zoom3d = {
+modeBarButtons.zoom3d = {
     name: 'zoom3d',
     title: 'Zoom',
     attr: 'dragmode',
@@ -246,7 +247,7 @@ modebarButtons.zoom3d = {
     click: handleDrag3d
 };
 
-modebarButtons.pan3d = {
+modeBarButtons.pan3d = {
     name: 'pan3d',
     title: 'Pan',
     attr: 'dragmode',
@@ -255,7 +256,7 @@ modebarButtons.pan3d = {
     click: handleDrag3d
 };
 
-modebarButtons.orbitRotation = {
+modeBarButtons.orbitRotation = {
     name: 'orbitRotation',
     title: 'orbital rotation',
     attr: 'dragmode',
@@ -264,7 +265,7 @@ modebarButtons.orbitRotation = {
     click: handleDrag3d
 };
 
-modebarButtons.tableRotation = {
+modeBarButtons.tableRotation = {
     name: 'tableRotation',
     title: 'turntable rotation',
     attr: 'dragmode',
@@ -288,15 +289,15 @@ function handleDrag3d(gd, ev) {
     Plotly.relayout(gd, layoutUpdate);
 }
 
-modebarButtons.resetCameraDefault3d = {
+modeBarButtons.resetCameraDefault3d = {
     name: 'resetCameraDefault3d',
     title: 'Reset camera to default',
     attr: 'resetDefault',
     icon: Icons.home,
     click: handleCamera3d
 };
 
-modebarButtons.resetCameraLastSave3d = {
+modeBarButtons.resetCameraLastSave3d = {
     name: 'resetCameraLastSave3d',
     title: 'Reset camera to last save',
     attr: 'resetLastSave',
@@ -332,7 +333,7 @@ function handleCamera3d(gd, ev) {
      */
 }
 
-modebarButtons.hoverClosest3d = {
+modeBarButtons.hoverClosest3d = {
     name: 'hoverClosest3d',
     title: 'Toggle show closest data on hover',
     attr: 'hovermode',
@@ -385,7 +386,7 @@ modebarButtons.hoverClosest3d = {
     }
 };
 
-modebarButtons.zoomInGeo = {
+modeBarButtons.zoomInGeo = {
     name: 'zoomInGeo',
     title: 'Zoom in',
     attr: 'zoom',
@@ -394,7 +395,7 @@ modebarButtons.zoomInGeo = {
     click: handleGeo
 };
 
-modebarButtons.zoomOutGeo = {
+modeBarButtons.zoomOutGeo = {
     name: 'zoomOutGeo',
     title: 'Zoom in',
     attr: 'zoom',
@@ -403,7 +404,7 @@ modebarButtons.zoomOutGeo = {
     click: handleGeo
 };
 
-modebarButtons.resetGeo = {
+modeBarButtons.resetGeo = {
     name: 'resetGeo',
     title: 'Reset',
     attr: 'reset',
@@ -412,7 +413,7 @@ modebarButtons.resetGeo = {
     click: handleGeo
 };
 
-modebarButtons.hoverClosestGeo = {
+modeBarButtons.hoverClosestGeo = {
     name: 'hoverClosestGeo',
     title: 'Toggle show closest data on hover',
     attr: 'hovermode',
@@ -445,7 +446,7 @@ function handleGeo(gd, ev) {
     }
 }
 
-modebarButtons.hoverClosestGl2d = {
+modeBarButtons.hoverClosestGl2d = {
     name: 'hoverClosestGl2d',
     title: 'Toggle show closest data on hover',
     attr: 'hovermode',
@@ -456,7 +457,7 @@ modebarButtons.hoverClosestGl2d = {
     click: toggleHover
 };
 
-modebarButtons.hoverClosestPie = {
+modeBarButtons.hoverClosestPie = {
     name: 'hoverClosestPie',
     title: 'Toggle show closest data on hover',
     attr: 'hovermode',

src/components/modebar/index.js

@@ -20,7 +20,7 @@ var Icons = require('../../../build/ploticon');
  * @Class
  * @Param {object} opts
  * @Param {object} opts.buttons    nested arrays of grouped buttons config objects
- * @Param {object} opts.container  container div to append modebar
+ * @Param {object} opts.container  container div to append modeBar
  * @Param {object} opts.graphInfo  primary plot object containing data and layout
  */
 function ModeBar(opts) {
@@ -35,7 +35,7 @@ function ModeBar(opts) {
 var proto = ModeBar.prototype;
 
 /**
- * Update modebar (buttons and logo)
+ * Update modeBar (buttons and logo)
  *
  * @param {object} graphInfo  primary plot object containing data and layout
  * @param {array of arrays} buttons nested arrays of grouped buttons to initialize
@@ -210,7 +210,7 @@ proto.updateActiveButton = function(buttonClicked) {
 };
 
 /**
- * Check if modebar is configured as button configuration argument
+ * Check if modeBar is configured as button configuration argument
  *
  * @Param {object} buttons 2d array of grouped button config objects
  * @Return {boolean}
@@ -262,22 +262,22 @@ proto.destroy = function() {
     Plotly.Lib.removeElement(this.container.querySelector('.modebar'));
 };
 
-function createModebar(gd, buttons) {
+function createModeBar(gd, buttons) {
     var fullLayout = gd._fullLayout;
 
-    var modebar = new ModeBar({
+    var modeBar = new ModeBar({
         graphInfo: gd,
         container: fullLayout._paperdiv.node(),
         buttons: buttons
     });
 
     if(fullLayout._privateplot) {
-        d3.select(modebar.element).append('span')
+        d3.select(modeBar.element).append('span')
             .classed('badge-private float--left', true)
             .text('PRIVATE');
     }
 
-    return modebar;
+    return modeBar;
 }
 
-module.exports = createModebar;
+module.exports = createModeBar;

src/components/modebar/manage.js

@@ -11,39 +11,41 @@
 
 var Plotly = require('../../plotly');
 
-var createModebar = require('./');
-var modebarButtons = require('./buttons');
+var createModeBar = require('./');
+var modeBarButtons = require('./buttons');
 
 /**
- * Modebar wrapper around 'create' and 'update',
- * chooses buttons to pass to Modebar constructor based on
+ * ModeBar wrapper around 'create' and 'update',
+ * chooses buttons to pass to ModeBar constructor based on
  * plot type and plot config.
  *
  * @param {object} gd main plot object
  *
  */
-module.exports = function manageModebar(gd) {
+module.exports = function manageModeBar(gd) {
     var fullLayout = gd._fullLayout,
         context = gd._context,
-        modebar = fullLayout._modebar;
+        modeBar = fullLayout._modeBar;
 
-    if(!context.displayModeBar && modebar) {
-        modebar.destroy();
-        delete fullLayout._modebar;
+    if(!context.displayModeBar && modeBar) {
+        modeBar.destroy();
+        delete fullLayout._modeBar;
         return;
     }
 
-    if(!Array.isArray(context.modebarButtonsToRemove)) {
+    if(!Array.isArray(context.modeBarButtonsToRemove)) {
         throw new Error([
-            '*modebarButtonsToRemove* configuration options',
+            '*modeBarButtonsToRemove* configuration options',
             'must be an array.'
         ].join(' '));
     }
 
-    var buttonGroups = getButtonGroups(fullLayout, context.modebarButtonsToRemove);
+//     if(!Array.isArray(context.m))
 
-    if(modebar) modebar.update(gd, buttonGroups);
-    else fullLayout._modebar = createModebar(gd, buttonGroups);
+    var buttonGroups = getButtonGroups(fullLayout, context.modeBarButtonsToRemove);
+
+    if(modeBar) modeBar.update(gd, buttonGroups);
+    else fullLayout._modeBar = createModeBar(gd, buttonGroups);
 };
 
 // logic behind which buttons are displayed by default
@@ -56,7 +58,7 @@ function getButtonGroups(fullLayout, buttonsToRemove) {
         for(var i = 0; i < newGroup.length; i++) {
             var button = newGroup[i];
             if(buttonsToRemove.indexOf(button) !== -1) continue;
-            out.push(modebarButtons[button]);
+            out.push(modeBarButtons[button]);
         }
 
         groups.push(out);

src/plot_api/plot_api.js

@@ -11,7 +11,7 @@
 
 var Plotly = require('../plotly');
 var Events = require('../lib/events');
-var manageModebar = require('../components/modebar/manage');
+var manageModeBar = require('../components/modebar/manage');
 
 var d3 = require('d3');
 var m4FromQuat = require('gl-mat4/fromQuat');
@@ -2465,7 +2465,7 @@ Plotly.relayout = function relayout(gd, astr, val) {
 
         // this is decoupled enough it doesn't need async regardless
         if(domodebar) {
-            manageModebar(gd);
+            manageModeBar(gd);
 
             var subplotIds;
             subplotIds = plots.getSubplotIds(fullLayout, 'gl3d');
@@ -3001,7 +3001,7 @@ function lsInner(gd) {
 
     Plotly.Titles.draw(gd, 'gtitle');
 
-    manageModebar(gd);
+    manageModeBar(gd);
 
     return gd._promises.length && Promise.all(gd._promises);
 }

src/plot_api/plot_config.js

@@ -55,13 +55,14 @@ module.exports = {
     // false or function adding source(s) to linkText <text>
     showSources: false,
 
-    // display the modebar (true, false, or 'hover')
+    // display the mode bar (true, false, or 'hover')
     displayModeBar: 'hover',
 
     // remove modebar button by name
-    modebarButtonsToRemove: [],
+    // (see ./components/modebar/buttons.js for the list of names)
+    modeBarButtonsToRemove: [],
 
-    // add the plotly logo on the end of the modebar
+    // add the plotly logo on the end of the mode bar
     displaylogo: true,
 
     // increase the pixel ratio for Gl plot images