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

awvLogYAxis

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

Description

Specifies whether to set the display of y axis to logarithmic in a subwindow of the specified Waveform window.

Arguments

w_windowID

Waveform window ID.

x_yNumber

Number of y axis on which logarithmic scale is to be set. The value can be any integer from 1 through 4.

g_state

Specifies whether to set the display of y axis to logarithmic or linear.

Valid values are:

  • t: Sets the display of y axis to logarithmic.
  • nil: Sets the display of y axis to linear.

?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, label for the x axis is set in the current subwindow.

Value Returned

t

Display of the 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 display for the y-axis number 2 of the strip 3 to logarithmic in subwindow 4 of the specified Waveform window.

awvLogYAxis(window(11) 2 t ?stripNumber 3 ?subwindow 4)
=> t

The following example sets the display for the y-axis number 3 of the strip 3 to linear in subwindow 4 of the specified Waveform window.

awvLogYAxis(window(11) 3 nil ?stripNumber 3 ?subwindow 4)
=> t

Return to top
 ⠀
X