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

awvGetXAxisUseStepValue

awvGetXAxisUseStepValue(
w_windowID
[ ?subwindow x_subwindow ]
)
=> t_isStepSizeUsed / nil

Description

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

Arguments

w_windowID

Waveform window ID.

?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 x axis in the specified graph.

Valid values are:

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

nil

The specified Waveform window or subwindow does not exist.

Examples

The following example indicates that the step size for the major divisions of x axis is used for the graph in the subwindow 2 of the specified Waveform window.

awvGetXAxisUseStepValue(window(10) ?subwindow 2)
=> "true"

The following example indicates that the step size for the major divisions of x axis is not used for the graph in the subwindow 3 of the specified Waveform window.

awvGetXAxisUseStepValue(window(11) ?subwindow 3)
=> "false"

Return to top
 ⠀
X