awvGetXAxisLabel
awvGetXAxisLabel(
w_windowID
[ ?subwindow x_subwindow ]
[ ?computed g_computed ]
)
=> t_label / nil
Description
Returns the user-specified or the system-computed label of the x axis.
Arguments
|
w_windowID
|
Waveform window ID.
|
|
t_label
|
Label to be displayed for the x 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 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.
|
Value Returned
|
t_label
|
Returns the x-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 x axis t in the subwindow 3 of the specified Waveform window.
awvGetXAxisLabel(window(15) ?subwindow 3 ?computed nil)
=> "Time in microsecond"
Return to top
