awvGetYAxisLabel
awvGetYAxisLabel(
w_windowID
x_yNumber
[ ?subwindow x_subwindow ]
[ ?computed g_computed ]
[ ?stripNumber x_stripNumber ]
)
=> t_label / nil
Description
Returns the user-specified or the system-computed label of the specified y-axis number.
Arguments
|
w_windowID
|
Waveform window ID.
|
|
x_yNumber
|
Number of y axis whose label is to be returned. The value can be any integer from 1 through 4.
|
|
?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.
|
|
?computed g_computed
|
|
|
Specifies whether to return the user-specified label of the x axis.
Valid values are:
-
t: Returns the system-computed label of the x axis. -
nil: Returns the user-specified label of the x axis.
|
|
?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.
|
Value Returned
|
t_label
|
Returns the y-axis label in the specified subwindow.
|
|
nil
|
The specified Waveform window or subwindow does not exist.
|
Examples
The following example returns the user-specified label for the y-axis number 1 in the strip number 2 of subwindow 1 in the current Waveform window.
awvGetYAxisLabel(awvGetCurrentWindow() 1 ?computed nil ?stripNumber 2 ?subwindow 1)
=> "Signal Voltage"
Return to top
