PlotCalculatedSignal¶
- class PlotCalculatedSignal¶
Returned by
- 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:
- GetAxisIndex()¶
Returns the index of the axis the signal is assigned to (starting at zero).
- Returns:
The axis index
- Return type:
integer
- GetColor()¶
Return the color that is set in this plot signal.
- Returns:
The color
- Return type:
str
- GetDrawStyle()¶
Return the draw style that is set in this plot signal.
- Returns:
The draw style
- Return type:
str
- GetExpression()¶
Returns the expression of the calculated signal.
- Returns:
The signal expression
- Return type:
str
- GetLineStyle()¶
Return the line style that is set in this plot signal.
- Returns:
The line style
- Return type:
str
- GetLineWidth()¶
Return the line width that is set in this plot signal.
- Returns:
The line width
- Return type:
float
- GetMarkerSize()¶
Return the marker size that is set in this plot signal.
- Returns:
The marker size
- Return type:
float
- GetMarkerStyle()¶
Return the marker style that is set in this plot signal.
- Returns:
The marker style
- Return type:
str
-
GetName(namespace=
None)¶ Returns the display name of this plot signal if it is set.
- Parameters:
- namespace : str¶
Unused
- Returns:
The name of this plot signal or empty string.
- Return type:
str
- IsGenericSignal()¶
Returns, if this plot signal has its origin from a generic signal.
- Returns:
Always False
- Return type:
bool
- IsTraceStepSignal()¶
Returns, if this plot signal has its origin from a trace step.
- Returns:
Always False
- Return type:
bool
- SetAxisIndex(axisIndex)¶
Assigns the signal to an axis by index.
- Parameters:
- axisIndex : integer¶
The axis index in the list of axis of a sub plot
- SetColor(color)¶
Sets the color of this plot signal. Use value ‘’ to assign the color automatically.
- Parameters:
- color : str¶
The new color to be set or None.
- SetDrawStyle(drawStyle)¶
Sets the draw style of this plot signal. Valid values are: ‘hold’ or ‘linear’
- Parameters:
- drawStyle : str¶
The new draw style to be set
- SetExpression(expression)¶
Sets the expression of the calculated signal as an expression. The expression can contain any bound generic signals, package variables or global constants. Additionally constant values are accepted.
- Parameters:
- expression : str¶
The signal expression
- Raises:
ApiError – When expression is not a valid Python expression or is None
- SetLineStyle(lineStyle)¶
Sets the line style of this plot signal. Valid values are: ‘-’, ‘–’, ‘-.’ or ‘:’. Use value ‘’ to assign the style automatically.
- Parameters:
- lineStyle : str¶
The new line style to be set
- SetLineWidth(lineWidth)¶
Sets the line width of this plot signal.
- Parameters:
- lineWidth : float¶
The new line width to be set
- SetMarkerSize(markerSize)¶
Sets the marker size of this plot signal.
- Parameters:
- markerSize : float¶
The new marker size to be set
- SetMarkerStyle(markerStyle)¶
Sets the marker style of this plot signal. Valid values are: ‘’ (no marker), ‘o’, ‘*’, ‘x’, ‘+’, ‘.’.
- Parameters:
- markerStyle : str¶
The new marker style to be set