Live Chat

We'll need to share your messages (and your email address if you're logged in) with our live chat provider, Drift. Here's their privacy policy.

If you don't want to do this, you can email us instead at contact@anvil.works.

plotly.graph_objs.layout.updatemenu Module

Functions

plotly.graph_objs.layout.updatemenu.Button([visible=], [method=], [args=], [args2=], [label=], [execute=], [name=], [templateitemname=]) → Button

Create a new ‘Button’ object

  • visible - Determines whether or not this button is visible.

  • method - Sets the Plotly method to be called on click. If the `skip` method is used, the API updatemenu will function as normal but will perform no API calls and will not bind automatically to state updates. This may be used to create a component interface and attach to updatemenu events manually via JavaScript.

  • args - Sets the arguments values to be passed to the Plotly method set in `method` on click.

  • args2 - Sets a 2nd set of `args`, these arguments values are passed to the Plotly method set in `method` when clicking this button while in the active state. Use this to create toggle buttons.

  • label - Sets the text label to appear on the button.

  • execute - When true, the API method is executed. When false, all other behaviors are the same and command execution is skipped. This may be useful when hooking into, for example, the `plotly_buttonclicked` method and executing the API command manually without losing the benefit of the updatemenu automatically binding to the state of the plot through the specification of `method` and `args`.

  • name - When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.

  • templateitemname - Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.


plotly.graph_objs.layout.updatemenu.Font([family=], [size=], [color=]) → Font

Create a new ‘Font’ object

  • family - HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.


plotly.graph_objs.layout.updatemenu.Pad([t=], [r=], [b=], [l=]) → Pad

Create a new ‘Pad’ object

  • t - The amount of padding (in px) along the top of the component.

  • r - The amount of padding (in px) on the right side of the component.

  • b - The amount of padding (in px) along the bottom of the component.

  • l - The amount of padding (in px) on the left side of the component.



plotly.graph_objs.layout.updatemenu