PlotAxis¶
- class PlotAxis¶
- 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:
- GetNumeralSystem()¶
Returns the numeral system of the y-axis.
- Returns:
the numeral system (dec for decimal, bin for binary, hex for hexadecimal)
- Return type:
str
- GetScalingMode()¶
Returns the scaling mode for the y-axis.
- Returns:
the scaling mode (0 for automatic, 1 for manual scaling mode)
- Return type:
int
- GetScalingYMaxValue()¶
Returns the maximum value for the y-axis.
- Returns:
the maximum value
- Return type:
float
- GetScalingYMinValue()¶
Returns the minimum value for the y-axis.
- Returns:
the minimum value
- Return type:
float
- GetTextShorteningMode()¶
Returns the mode for shortening long textual axis labels.
- Returns:
The text shortening mode: 0 for no shortening, 1 for left, 2 for middle, 3 for right ellipsizing.
- Return type:
int
- IsDepictNumericValues()¶
Returns whether y-axis values are depicted as numeric values.
- Returns:
True if labels are depicted as numeric values.
- Return type:
bool
- IsDepictTextValues()¶
Returns whether y-axis labels are depicted as text values of a signal with text representation. Currently, only signals with enumerations are supported.
- Returns:
True if labels are depicted as text values.
- Return type:
bool
- IsMergeNoTextReprValues()¶
Returns whether signal values with no explicit text representation should be merged to one entry when plotted.
Does only apply if text values are depicted as axis labels.
- Returns:
True if no representation values will be merged.
- Return type:
bool
- IsScalingYMaxActive()¶
Returns whether the maximum value for the y-axis is active or not.
- Returns:
True if the maximum value for the y-axis is active.
- Return type:
bool
- IsScalingYMinActive()¶
Returns whether the minimum value for the y-axis is active or not.
- Returns:
True if the minimum value for the y-axis is active.
- Return type:
bool
- SetDepictNumericValues(value)¶
Sets whether y-axis labels should be depicted as numerical values.
When combined with the depiction of text values for enumerated signals, additionally, the numeric values are shown in the selected numeral system in brackets behind the text values.
It is not possible to uncheck the depiction of numeric values and text values simultaneously. Then the default setting (depict only numeric values) is chosen.
- Parameters:
- value : bool¶
True if labels should be depicted as numeric values.
- SetDepictTextValues(value)¶
Sets whether y-axis labels should be depicted as text values of a signal with text representation.
When combined with the depiction of numeric values, additionally, the numeric values of the corresponding text values of the enumerated signal are shown in the selected numeral system in brackets behind the text values.
It is not possible to uncheck the depiction of numeric values and text values simultaneously. Then the default setting (depict only numeric values) is chosen.
- Parameters:
- value : bool¶
True if labels should be depicted as text values.
- SetMergeNoTextReprValues(value)¶
Sets whether signal values with no text explicit representation should be merged into one entry when plotted.
Does only apply if text values are depicted as axis labels.
- Parameters:
- value : bool¶
True if no representation values should be merged.
- SetNumeralSystem(numeralSystem)¶
Sets the numeral system of the y-axis.
- Parameters:
- numeralSystem : str¶
dec for decimal, bin for binary, hex for hexadecimal
- Raises:
ValueError – If numeralSystem is not a valid parameter
- SetScalingMode(mode)¶
Sets the scaling mode for the y-axis.
- Parameters:
- mode : int¶
0 for automatic, 1 for manual scaling mode
- Raises:
ValueError – If mode is not a valid parameter
- SetScalingYMaxActive(value)¶
Sets whether the maximum value for the y-axis should be active or not.
- Parameters:
- value : bool¶
True if the maximum value for the y-axis should be active.
- SetScalingYMaxValue(value)¶
Sets the maximum value for the y-axis.
- Parameters:
- value : float¶
The maximum value
- SetScalingYMinActive(value)¶
Sets whether the minimum value for the y-axis should be active or not.
- Parameters:
- value : bool¶
True if the minimum value for the y-axis should be active.