Product Documentation
Virtuoso Visualization and Analysis XL SKILL Reference
Product Version IC23.1, November 2023

awvRemoveLabel

awvRemoveLabel(
w_windowID
s_labelID | l_labelID
[ ?subwindow x_subwindow ]
)
=> t / nil

Description

Removes the specified labels (graph labels and marker labels) in a subwindow of the specified Waveform window.

Arguments

w_windowID

Waveform window ID.

s_labelID

ID of a graph or a marker label to be removed.

l_labelID

A list containing IDs of graph and marker labels to be removed.

?subwindow x_subwindow

Identification number of the subwindow (found in the top-right corner of the subwindow) from which graph and marker labels are to be removed.

If you do not specify this argument, the labels are removed from the current subwindow.

Value Returned

t

Specified graph and marker labels are removed.

nil

The specified Waveform window, subwindow, or label ID does not exist.

Examples

The following example returns the trace numbers and names of the waveforms plotted in subwindow 2 of the specified Waveform window.

awvGetWaveNameList(window(3) ?subwindow 2)
=>
((1 2) 
    ("net10" "out")
)

The following example places a marker label markerLabel1 on the trace out at x=150ns and y=3.

awvPlaceWaveformLabel(window(3) 2 list(150ns 3) "markerLabel1" nil ?textOffset t ?subwindow 2)
=> ("pointMarker[1.1.1]")

The label ID of markerLabel1 is "pointMarker[1.1.1]".

The following example places a marker label markerLabel2 on the trace net10 at x=50ns and y=1.

awvPlaceWaveformLabel(window(3) 1 list(50ns 1) "markerLabel2" nil ?textOffset t ?subwindow 2)
=> ("pointMarker[1.1.2]")

The label ID of markerLabel2 is "pointMarker[1.1.2]".

The following example places a graph label graphLabel1 on trace net10 at x=1 and y=1.

awvPlaceWaveformLabel(window(3) 1 list(1 1) "graphLabel1" nil ?textOffset nil ?subwindow 2)
=> ("graphLabel[1.1.1]")

The label ID of graphLabel1 is "graphLabel[1.1.1]".

The following example places a graph label graphLabel2 on trace out at x=0 and y=1.

awvPlaceWaveformLabel(window(3) 2 list(0 1) "graphLabel2" nil ?textOffset nil ?subwindow 2)
=> ("graphLabel[1.1.2]")

The label ID of graphLabel2 is "graphLabel[1.1.2]".

The following example removes graphLabel2 from subwindow 2 of the specified Waveform window.

awvRemoveLabel(window(3) "graphLabel[1.1.2]" ?subwindow 2)
=> t

The following example removes markerlabel1, markerLabel2, and graphLabel1 from subwindow 2 of the specified Waveform window.

awvRemoveLabel(window(3) list("pointMarker[1.1.2]" "pointMarker[1.1.1]" "graphLabel[1.1.1]") ?subwindow 2)
=> t

Return to top
 ⠀
X