sliders.md

jupyter

jupytext kernelspec language_info plotly notebook_metadata_filter text_representation all extension format_name format_version jupytext_version .md markdown 1.1 1.1.7 display_name language name Python 3 python python3 codemirror_mode file_extension mimetype name nbconvert_exporter pygments_lexer version name version ipython 3 .py text/x-python python python ipython3 3.7.2 description display_as language layout name order page_type permalink thumbnail How to add slider controls to your plots in Python with Plotly. controls python base Sliders 1.5 example_index python/sliders/ thumbnail/slider2017.gif

Simple Slider Control

Sliders can be used in Plotly to change the data displayed or style of a plot.

import plotly.graph_objects as go
import numpy as np

# Create figure
fig = go.Figure()

# Add traces, one for each slider step
for step in np.arange(0, 5, 0.1):
    fig.add_trace(
        go.Scatter(
            visible=False,
            line=dict(color="#00CED1", width=6),
            name="𝜈 = " + str(step),
            x=np.arange(0, 10, 0.01),
            y=np.sin(step * np.arange(0, 10, 0.01))))

# Make 10th trace visible
fig.data[10].visible = True

# Create and add slider
steps = []
for i in range(len(fig.data)):
    step = dict(
        method="update",
        args=[{"visible": [False] * len(fig.data)},
              {"title": "Slider switched to step: " + str(i)}],  # layout attribute
    )
    step["args"][0]["visible"][i] = True  # Toggle i'th trace to "visible"
    steps.append(step)

sliders = [dict(
    active=10,
    currentvalue={"prefix": "Frequency: "},
    pad={"t": 50},
    steps=steps
)]

fig.update_layout(
    sliders=sliders
)

fig.show()

Methods

The method determines which plotly.js function will be used to update the chart. Plotly can use several updatemenu methods to add the slider:

• "update": modify data and layout attributes (as above)
• "restyle": modify data attributes
• "relayout": modify layout attributes
• "animate": start or pause an animation

Sliders in Plotly Express

Plotly Express provide sliders, but with implicit animation using the "animate" method described above. The animation play button can be omitted by removing updatemenus in the layout:

import plotly.express as px

df = px.data.gapminder()
fig = px.scatter(df, x="gdpPercap", y="lifeExp", animation_frame="year", animation_group="country",
           size="pop", color="continent", hover_name="country",
           log_x=True, size_max=55, range_x=[100,100000], range_y=[25,90])

fig["layout"].pop("updatemenus") # optional, drop animation buttons
fig.show()

Reference

Check out https://plotly.com/python/reference/layout/updatemenus/ for more information!