Struct Button

pub struct Button { /* private fields */ }

Implementations

impl Button

pub fn args(self, value: Value) -> Self

Sets the arguments values to be passed to the Plotly method set in method on click.

pub fn args2(self, value: Value) -> Self

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.

pub fn execute(self, value: bool) -> Self

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.

Default: true

pub fn label(self, value: impl AsRef<str>) -> Self

Sets the text label to appear on the button.

pub fn method(self, value: ButtonMethod) -> Self

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.

pub fn name(self, value: impl AsRef<str>) -> Self

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.

pub fn template_item_name(self, value: impl AsRef<str>) -> Self

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

pub fn visible(self, value: bool) -> Self

Determines whether or not this button is visible.

impl Button

pub fn new() -> Self

Trait Implementations

impl Clone for Button

fn clone(&self) -> Button

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Button

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Button

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for Button

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.