Black Lives Matter. Please consider donating to Black Girls Code today.

Python Figure Reference: layout.sliders

  • sliders
    Code: fig.update_layout(sliders=list(...))
    Type: list of dict where each dict has one or more of the keys listed below.
    • visible
      Parent: layout.sliders[]
      Type: boolean
      Default: True

      Determines whether or not the slider is visible.

    • active
      Parent: layout.sliders[]
      Type: number greater than or equal to 0
      Default: 0

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

    • steps
      Parent: layout.sliders[]
      Type: list of dict where each dict has one or more of the keys listed below.
      • visible
        Parent: layout.sliders[].steps[]
        Type: boolean
        Default: True

        Determines whether or not this step is included in the slider.

      • method
        Parent: layout.sliders[].steps[]
        Type: enumerated , one of ( "restyle" | "relayout" | "animate" | "update" | "skip" )
        Default: "restyle"

        Sets the Plotly method to be called when the slider value is changed. If the `skip` method is used, the API slider 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 slider events manually via JavaScript.

      • args
        Parent: layout.sliders[].steps[]
        Type: list

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

      • label
        Parent: layout.sliders[].steps[]
        Type: string

        Sets the text label to appear on the slider

      • value
        Parent: layout.sliders[].steps[]
        Type: string

        Sets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided.

      • execute
        Parent: layout.sliders[].steps[]
        Type: boolean
        Default: True

        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_sliderchange` method and executing the API command manually without losing the benefit of the slider automatically binding to the state of the plot through the specification of `method` and `args`.

      • name
        Parent: layout.sliders[].steps[]
        Type: string

        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
        Parent: layout.sliders[].steps[]
        Type: 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`.

    • lenmode
      Parent: layout.sliders[]
      Type: enumerated , one of ( "fraction" | "pixels" )
      Default: "fraction"

      Determines whether this slider length is set in units of plot "fraction" or in "pixels. Use `len` to set the value.

    • len
      Parent: layout.sliders[]
      Type: number greater than or equal to 0
      Default: 1

      Sets the length of the slider This measure excludes the padding of both ends. That is, the slider's length is this length minus the padding on both ends.

    • x
      Parent: layout.sliders[]
      Type: number between or equal to -2 and 3
      Default: 0

      Sets the x position (in normalized coordinates) of the slider.

    • pad
      Parent: layout.sliders[]
      Type: dict containing one or more of the keys listed below.

      Set the padding of the slider component along each side.

      • t
        Parent: layout.sliders[].pad
        Type: number
        Default: 20

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

      • r
        Parent: layout.sliders[].pad
        Type: number
        Default: 0

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

      • b
        Parent: layout.sliders[].pad
        Type: number
        Default: 0

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

      • l
        Parent: layout.sliders[].pad
        Type: number
        Default: 0

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

    • xanchor
      Parent: layout.sliders[]
      Type: enumerated , one of ( "auto" | "left" | "center" | "right" )
      Default: "left"

      Sets the slider's horizontal position anchor. This anchor binds the `x` position to the "left", "center" or "right" of the range selector.

    • y
      Parent: layout.sliders[]
      Type: number between or equal to -2 and 3
      Default: 0

      Sets the y position (in normalized coordinates) of the slider.

    • yanchor
      Parent: layout.sliders[]
      Type: enumerated , one of ( "auto" | "top" | "middle" | "bottom" )
      Default: "top"

      Sets the slider's vertical position anchor This anchor binds the `y` position to the "top", "middle" or "bottom" of the range selector.

    • transition
      Parent: layout.sliders[]
      Type: dict containing one or more of the keys listed below.
      • duration
        Parent: layout.sliders[].transition
        Type: number greater than or equal to 0
        Default: 150

        Sets the duration of the slider transition

      • easing
        Parent: layout.sliders[].transition
        Type: enumerated , one of ( "linear" | "quad" | "cubic" | "sin" | "exp" | "circle" | "elastic" | "back" | "bounce" | "linear-in" | "quad-in" | "cubic-in" | "sin-in" | "exp-in" | "circle-in" | "elastic-in" | "back-in" | "bounce-in" | "linear-out" | "quad-out" | "cubic-out" | "sin-out" | "exp-out" | "circle-out" | "elastic-out" | "back-out" | "bounce-out" | "linear-in-out" | "quad-in-out" | "cubic-in-out" | "sin-in-out" | "exp-in-out" | "circle-in-out" | "elastic-in-out" | "back-in-out" | "bounce-in-out" )
        Default: "cubic-in-out"

        Sets the easing function of the slider transition

    • currentvalue
      Parent: layout.sliders[]
      Type: dict containing one or more of the keys listed below.
      • visible
        Parent: layout.sliders[].currentvalue
        Type: boolean
        Default: True

        Shows the currently-selected value above the slider.

      • xanchor
        Parent: layout.sliders[].currentvalue
        Type: enumerated , one of ( "left" | "center" | "right" )
        Default: "left"

        The alignment of the value readout relative to the length of the slider.

      • offset
        Parent: layout.sliders[].currentvalue
        Type: number
        Default: 10

        The amount of space, in pixels, between the current value label and the slider.

      • prefix
        Parent: layout.sliders[].currentvalue
        Type: string

        When currentvalue.visible is True, this sets the prefix of the label.

      • suffix
        Parent: layout.sliders[].currentvalue
        Type: string

        When currentvalue.visible is True, this sets the suffix of the label.

      • font
        Parent: layout.sliders[].currentvalue
        Type: dict containing one or more of the keys listed below.

        Sets the font of the current value label text.

        • family
          Parent: layout.sliders[].currentvalue.font
          Type: string

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

        • size
          Parent: layout.sliders[].currentvalue.font
          Type: number greater than or equal to 1
        • color
          Parent: layout.sliders[].currentvalue.font
          Type: color
    • font
      Parent: layout.sliders[]
      Type: dict containing one or more of the keys listed below.

      Sets the font of the slider step labels.

      • family
        Parent: layout.sliders[].font
        Type: string

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

      • size
        Parent: layout.sliders[].font
        Type: number greater than or equal to 1
      • color
        Parent: layout.sliders[].font
        Type: color
    • activebgcolor
      Parent: layout.sliders[]
      Type: color
      Default: "#dbdde0"

      Sets the background color of the slider grip while dragging.

    • bgcolor
      Parent: layout.sliders[]
      Type: color
      Default: "#f8fafc"

      Sets the background color of the slider.

    • bordercolor
      Parent: layout.sliders[]
      Type: color
      Default: "#bec8d9"

      Sets the color of the border enclosing the slider.

    • borderwidth
      Parent: layout.sliders[]
      Type: number greater than or equal to 0
      Default: 1

      Sets the width (in px) of the border enclosing the slider.

    • ticklen
      Parent: layout.sliders[]
      Type: number greater than or equal to 0
      Default: 7

      Sets the length in pixels of step tick marks

    • tickcolor
      Parent: layout.sliders[]
      Type: color
      Default: "#333"

      Sets the color of the border enclosing the slider.

    • tickwidth
      Parent: layout.sliders[]
      Type: number greater than or equal to 0
      Default: 1

      Sets the tick width (in px).

    • minorticklen
      Parent: layout.sliders[]
      Type: number greater than or equal to 0
      Default: 4

      Sets the length in pixels of minor step tick marks

    • name
      Parent: layout.sliders[]
      Type: string

      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
      Parent: layout.sliders[]
      Type: 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`.