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

awvSetYRange

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

Description

Sets the range of y axis in the specified strip in a subwindow. The specified range must be positive.

The range is the difference between the maximum y-axis value and the minimum y-axis value. The maximum value for y axis is automatically computed according to the waveforms. The minimum is calculated by subtracting the specified range from the maximum y-axis value.

Arguments

w_windowID

Waveform window ID.

x_yNumber

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

n_range

Range you want to set for y axis.

?stripNumber x_stripNumber

Identifies the strip in which range of y axis is to be set. If you do not specify this argument, the range is set in the current strip.

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

Range for the specified y-axis is set successfully.

nil

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

Examples

The following example sets the range of y-axis number 1 to 10 in strip number 2 of the current subwindow in the specified Waveform window.

awvSetYRange(window(3) 1 10 ?stripNumber 2)
=> t

Return to top
 ⠀
X