Struct UpdateMenu

pub struct UpdateMenu { /* private fields */ }

Implementations

impl UpdateMenu

pub fn active(self, value: i32) -> Self

Determines which button (by index starting from 0) is considered active.

pub fn background_color(self, value: impl Color) -> Self

Sets the background color of the update menu buttons.

pub fn border_color(self, value: impl Color) -> Self

Sets the color of the border enclosing the update menu.

pub fn border_width(self, value: usize) -> Self

Sets the width (in px) of the border enclosing the update menu.

pub fn buttons(self, value: Vec<Button>) -> Self

pub fn direction(self, value: UpdateMenuDirection) -> Self

Determines the direction in which the buttons are laid out, whether in a dropdown menu or a row/column of buttons. For left and up, the buttons will still appear in left-to-right or top-to-bottom order respectively.

pub fn font(self, value: Font) -> Self

Sets the font of the update menu button text.

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 pad(self, value: Pad) -> Self

Sets the padding around the buttons or dropdown menu.

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

Highlights active dropdown item or active button if true.

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 ty(self, value: UpdateMenuType) -> Self

Determines whether the buttons are accessible via a dropdown menu or whether the buttons are stacked horizontally or vertically

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

Determines whether or not the update menu is visible.

pub fn x(self, value: f64) -> Self

Type: number between or equal to -2 and 3 Default: -0.05 Sets the x position (in normalized coordinates) of the update menu.

pub fn x_anchor(self, value: Anchor) -> Self

Sets the update menu’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the range selector. Default: “right”

pub fn y(self, value: f64) -> Self

Type: number between or equal to -2 and 3 Default: 1 Sets the y position (in normalized coordinates) of the update menu.

pub fn y_anchor(self, value: Anchor) -> Self

Sets the update menu’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the range selector. Default: “top”

impl UpdateMenu

pub fn new() -> Self

Trait Implementations

impl Clone for UpdateMenu

fn clone(&self) -> UpdateMenu

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateMenu

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

Formats the value using the given formatter.

impl Default for UpdateMenu

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for UpdateMenu

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

where __S: Serializer,

Serialize this value into the given Serde serializer.