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

awvSetWaveformDisplayStatus

awvSetWaveformDisplayStatus(
w_windowID
x_waveIndex
g_enable
[ ?subwindow x_subwindow ]
)
=> t / nil

Description

Displays or hides a waveform in a subwindow of the specified Waveform window.

You can use this function to hide a waveform without deleting it.

Arguments

w_windowID

Waveform window ID.

x_waveIndex

Index number of the waveform to be hidden or displayed.

You can use the awvGetWaveNameList function to return a list of index numbers of the waveforms plotted in a subwindow of the specified Waveform window.

g_enable

Specifies whether to display or hide the specified waveform.

Valid values are:

  • t: Displays the waveform.
  • nil: Hides the waveform.

?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

The waveform is displayed or hidden successfully.

nil

The specified Waveform window, subwindow, or the waveform index does not exist.

Examples

The following example returns the indexes and signal names of the waveforms plotted in the subwindow 2 of the current Waveform window.

win=awvGetCurrentWindow()
=> window:110
awvGetWaveNameList(win ?subwindow 2)
=>
((26 17 18 19) 
    ("/net027" "/net028" "/net029" "/net030")
)

The following example hides the waveform of the signal net030 plotted in the subwindow 2 of the current Waveform window.

awvSetWaveformDisplayStatus(win 19 nil ?subwindow 2)
=> t

Return to top
 ⠀
X