schCreateNoteLabel
schCreateNoteLabel(
d_cvId
l_point
t_text
t_just
t_orient
t_fontStyle
n_fontHeight
t_type
)
=> d_label / nil
Description
Creates note labels in a schematic or symbol cellview with the attributes and properties you specify. These labels do not affect the connectivity but can be useful for annotation.
Arguments
|
d_cvId
|
Cellview ID of an editable schematic or symbol cellview in which to create the note label.
|
|
l_point
|
Location of the note label specified as a point.
|
|
t_text
|
Text of the note label; must be enclosed in quotation marks.
|
|
t_just
|
Justification of the label text with respect to its placement. Use string values; must be enclosed in quotation marks. Valid Values: upperLeft, upperCenter, upperRight, centerLeft, centerCenter, centerRight, lowerLeft, lowerCenter, lowerRight
|
|
t_orient
|
Orientation of the note label; must be enclosed in quotation marks. Valid Values: R0, R90, R180, R270, MY, MYR90, MX, MXR90
|
|
t_fontStyle
|
Font style of the label; must be enclosed in quotation marks. Valid Values: euroStyle, fixed, gothic, math, roman, script, stick, swedish, milSpec
|
|
n_fontHeight
|
Label height in user units. Default: 0.0625
|
|
t_type
|
Type of label to create; must be enclosed in quotation marks. Valid Values: normalLabel, NLPLabel, ILLabel
|
Value Returned
|
d_label
|
The ID of the new label.
|
|
nil
|
Note label creation was unsuccessful.
|
Example
Creates a note label called any Text String in the specified cellview located at 0,1.875 with no rotation. The label’s control point is justified at the lower left of the label, the font is a fixed-width font, the height is 0.125 user units, and it is a normal label.
labelId = schCreateNoteLabel( cv 0.0:1.875 "any Text String" "lowerLeft" "R0" "fixed" 0.125 "normalLabel" )
Return to top