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

awvGetYAxisUseStepValue

awvGetYAxisUseStepValue(
w_windowID
x_yNumber
[ ?stripNumber x_stripNumber ]
[ ?subwindow x_subwindow ]
)
=> t_isStepSizeUsed / nil

Description

Indicates whether the step size is used for the major divisions of the specified y axis in the specified graph.

Arguments

w_windowID

Waveform window ID.

x_yNumber

Number of y axis. 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

t_isStepSizeUsed

Indicates whether the step size is used for the major divisions of y axis in the specified graph.

Possible values are:

  • true: Step size is used.
  • false: Step size is not used.

nil

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

Examples

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

awvGetYAxisUseStepValue(window(10) 1 ?stripNumber 2 ?subwindow 3)
=> "true"

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

awvGetYAxisUseStepValue(window(11) 1 ?stripNumber 3 ?subwindow 2)
=> "false"

Return to top
 ⠀
X