Button

public struct Button : Encodable

Undocumented

  • Determines whether or not this button is visible.

    Declaration

    Swift

    public var visible: Bool?

  • 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.

    See more

    Declaration

    Swift

    public enum Method : String, Encodable

  • 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.

    Declaration

    Swift

    public var method: Method?

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

    Declaration

    Swift

    public var args: InfoArray?

  • 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.

    Declaration

    Swift

    public var args2: InfoArray?

  • Sets the text label to appear on the button.

    Declaration

    Swift

    public var label: String?

  • 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.

    Declaration

    Swift

    public var execute: Bool?

  • 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.

    Declaration

    Swift

    public var name: String?

  • 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.

    Declaration

    Swift

    public var templateItemName: String?

  • Creates Button object with specified properties.

    Declaration

    Swift

    public init(visible: Bool? = nil, method: Method? = nil, args: InfoArray? = nil, args2:
        InfoArray? = nil, label: String? = nil, execute: Bool? = nil, name: String? = nil,
        templateItemName: String? = nil)

    Parameters

    visible

    Determines whether or not this button is visible.
    method

    Sets the Plotly method to be called on click.
    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.
    label

    Sets the text label to appear on the button.
    execute

    When true, the API method is executed.
    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.
    templateItemName

    Used to refer to a named item in this array in the template.