introduce UpdateMenus module

plotly · etpinard · Aug 3, 2016 · Jul 22, 2016 · Jul 22, 2016 · Jul 22, 2016
commit ba2020620add956866f60f56f0a5f0b86df31393
diff --git a/src/components/updatemenus/attributes.js b/src/components/updatemenus/attributes.js
@@ -0,0 +1,144 @@
+/**
+* Copyright 2012-2016, 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 fontAttrs = require('../../plots/font_attributes');
+var colorAttrs = require('../color/attributes');
+var extendFlat = require('../../lib/extend').extendFlat;
+
+var buttonsAttrs = {
+    _isLinkedToArray: true,
+
+    method: {
+        valType: 'enumerated',
+        values: ['restyle', 'relayout'],
+        dflt: 'restyle',
+        role: 'info',
+        description: [
+            'Sets the Plotly method to be called on click.'
+        ].join(' ')
+    },
+    args: {
+        valType: 'info_array',
+        role: 'info',
+        items: [
+            { valType: 'any' },
+            { valType: 'any' },
+            { valType: 'any' }
+        ],
+        description: [
+            'Sets the arguments values to be passed to the Plotly',
+            'method set in `method` on click.'
+        ].join(' ')
+    },
+    label: {
+        valType: 'string',
+        role: 'info',
+        description: 'Sets the text label to appear on the button.'
+    }
+};
+
+module.exports = {
+    _isLinkedToArray: true,
+
+    // add more global settings?
+    //
+    // width
+    // height (instead of being inferred by the label dimensions)
+    // title (above header)
+    // header borderwidth
+    // active bgcolor
+    // hover bgcolor
+    // gap between buttons
+    // gap between header & buttons
+
+    visible: {
+        valType: 'boolean',
+        role: 'info',
+        description: [
+            'Determines whether or not the update menu is visible.'
+        ].join(' ')
+    },
+
+    active: {
+        valType: 'integer',
+        role: 'info',
+        min: -1,
+        dflt: 0,
+        description: [
+            'Determines which button (by index starting from 0) is',
+            'considered active.'
+        ].join(' ')
+    },
+
+    buttons: buttonsAttrs,
+
+    x: {
+        valType: 'number',
+        min: -2,
+        max: 3,
+        dflt: -0.05,
+        role: 'style',
+        description: 'Sets the x position (in normalized coordinates) of the update menu.'
+    },
+    xanchor: {
+        valType: 'enumerated',
+        values: ['auto', 'left', 'center', 'right'],
+        dflt: 'right',
+        role: 'info',
+        description: [
+            'Sets the update menu\'s horizontal position anchor.',
+            'This anchor binds the `x` position to the *left*, *center*',
+            'or *right* of the range selector.'
+        ].join(' ')
+    },
+    y: {
+        valType: 'number',
+        min: -2,
+        max: 3,
+        dflt: 1,
+        role: 'style',
+        description: 'Sets the y position (in normalized coordinates) of the update menu.'
+    },
+    yanchor: {
+        valType: 'enumerated',
+        values: ['auto', 'top', 'middle', 'bottom'],
+        dflt: 'bottom',
+        role: 'info',
+        description: [
+            'Sets the update menu\'s vertical position anchor',
+            'This anchor binds the `y` position to the *top*, *middle*',
+            'or *bottom* of the range selector.'
+        ].join(' ')
+    },
+
+    font: extendFlat({}, fontAttrs, {
+        description: 'Sets the font of the update menu button text.'
+    }),
+
+    bgcolor: {
+        valType: 'color',
+        dflt: colorAttrs.lightLine,
+        role: 'style',
+        description: 'Sets the background color of the update menu buttons.'
+    },
+    bordercolor: {
+        valType: 'color',
+        dflt: colorAttrs.defaultLine,
+        role: 'style',
+        description: 'Sets the color of the border enclosing the update menu.'
+    },
+    borderwidth: {
+        valType: 'number',
+        min: 0,
+        dflt: 0,
+        role: 'style',
+        description: 'Sets the width (in px) of the border enclosing the update menu.'
+    }
+};
diff --git a/src/components/updatemenus/constants.js b/src/components/updatemenus/constants.js
@@ -0,0 +1,73 @@
+/**
+* Copyright 2012-2016, 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';
+
+
+module.exports = {
+
+    // layout attribute names
+    name: 'updatemenus',
+    itemName: 'updatemenu',
+
+    // class names
+    containerClassName: 'updatemenu-container',
+    headerGroupClassName: 'updatemenu-header-group',
+    headerClassName: 'updatemenu-header',
+    headerArrowClassName: 'updatemenu-header-arrow',
+    buttonGroupClassName: 'updatemenu-button-group',
+    buttonClassName: 'updatemenu-button',
+    itemRectClassName: 'updatemenu-item-rect',
+    itemTextClassName: 'updatemenu-item-text',
+
+    // DOM attribute name in button group keeping track
+    // of active update menu
+    menuIndexAttrName: 'updatemenu-active-index',
+
+    // id root pass to Plots.autoMargin
+    autoMarginIdRoot: 'updatemenu-',
+
+    // options when 'active: -1'
+    blankHeaderOpts: { label: '  ' },
+
+    // min item width / height
+    minWidth: 30,
+    minHeight: 30,
+
+    // padding around item text
+    textPadX: 40,
+
+    // font size to height scale
+    fontSizeToHeight: 1.3,
+
+    // item rect radii
+    rx: 2,
+    ry: 2,
+
+    // item  text x offset off left edge
+    textOffsetX: 10,
+
+    // item  text y offset (w.r.t. middle)
+    textOffsetY: 3,
+
+    // arrow offset off right edge
+    arrowOffsetX: 2,
+
+    // gap between header and buttons
+    gapButtonHeader: 5,
+
+    // gap between between buttons
+    gapButton: 2,
+
+    // color given to active buttons
+    activeColor: '#d3d3d3',
+
+    // color given to hovered buttons
+    hoverColor: '#d3d3d3'
+};
diff --git a/src/components/updatemenus/defaults.js b/src/components/updatemenus/defaults.js
@@ -0,0 +1,86 @@
+/**
+* Copyright 2012-2016, 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 Lib = require('../../lib');
+
+var attributes = require('./attributes');
+var contants = require('./constants');
+
+var name = contants.name;
+var buttonAttrs = attributes.buttons;
+
+
+module.exports = function updateMenusDefaults(layoutIn, layoutOut) {
+    var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
+        contOut = layoutOut[name] = [];
+
+    for(var i = 0; i < contIn.length; i++) {
+        var menuIn = contIn[i] || {},
+            menuOut = {};
+
+        menuDefaults(menuIn, menuOut, layoutOut);
+        menuOut._input = menuIn;
+        contOut.push(menuOut);
+    }
+};
+
+function menuDefaults(menuIn, menuOut, layoutOut) {
+
+    function coerce(attr, dflt) {
+        return Lib.coerce(menuIn, menuOut, attributes, attr, dflt);
+    }
+
+    var buttons = buttonsDefaults(menuIn, menuOut);
+
+    var visible = coerce('visible', buttons.length > 0);
+    if(!visible) return;
+
+    coerce('active');
+
+    coerce('x');
+    coerce('y');
+    Lib.noneOrAll(menuIn, menuOut, ['x', 'y']);
+
+    coerce('xanchor');
+    coerce('yanchor');
+
+    Lib.coerceFont(coerce, 'font', layoutOut.font);
+
+    coerce('bgcolor');
+    coerce('bordercolor');
+    coerce('borderwidth');
+}
+
+function buttonsDefaults(menuIn, menuOut) {
+    var buttonsIn = menuIn.buttons || [],
+        buttonsOut = menuOut.buttons = [];
+
+    var buttonIn, buttonOut;
+
+    function coerce(attr, dflt) {
+            return Lib.coerce(buttonIn, buttonOut, buttonAttrs, attr, dflt);
+    }
+
+    for(var i = 0; i < buttonsIn.length; i++) {
+        buttonIn = buttonsIn[i];
+        buttonOut = {};
+
+        // Should we do some validation for 'args' depending on `method`
+        // or just let Plotly[method] error out?
+
+        coerce('method');
+        coerce('args');
+        coerce('label');
+
+        buttonsOut.push(buttonOut);
+    }
+
+    return buttonsOut;
+}