Reference 〉Class

Series( )

Stores data on series, which link a reporter to a plot. Do not instantiate directly; use model.addSeries() instead.

Properties

  • reporter str|func(int)

    A reference to a previously registered reporter, or a function that takes the model time (int) as its only argument and returns a numeric. See data.addReporter().

  • label str

    The name of the series to be displayed in the legend on the graph.

  • color Color

    The color of the series, stored as a Color object.

  • style str

    Allows for alternatives to solid lines, such as dotted lines. Default value produces a solid line. See Matplotlib linestyle reference for possible values.

  • subseries list[Series]

    Subsidiary series that should be treated as a group, for example percentile lines.

  • plot str

    The name of the Plot to which the series is attached.

  • line matplotlib.Line

    The Matplotlib Line object drawing the series. This property is added when the Graph object is initialized and the series is drawn to screen. Note that if the plot is a stackplot, this property exists only to draw the legend, and will not be drawn itself. In this case the drawn series is contained in series.poly.

  • poly matplotlib.PolyCollection

    If the plot is a stackplot, this property is the stacked polygon drawn to the plot area. Otherwise this property will not exist.

  • fdata list

    The data to be drawn to screen. This is not the same as the data in the corresponding column of Data.all; it updates only on refresh intervals, and will drop intermediate values when the resolution changes. This property is added when the Graph object is initialized and the series is drawn to screen.

Notes and Examples

  1. Contribute a Note

    Your email address will not be published. Required fields are marked *

    You may use limited HTML for formatting. Please embed blocks of code in <pre><code> </code></pre> tags.

History