Product Documentation
Virtuoso Schematic Editor SKILL Functions Reference
Product Version IC23.1, November 2023

schHiCreateSymbolLabel

schHiCreateSymbolLabel(
[ ?labelChoice t_labelChoice ]
[ ?text t_text ]
[ ?justify t_justify ]
[ ?fontStyle t_fontStyle ]
[ ?fontHeight n_fontHeight ]
[ ?type t_type ]
)
=> t

Description

Places labels in a symbol. Usable only when editing symbols.

Use schHiCreateSymbolLabel to create the labels that are normally required in a symbol. For each label to place, the function drags the label specified by t_text and prompts you for a location to place it. The function clears t_text and allows setting of various options after each label is placed.

Arguments

?labelChoice t_labelChoice

The kind of label to create; must be enclosed in quotation marks.
Valid Values: instance label, device annotate, logical label, physical label, pin label, pin annotate

?text t_text

Text of the label; must be enclosed in quotation marks.

?justify t_justify

Label justification of the text with respect to its placement; must be enclosed in quotation marks.
Valid Values: upperLeft, upperCenter, upperRight, centerLeft, centerCenter, centerRight, lowerLeft, lowerCenter, lowerRight

?fontStyle t_fontStyle

Label font style; must be enclosed in quotation marks.
Valid Values: euroStyle, fixed, gothic, math, roman, script, stick, swedish, milSpec

?fontHeight n_fontHeight

Label height in user units.
Default: 0.0625

?type t_type

Label type; must be enclosed in quotation marks.
Valid Values: normalLabel, NLPLabel, ILLabel

Value Returned

Always returns t.

Examples

Drags the instance label counter and prompts you for a location to place it.

schHiCreateSymbolLabel( "instance label" "counter" )

Return to top
 ⠀
X