Helipad.addSeries( str plot, str|func(int) reporter, str label, str|Color color, str style = '-' )

Registers a reporter to be drawn in a particular plot during the model’s runtime.

This function is here for compatibility purposes. Use TimeSeriesPlot.addSeries() instead.

WARNING: This function is deprecated and will be removed in a future version. Use one of the suggested replacements instead.

Parameters

• plot — str, required

  The name of the plot area to which the series should be added. Plot must already have been registered with model.addPlot().

• reporter — str|func(int), required

  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, required

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

• color — str|Color, required

  The color of the series line. Can take a hex string, a color name string (see the Matplotlib documentation for valid values), an RGB tuple with ranges from 0.0 to 1.0, or a Color object.

• style — str, optional

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

  Default value: '-'

Return Value — Series

The newly created Series object.