awvSetLegendPos

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

Description

Sets the position of the trace legend in a graph.

Arguments

w_windowID	Waveform window ID.
t_legendPosition	Position of the trace legend. Valid values are: above inside left
?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, the specified position of the trace legend is set to the graph in the current subwindow.

Value Returned

t	Position of the trace legend is set successfully.
nil	Position of the trace legend cannot be set because of an error.

Examples

The following example sets the position of the trace legend to above for the graph in subwindow 2 of the current Waveform window.

win=awvGetCurrentWindow()

=> window:10

awvSetLegendPos(win "above" ?subwindow 2)

=> t

The following example sets the position of the trace legend to inside for the graph in subwindow 3 of the specified Waveform window.

awvSetLegendPos(window(11) "inside" ?subwindow 3)

=> t

Return to top