Interact decorator

New to Plotly?

Plotly's Python library is free and open source! Get started by downloading the client and reading the primer.
You can set up Plotly to work in online or offline mode, or in jupyter notebooks.
We also have a quick-reference cheatsheet (new!) to help you get started!

Interact

Here is a simple example of using the interact decorator from ipywidgets to create a simple set of widgets to control the parameters of a plot.

import plotly.graph_objs as go

import numpy as np
from ipywidgets import interact

First we'll create an empty figure, and add an empty scatter trace to it.

fig = go.FigureWidget()
scatt = fig.add_scatter()
fig

Then, write an update function that inputs the frequency factor (a) and phase factor (b) and sets the x and y properties of the scatter trace. This function is decorated with the interact decorator from the ipywidgets package. The decorator parameters are used to specify the ranges of parameters that we want to sweep over. See http://ipywidgets.readthedocs.io/en/latest/examples/Using%20Interact.html for more details.

xs=np.linspace(0, 6, 100)

@interact(a=(1.0, 4.0, 0.01), b=(0, 10.0, 0.01), color=['red', 'green', 'blue'])
def update(a=3.6, b=4.3, color='blue'):
    with fig.batch_update():
        scatt.x=xs
        scatt.y=np.sin(a*xs-b)
        scatt.line.color=color

Reference

See these Jupyter notebooks for even more FigureWidget examples.

help(go.FigureWidget)

from IPython.display import display, HTML

display(HTML('<link href="//fonts.googleapis.com/css?family=Open+Sans:600,400,300,200|Inconsolata|Ubuntu+Mono:400,700" rel="stylesheet" type="text/css" />'))
display(HTML('<link rel="stylesheet" type="text/css" href="http://help.plot.ly/documentation/all_static/css/ipython-notebook-custom.css">'))

! pip install git+https://github.com/plotly/publisher.git --upgrade

import publisher
publisher.publish(
    'Interact.ipynb', 'python/interact-decorator/', 'Use the Interact decorator with go.FigureWidget',
    'Use the Interact decorator with go.FigureWidget',
    title = 'Use Interact decorator with FigureWidget',
    name = 'Use Interact decorator with FigureWidget',
    has_thumbnail='true', thumbnail='thumbnail/zoom.jpg',
    language='python', page_type='example_index',
    display_as='chart_events', order=4,
    ipynb= '~notebook_demo/254')
Back to top