schHiCreateWireLabel
schHiCreateWireLabel(
[ ?text t_text ]
[ ?purpose t_purpose ]
[ ?justify t_justify ]
[ ?fontStyle t_fontStyle ]
[ ?fontHeight n_fontHeight ]
[ ?interpret t_interpret ]
[ ?mode t_mode ]
[ ?netExprFlag g_netExprFlag ]
[ ?bundleDisplay t_bundleDisplay ]
)
=> t
Description
Creates wire labels in a schematic. Physical contact between a label and wire is not required. You can move a label independently from a wire. When you move a wire that has a label glued to it, the label also moves. Usable only when editing schematics.
Specify nil for any option you wish to skip over.
Arguments
|
?text t_text
|
Text of the label; must be enclosed in quotation marks. To create more than one label, use a space between labels as a delimiter. The schematic editor places each label individually. If you modify any portion of t_text while the function is active, label generation begins again from the first label in t_text.
|
|
?purpose t_purpose
|
Purpose of the placed label; must be enclosed in quotation marks. If you set t_purpose to label, the placed label assigns the given name to the indicated wire by renaming it. If you set t_purpose to alias, the placed label defines an alias for the indicated wire.
Valid Values: label, alias
|
|
?justify t_justify
|
Justification of the label text with respect to its placement location; 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
|
|
?interpret t_interpret
|
Interpretation of t_text; must be enclosed in quotation marks. If you set t_interpret to member, a label for each member name listed in t_text is generated in the order presented in t_text and each of these member name labels is placed individually. If you set t_interpret to full, a label for each space-delimited terminal name from t_text is placed individually. When t_interpret is changed from member to full, the label text is reset to the full text of the name that generated the current member name.
Valid Values: full, member
|
|
?mode t_mode
|
Mode to place the labels; must be enclosed in quotation marks. If you set t_mode to single, you can drag each label to place it. If you click an open area, a rubberband line is drawn from the control point of the label and prompts you for the location of the wire segment to label. If you set t_mode to array, you are prompted for a location to place the first and second labels. These two points define a directed line that extends from the first point to the second. Any labels remaining to be placed are applied to the wires that cross the directed line. The offset distance from the first wire to the first label is used to offset the remaining labels from the indicated wires at the point that the wires cross the directed line. If the directed line crosses fewer wires than there are remaining labels to place, the function repeats the mode by dragging the next label and prompting for its placement location. If the directed line crosses more wires than there are labels remaining to place, the excess lines are not labeled and the function terminates.
Valid Values: single, array
|
|
?netExprFlag g_netExprFlag
|
|
|
A boolean variable when set to t specifies that the t_text argument can be used as the net expression text. Else, the text is specified through the environment variable createNetExprText.
|
|
?bundleDisplay t_bundleDisplay
|
|
|
A string indicating the direction of showing wire bundles on the canvas, either horizontal or vertical.
|
Value Returned
Examples
Creates individual member names data<7> through data<0>.
schHiCreateWireLabel( "date<7:0>" "label" nil nil nil "member" )
Displays the options form and prompts you to specify the label text.
schHiCreateWireLabel( nil "label" )
Creates individual member names addr<7> through addr<0> and places the label in the upper left corner of the wire.
schHiCreateWireLabel( "addr<7:0>" "label" "member" "upperLeft" )
Creates each space-delimited label name: data1, data2, and data3.
schHiCreateWireLabel( "data1 data2 data3" "label" "full" "single" )
Return to top
