awvSetYAxisLabel
awvSetYAxisLabel(
w_windowID
x_yNumber
t_label
[ ?subwindow x_subwindow ]
[ ?stripNumber x_stripNumber ]
)
=> t / nil
Description
Sets the specified label on the specified y-axis number in the current strip or the specified strip.
Arguments
|
w_windowID
|
Waveform window ID.
|
|
x_yNumber
|
Number of y axis whose label is to be set. The value can be any integer from 1 through 4.
|
|
t_label
|
Label to be set on y axis.
|
|
?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 y axis is set in the current subwindow.
|
|
?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
|
Y-axis label 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 label Signal Voltage to the y-axis number 1 in the strip number 2 of subwindow 3 in the current Waveform window.
awvSetYAxisLabel(awvGetCurrentWindow() 1 "Signal Voltage" ?stripNumber 2 ?subwindow 3)
=> t
Return to top
