Registers a plot area in the TimeSeries
plot area to which data series can be added.
Parameters
name — str, required
A unique slug-type string used to refer to the plot in other functions.
label — str, required
The name of the plot displayed in the control panel.
position — int, optional
The position in which to insert the plot in the control panel list. By default the plot is appended to the end of the list. NOTE: Position is calculated as of the function call. If two plots are called with position 3 for example, the second will push the first to position 4.
Default value: None
selected — bool, optional
Whether the plot should be selected by default when the control panel launches.
Default value: True
logscale — bool, optional
If true, displays the plot on a logarithmic scale by default, otherwise linear. NOTE: plots can be toggled between logarithmic and linear scales regardless of the value of this parameter by pressing the 'L' key on a plot.
Default value: False
stack — bool, optional
If set to
True
, the plot will be drawn as a stackplot rather than a line chart.Default value: False
Return Value — Plot
The newly created TimeSeriesPlot
object.
charwick
Jun 12, 2021 at 18:59This code adds five plots, four of them with logarithmic scales, and has all but one of them selected by default.
This results in the following in the control panel (Demand, Shortages, and Utility are default plots). Note that series must be added to these plots separately.