awvGetLegendPos

awvGetLegendPos(
w_windowID
[ ?subwindow x_subwindow ]
)
=> t_legendPosition / nil

Description

Returns the position of the trace legend in a subwindow of the specified Waveform window.

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, position of the trace legend in the current subwindow is returned.

Value Returned

t_legendPosition	Position of the trace legend in a subwindow. Valid values are: above inside left
nil	The specified Waveform window or subwindow does not exist.

Examples

The following examples return the position of the trace legend in subwindows 1, 3, and 5 in the specified Waveform window, respectively.

awvGetLegendPos(window(4) ?subwindow 1)

=> "left"

awvGetLegendPos(window(4) ?subwindow 3)

=> "inside"

awvGetLegendPos(window(4) ?subwindow 5)

=> "above"

The following example returns the position of the trace legend in the current subwindow of the specified Waveform window.

awvGetLegendPos(window(4))

=> "above"

Return to top