awvPlaceWaveformLabel

awvPlaceWaveformLabel(
w_windowID
x_waveIndex
l_location
t_label
t_expr
[ ?textOffset g_textOffset ]
[ ?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 or a marker label to the specified trace in a subwindow.

Arguments

w_windowID	Waveform window ID.
x_waveIndex	Integer identifying the waveform. Use the awvGetWaveNameList function to return the number and names of the waveforms.
l_location	A list of coordinates that describe the location of the label.
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.
?textOffset g_textOffset
	Specifies whether to place a graph label or a marker label. Valid values are: t: Places a point marker and the corresponding marker label. nil: Places a graph label. The default value is t.
?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 or the marker label.
nil	The graph label or the marker label cannot be placed because of an error.

Examples

The following example returns the trace numbers and waveform names plotted in subwindow 2 of the current Waveform window.

awvGetWaveNameList(awvGetCurrentWindow() ?subwindow 2)

=> 

((2 5) 

    ("out" "net10")

)

The trace out is identified with the index number 2 and net10 is identified with the trace number 5.

The following example places a point marker and a label markerLabelonTraceNet10 on the trace net10 at x=50ns and y=0.5 in subwindow 2 of the current Waveform window.

awvPlaceWaveformLabel(awvGetCurrentWindow() 5 list(50ns 0.5) "markerLabelonTraceNet10" nil ?textOffset t ?subwindow 2)

=> ("pointMarker[45.79.17]")

The following example places a point marker and a label markerLabelonTraceOut on the trace out at x=50ns and y=2.5 in subwindow 2 of the current Waveform window.

awvPlaceWaveformLabel(awvGetCurrentWindow() 2 list(50ns 2.5) "markerLabelonTraceOut" nil ?textOffset t subwindow 2)

=> ("pointMarker[45.79.18]")

The following example places a graph label graphLabelonTraceOut on the trace out at x=0 and y=1 in subwindow 2 of the current Waveform window.

awvPlaceWaveformLabel(awvGetCurrentWindow() 2 list(0 1) "graphLabelonTraceOut" nil ?textOffset nil ?subwindow 2)

=> ("graphLabel[45.79.24]")

The following example places a graph label graphLabelonTraceNet10 on the trace net10 at x=1 and y=1 in subwindow 2 of the current Waveform window.

awvPlaceWaveformLabel(awvGetCurrentWindow() 5 list(1 1) "graphLabelonTraceNet10" nil ?textOffset nil ?subwindow 2)

=> ("graphLabel[45.79.25]")

Note the following points:

• The valid location of a graph label ranges between absolute x-axis and y-axis coordinates (0,0) and (1,1).
• The valid location of a marker ranges between data coordinates defined by x axis and y axis limits.

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

awvPlaceWaveformLabel(awvGetCurrentWindow() 2 list(0 2) "graphLabelonTraceOut" nil ?textOffset nil ?subwindow 2)

The location specified for placing a label on the graph is invalid. Specify a valid label location between the following ranges (upper and lower bounds inclusive).

x-axis: (0,1) 

y-axis: (0,1)

=> nil

The following example returns nil and reports an error because the specified location for the marker label is outside of the x-axis and y-axis limits of the graph:

awvPlaceWaveformLabel(awvGetCurrentWindow() 5 list(600ns 0.5) "markerLabelonTraceNet10" nil ?textOffset t ?subwindow 2)

The location specified for placing a marker on the graph is invalid. Specify a valid marker location between the following ranges (upper and lower bounds inclusive).

x-axis: (0.0,5e-07)

y-axis: (-3.388872,4.206791)

=> nil

Return to top