geAddHilightLabel
geAddHilightLabel(
g_hlSetId
l_origin
t_label
t_just
t_orient
t_font
n_height
g_draftingP
[ g_overBar ]
)
=> g_hlObjectId / nil
Description
Adds a label to a highlight set.
l_origin specifies the location of the label. Other attributes of the label are specified by t_label, t_just, t_orient, t_font, n_height, g_draftingP, and g_overbar.
Arguments
|
g_hlSetId
|
Database ID of the highlight set.
|
|
l_origin
|
Specifies the location of the label.
|
|
t_label
|
Specifies the text of the label.
|
|
t_just
|
Specifies the justification of the label.
Valid Values: upperLeft, upperCenter, upperRight, centerLeft, centerCenter, centerRight, lowerLeft, lowerCenter, lowerRight
|
|
t_orient
|
Specifies the orientation of the label.
Valid Values: R0 (no rotation), R90 (rotate 90 degrees), R180 (rotate 180), R270 (rotate 270), MX (mirror over the x axis), MYy (mirror over the y axis), MXR90 (mirror over the x axis and rotate 90 degrees), MYR90 (mirror over the y axis and rotate 90 degrees)
|
|
t_font
|
Specifies the font style used for the label.
Valid Values: europe, gothic, roman, script, stick
|
|
n_height
|
Specifies the height of the label.
|
|
g_draftingP
|
Determines how you can rotate text.
t allows the text to rotate 90 degrees, nil allows rotation in all directions.
|
|
g_overBar
|
Determines whether the label has an over-bar or not.
Valid Values: t, nil. Default: nil.
|
Value Returned
|
g_hlObjectId
|
The label is added to the set.
|
|
nil
|
The label is not added to the set.
|
Examples
Adds a label to the highlight set set1 with the origin at 0 0. The text is mytext, the justification is lowerleft, the font style is stick, and the height of the text is 2 user units. It returns the object ID of the label.
set1 = geCreateHilightSet( gec() list("Metal1" "drawing") nil )
set1->enable=t
geAddHilightLabel(set1 list(0 0) "mytext" "lowerLeft" "R0" "stick" 2 nil)
=>hl:0x3aa9e030
Related Topics
Highlight Functions
Return to top
