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

awvDeleteMarker

awvDeleteMarker(
w_windowID
t_bookmarkIDs
[ ?subwindow x_subwindow ]
)
=> t / nil

Description

Deletes the specified bookmarks from a subwindow of the specified Waveform window.

Arguments

w_windowID

Waveform window ID.

t_bookmarkIDs

ID of the bookmark to be deleted.

To specify more than one bookmark IDs, use the following notation:

'(bm1 bm2 bm3)

Where bm1, bm2, and bm3 are the IDs of the bookmarks to be deleted.

?subwindow x_subwindow

Identification number of the subwindow, which is found in the top-right corner of the subwindow.

If you do not specify this argument, the current subwindow is used.

Value Returned

t

Bookmarks are deleted successfully.

nil

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

Examples

The following example creates an xrange bookmark at the specified location in the current subwindow of the specified Waveform window.

bm1=awvPlaceBookmark(window(3) "xrange" list(50ns 300ns) ?waveIndex 1 ?description "xRangeBookmark")
=> ("xrangeBookmark[1.1.1]")

The following example creates a yrange bookmark at the specified location in the current subwindow of the specified Waveform window.

bm2=awvPlaceBookmark(window(3) "yrange" list(-2.5 2.5) ?waveIndex 1 ?description "yRangeBookmark")
=> ("yrangeBookmark[1.1.1]")

The following example deletes the xrange bookmark bm1 from the current subwindow of the specified Waveform window.

awvDeleteMarker(window(3) bm1)
=> t

The following example deletes the yrange bookmark bm2 from the current subwindow of the specified Waveform window.

awvDeleteMarker(window(3) bm2)
=> t

If you want to delete both bookmarks bm1 and bm2 together, use the following command:

awvDeleteMarker(window(3) '(bm1 bm2))
=> t

Return to top
 ⠀
X