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

awvDisplayGrid

awvDisplayGrid(
w_windowID
g_on
[ ?subwindow x_subwindow ]
)
=> t / nil

Description

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

Arguments

w_windowID

Waveform window ID.

g_on

Specifies whether to display grids.

Valid values are:

  • t: Displays grids.
  • nil: Hides grids.

?subwindow x_subwindow

Identification number of the subwindow (found in the top-right corner of the subwindow) in which grids are to be displayed or hidden.

If you do not specify this argument, grids in the current subwindow are displayed or hidden.

Value Returned

t

Grids are displayed or hidden in a subwindow of the specified Waveform window.

nil

The specified Waveform window does not exist.

Examples

The following example displays grids in the subwindow 1 of the current Waveform window.

win = awvGetCurrentWindow()
=> window:4
awvDisplayGrid(win t ?subwindow 1)
=> t

The following example hides grids in the subwindow 4 of the current Waveform window.

win = awvGetCurrentWindow()
=> window:4
awvDisplayGrid(win nil ?subwindow 4)
=> t


Return to top
 ⠀
X