Stream API documentation about plotly.py HOT 1 CLOSED

>>> help(py.stream)

Help on class Stream in module plotly.plotly.plotly:

class Stream
 |  Interface to Plotly's real-time graphing API.
 |  
 |  Initialize a Stream object with a stream_id
 |  found in https://plot.ly/settings.
 |  Real-time graphs are initialized with a call to `plot` that embeds
 |  your unique `stream_id`s in each of the graph's traces. The `Stream`
 |  interface plots data to these traces, as identified with the unique
 |  stream_id, in real-time.
 |  Every viewer of the graph sees the same data at the same time.
 |  
 |  View examples and tutorials here:
 |  http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb
 |  
 |  Stream example:
 |  # Initialize a streaming graph
 |  # by embedding stream_id's in the graph's traces
 |  >>> stream_id = "your_stream_id" # See https://plot.ly/settings
 |  >>> py.plot(Data([Scatter(x=[],
 |                            y=[],
 |                            stream=dict(token=stream_id, maxpoints=100))])
 |  # Stream data to the import trace
 |  >>> stream = Stream(stream_id) # Initialize a stream object
 |  >>> stream.open() # Open the stream
 |  >>> stream.write(dict(x=1, y=1)) # Plot (1, 1) in your graph
 |  
 |  Methods defined here:
 |  
 |  __init__(self, stream_id)
 |      Initialize a Stream object with your unique stream_id.
 |      Find your stream_id at https://plot.ly/settings.
 |      
 |      For more help, see: `help(plotly.plotly.Stream)`
 |      or see examples and tutorials here:
 |      http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb
 |  
 |  close(self)
 |      Close the stream connection to plotly's streaming servers.
 |      
 |      For more help, see: `help(plotly.plotly.Stream)`
 |      or see examples and tutorials here:
 |      http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb
 |  
 |  open(self)
 |      Open streaming connection to plotly.
 |      
 |      For more help, see: `help(plotly.plotly.Stream)`
 |      or see examples and tutorials here:
 |      http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb
 |  
 |  write(self, data, reconnect_on=(200, '', 408))
 |      Write `data` to your stream. This will plot the
 |      `data` in your graph in real-time.
 |      
 |      `data` is a plotly formatted dict.
 |      Valid keys:
 |          'x', 'y', 'text', 'z', 'marker', 'line'
 |      
 |      Examples:
 |      >>> write(dict(x = 1, y = 2))
 |      >>> write(dict(x = [1, 2, 3], y = [10, 20, 30]))
 |      >>> write(dict(x = 1, y = 2, text = 'scatter text'))
 |      >>> write(dict(x = 1, y = 3, marker = dict(color = 'blue')))
 |      >>> write(dict(z = [[1,2,3], [4,5,6]]))
 |      
 |      The connection to plotly's servers is checked before writing
 |      and reconnected if disconnected and if the response status code
 |      is in `reconnect_on`.
 |      
 |      For more help, see: `help(plotly.plotly.Stream)`
 |      or see examples and tutorials here:
 |      http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb