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

awvSetYLimit

awvSetYLimit(
w_windowID
x_yNumber
l_minMax
[ ?stripNumber x_stripNumber ]
[ ?subwindow x_subwindow ]
)
=> t / nil

Description

Sets the display limits of the specified y axis for the waveform with the specified strip number in a subwindow. If you do not specify the ?stripNumber argument, the limits are applied when the subwindow is in composite mode.

Arguments

w_windowID

Waveform window ID.

x_yNumber

Number of y axis whose display limits to be set. The value can be any integer from 1 through 4.

l_minMax

List of two y-axis values that define the range of display. The first value in the list sets the minimum value of y axis. The second value in the list sets the maximum value of y axis.

If this argument is set to nil, the limit is set to autoscale.

?stripNumber x_stripNumber

Identifies the strip in which limit of y axis is to be set. If you do not specify this argument, the currently selected strip is used.

If no strip is currently selected in the specified subwindow or the current subwindow, the default value 1 is used, which means that the operation is performed on the trace with strip number 1.

?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

Display limits of the specified y-axis number are set successfully.

nil

The specified Waveform window, subwindow, y-axis number, or the strip number does not exist.

Examples

The following example sets the display limit of y-axis number 4 from -400 to 400. This setting takes effect only in composite mode.

awvSetYLimit(window(34) 4 list(-400 400))
=> t

The following example sets the display limit of y-axis number 2 in the strip number 4 of the current subwindow in the specified Waveform window. This setting takes effect only in strip mode.

awvSetYLimit(window(34) 2 list(-400 400) ?stripNumber 4)
=> t

Return to top
 ⠀
X