PlotSubPlot¶
- class PlotSubPlot¶
- AppendPlotSignal(plotSignal)¶
Adds a plot signal to the sub plot.
- Note:
If there is no axis, an axis will be created automatically. If the plot signal has not yet been assigned to an axis, it will be assigned automatically to the first axis.
- Parameters:
- plotSignal¶
The plot signal to be added
- Clone()¶
Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.
- Returns:
A copy of this object
- Return type:
- CreateAxis()¶
Creates and returns a new axis. The axis will be appended to the list of existing axes of the sub plot.
- Returns:
The newly created axis
- Return type:
- GetAxes()¶
Returns a list of all separate axes.
- Returns:
All seperate axes
- Return type:
list[
PlotAxis]
- GetAxisIndex(axis)¶
Returns the index of this axis in the list of all axes of the sub plot (starting at zero).
- Parameters:
- axis¶
An axis of this sub plot
- Returns:
The axis index.
- Return type:
int
- Raises:
ValueError – If axis is not a member of the sub plot
- GetPlotSignals()¶
Returns a merged list of all signals of the sub plots.
- Returns:
The signals of the plot
- Return type:
list[
PlotSignalBase]
- GetType()¶
Returns the type of the sub plot.
- Returns:
The sub plot type. One of “common” or “separate”.
- Return type:
str
- GetYRasterMode()¶
Returns the raster mode for the y-axis.
- Returns:
the raster mode (0 for no raster, 1 for automatic and 2 for manual raster mode)
- Return type:
int
- GetYRasterStepSize()¶
Returns the step size for the raster of the y-axis.
- Returns:
the raster step size
- Return type:
float
- RemovePlotSignal(plotSignal)¶
Removes a plot signal from the sub plot.
- Parameters:
- plotSignal¶
The plot signal to be removed
- Raises:
ValueError – If the plot signal is not present
- SetType(subPlotType)¶
Sets the type of the sub plot. This call is only allowed on the second sub plot!
If the type is “separate”, for each signal of this sub plot there will be a smaller sub plot.
- Parameters:
- subPlotType : str¶
The sub plot type. One of “common” or “separate”.