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

awvGetYAxisStepValue

awvGetYAxisStepValue(
w_windowID
x_yNumber
[ ?stripNumber x_stripNumber ]
[ ?subwindow x_subwindow ]
)
=> x_stepSize / nil

Description

Returns the step size for the major divisions of specified y axis of a strip in the specified subwindow of a Waveform window. The step value indicates the spacing between major divisions of y axis.

Arguments

w_windowID

Waveform window ID.

x_yNumber

Number of y axis whose step size is to be returned. The value can be any integer from 1 through 4.

?stripNumber x_stripNumber

Strip number of the trace. 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

x_stepSize

Step size for the major divisions of the specified y axis in the specified graph.

nil

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

Examples

The following example returns the step size for the major divisions of the y-axis number 1 of the strip number 2 in the subwindow 3 of the specified Waveform window.

awvGetYAxisStepValue(window(19) 1 ?stripNumber 2 ?subwindow 3)
=> 0.0005

This indicates that major divisions of the specified y axis are spaced at 500uV (0.0005) in the specified graph.


Return to top
 ⠀
X