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

schHiCreateNoteLabel

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

Description

Creates a note label to annotate the design for documentation purposes. These shapes do not affect connectivity. Usable when editing schematics or symbols.

If you do not specify t_text or you specify it as nil, the options form appears and prompts you for the note label text. The editor drags the label described by arguments and prompts you to select a location to place the label.

Arguments

?text t_text

Text for your note to include spaces, tabs, and new lines; must be enclosed in quotation marks.

?justify t_justify

Justification of the label 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
Default: normalLabel

Value Returned

Always returns t.

Examples

Creates the single string label Low Pass Filter Section using the current settings of all other arguments.

schHiCreateNoteLabel( ?text "Low Pass Filter Section" )

Return to top
 ⠀
X