Command: glabel

Syntax

{<entity> = } glabel {<message> ... }

Description

Create a label text graphic entity, or a series of points forming a text label.

Parameters

• <entity>
  An entity or gstructure identifier. The glabel entity will be given this name.

• <message>
  One or more values in the form of an output list. Each <message> constitutes one line of graphic text.

Switches

• -alph=<num>
  An alpha transparency factor between 0 and 1. A value 1 implies fully opaque, 0 means fully transparent (therefore invisible). The default is 1.

• -ang=<angle>
  The angle of the text base line. If omitted, the default text angle (def_text_angle) is used. Only scalable fonts can be displayed at an angle. The measure of the angle (e.g. degrees, radians) is assumed to be the value of the system string angle_mode.

• -br=<num>
  A brightness factor between -1 and +1. A value 0 means normal, -1 means very dark (black), +1 means very bright (white). The default is 1.

• -col=<color>
  The color of the text. If included, this will override any color defined in the textstyle (-ts). If omitted, the value no_change is used.

• -ff
  Fix the fill color so that it is unaffected by subsequent modifications to the entity color.

• -fil=<fillstyle>
  Define the fill characteristics of the frame. If omitted, the frame is not filled. This attribute is applied only when a frame style (-tf) has been defined. Note: <fillstyle> can be a fillstyle, color, tile, hatchstyle or graduation.

• -fr=<num>
  Define a fragment number for the entity. If omitted, the default fragment def_fragment is used.

• -g=<groups>
  The graphic groups of which the entity is to be a member.

• -h=<num>
  The character height of the text. If omitted, the default height (def_text_height) is used. Only scalable fonts can have variable height.

• -if=<file>
  A file providing the text value. This will supersede any <message> parameters on the command line.

• -j=<string>
  The text justification, a combination of L,R,T,B and M. If omitted, the default text justification (def_text_just) is used.

• -oc=<occ>
  A string phrase yielding an occurrence. This indicates on which 3-D views the label is to be shown. If omitted, an occurrence of the current view in the current graphic window is used.

• -op=<ident>
  A point identifier into which point coordinates formed by the text strokes are to be recorded. This option is not available when an entity is being created. If <ident> does not exist a new point array is created using current scope rules.

• -out
  Draw the frame outline, e.g. when the frame is color-filled via -tf. This is the default behavior. Use -no_out to omit the frame outline.

• -p=<point>
  The position of the text in 3-D space. If omitted, the current value of graphic control is used.

• -ra=<num>
  Define a rank for the entity. If omitted, the default rank def_rank is used.

• -tf=<num>
  Put a frame around the label text. The value of <num> indicates the frame style and can be one of the following:

Value	Shape
0	No frame (the default)
1	Rectangle
2	Square
3	Ellipse
4	Circle
5	Diamond
6	Lozenge
7	Button

• -th=<num>
  The thickness of the text and frame (if included). Text thickening will be applied only to Fire software fonts.

• -ts=<textstyle>
  The textstyle for the text, including font, aspect ratio etc. If omitted, the default text style (def_ts) is used. The textstyle can have a scalable or fixed font.

• -und
  Underline the text. The default behavior is not to.

Notes

The glabel command should be used for 2-D annotations and schematics. For 3-D text display, the gtext command should be used.

If the command has the form <entity> = glabel, an entity is always created.

If the command has no entity assignment, then an entity will be created only if the -op option is not used, or the command is not within another entity creation block, e.g. lines, polygon.

Examples

Create an unnamed single line glabel entity in a lozenge.

glabel 'BEGIN', -tf=6, -fil=blue

Create a named glabel entity (two lines of text).

entity my_label = glabel 'Line 1','Line 2', -h=50, -ts=anno_gothic

See Also