awvPlaceWindowLabel

awvPlaceWindowLabel(
w_windowID
l_location
t_label
t_expr
[ ?color t_color ]
[ ?justify t_justify ]
[ ?fontStyle t_fontStyle ]
[ ?height t_height ]
[ ?orient t_orient ]
[ ?subwindow x_subwindow ]
)
=> s_labelID / nil

Description

Adds a graph label to a subwindow in the specified Waveform window.

Arguments

w_windowID	Waveform window ID.
l_location	A list of coordinates that describe the location of the label. The valid location of a graph label ranges between absolute x-axis and y-axis coordinates (0,0) and (1,1).
t_label	Text to display on the label.
t_expr	String containing an expression that is evaluated when the command is run, and re-evaluated at the completion of each simulation in auto-update mode. You can also set this argument to nil.
?color t_color	Color of the label. Available colors are defined in your technology file. Valid values are from y1 through y66.
?justify t_justify
	Justification for the label text. Valid values are lowerLeft, centerLeft, upperLeft, lowerCenter, centerCenter, upperCenter, lowerRight, centerRight, and upperRight.
?fontStyle t_fontStyle
	Font style for the label text. Valid Values are stick, fixed, euroStyle, gothic, math, roman, script, swedish, and milSpec.
?height t_height	Height of the label. Valid values are small, medium, and large.
?orient t_orient	Orientation of the label. Valid values are: R0: Sets the orientation to horizontal. R90: Sets the orientation to vertical.
?subwindow x_subwindow
	Number of the subwindow, which is found in the top-right corner of the subwindow. If you do not specify this argument, the current subwindow is used.

Value Returned

s_labelID	Identification number of the graph label.
nil	The graph label cannot be placed because of an error.

Examples

The following example places a graph label windowLabel1 in subwindow 2 of the specified Waveform window.

awvPlaceWindowLabel(window(3) list(0 0) "windowLabel1" nil ?subwindow 2)

=> ("graphLabel[1.1.3]")

The following example places a graph label windowLabel2 in subwindow 2 of the specified Waveform window.

awvPlaceWindowLabel(window(3) list(0 1) "windowLabel2" nil ?subwindow 2)

=> ("graphLabel[1.1.4]")

The following example places a graph label windowLabel3 in subwindow 2 of the specified Waveform window.

awvPlaceWindowLabel(window(3) list(1 1) "windowLabel3" nil ?subwindow 2)

=> ("graphLabel[1.1.5]")

The following example places a graph label windowLabel4 in subwindow 2 of the specified Waveform window.

awvPlaceWindowLabel(window(3) list(1 0) "windowLabel4" ?subwindow 2)

=> ("graphLabel[1.1.6]")

The following example places a graph label windowLabel5 in subwindow 2 of the specified Waveform window.

awvPlaceWindowLabel(window(3) list(0.5 0.5) "windowLabel5" ?subwindow 2)

=> ("graphLabel[1.1.7]")

The following example returns nil and reports an error because the specified location of the graph label is not with in the range (0,0) and (1,1).

awvPlaceWindowLabel(window(3) list(1 2) "windowLabel4" nil ?subwindow 2)

=> nil

Return to top