Label

SCPI Commands :

DISPlay:SIGNal:LABel:ADD
DISPlay:SIGNal:LABel:FONTsize
Commands in total: 12
Subgroups: 8
Direct child commands: 2
class AddStruct[source]

Structure for setting input parameters. Fields:

  • Label_Id: str: String with the label identifier. The LabelID and Source parameters identify each label uniquely, so the label ID must be unique for the given waveform. Note the LabelID because it is not possible to query it, or to read it on the user interface.

  • Source: enums.SignalSource: Waveform to that the label belongs, see ‘Waveform suffix’.

  • Label_Text: str: String with the label text that is shown on the display

  • Position_Mode: enums.PositionMode: ABS | REL

    • ABS: Position in time and voltage values, or in other units depending on the waveform character. Absolute positions move with the waveform display when the scales, the vertical position or offset, or the reference point are changed.

    • REL: Fixed label position in percent of the screen counting from the upper left corner.

  • Xpositon: int: Horizontal position of the label text. Values, range and unit depend on the position mode, the waveform position and scaling. For relative position mode, the range is 0 to 100 %.

  • Ypositon: int: Vertical position of the label text. Values, range and unit depend on the position mode, the waveform position and scaling. For relative position mode, the range is 0 to 100 %.

get_fontsize() → int[source]
# DISPlay:SIGNal:LABel:FONTsize
value: int = driver.display.signal.label.get_fontsize()

Sets the font size of waveform labels.

set_add(value: AddStruct) → None[source]
# DISPlay:SIGNal:LABel:ADD
structure = driver.display.signal.label.AddStruct()
structure.Label_Id: str = 'abc'
structure.Source: enums.SignalSource = enums.SignalSource.AJ1
structure.Label_Text: str = 'abc'
structure.Position_Mode: enums.PositionMode = enums.PositionMode.ABS
structure.Xpositon: int = 1
structure.Ypositon: int = 1
driver.display.signal.label.set_add(value = structure)

Creates a new waveform label for the specified source waveform.

Parameters:

value – see the help for AddStruct structure arguments.

set_fontsize(label_font_size: int) → None[source]
# DISPlay:SIGNal:LABel:FONTsize
driver.display.signal.label.set_fontsize(label_font_size = 1)

Sets the font size of waveform labels.

Parameters:

label_font_size – 7 to 30

Cloning the Group

# Create a copy of the original group, that exists independently
label_copy = driver.display.signal.label.clone()

Subgroups