CoCreate OneSpace Designer - Commands Reference Manual

CF_LABEL_SETTINGS provides methods to change the display properties of a label.

Syntax

                             +-----------<-------------------------------+
                             |                                           |
 (T) (CF_LABEL_SETTINGS)---->+--->(:LABELS)------->|custom-feature|------+
                                                                         |
                +<-------------------------------------------------------+
                |                                                        ^
                +--->(:FONTNAME)----------+----->|pick font|-----------+-^
                +--->(:SIZE)--------------+----->|length|--------------+-^
                +--->(:FRAME_TYPE)--------+----->(:OFF or :BOX)--------+-^
                |                                                        ^
                +--->(:TEXT_DISP_MODE)----+----->(:IN-PLANE)-----------+-^
                |                         +----->(:IN-VIEW)------------+-^
                |                                                        ^
                +--->(:FILL)--------------+----->(:ON or :OFF)---------+-^
                +--->(:COLOR)-------------+----->|GET_RGB_COLOR_SA|----+-^
                |                                                        ^
                +--->(:ARROW_SIZE)--------+----->|length|--------------+-^
                |                                                        ^
                +--->(:ANCHOR_PT)---------+----->(:UL)------+----------+-^
                |                         +----->(:ML)------+            ^
                |                         +----->(:LL)------+            ^
                |                                                        ^
                +--->(:ARROW_TYPE)--------+----->(:NONE)-----+---------+-^
                |                         +----->(:ARROW)----+           ^
                |                         +----->(:DOT)------+           ^
                |                         +----->(:SLASH)----+           ^
                |                         +----->(:TRIANGLE)-+           ^
                |                         +----->(:JIS)------+           ^
                |                                                        ^
                +--->(:ARROW_FILL)--------+----->(:ON)------+----------+-^
                |                         +----->(:OFF)-----+            ^
                |                                                        ^
                |                                                        ^
                +--->(:LINE_DIST)---------+----->|length|--------------+-^
                +--->(:BORDER_WIDTH_LEFT)-+----->|length|--------------+-^
                +--->(:BORDER_WIDTH_RIGHT)+----->|length|--------------+-^
                +--->(:BORDER_WIDTH_UPPER)+----->|length|--------------+-^
                +--->(:BORDER_WIDTH_LOWER)+----->|length|--------------+-^
                +--->(:LEADER_LENGTH)-----+----->|length|--------------+-^
                +--->(:BASE_LENGTH)-------+----->|length|--------------+-^
                +--->(:GAP_EL_TO_ELEM)----+----->|length|--------------+-^
                +--->(:GAP_DL_TO_BOX)-----+----->|length|--------------+-^

Options

• :LABELS - specifies the labels to modify. This can be used with the Select tool for multiple selection of labels.
• :FONTNAME - specifies the new font for the label text. Valid font names, entered within double quotes (" "), are those for already loaded fonts.
• :SIZE - specifies the new text size (height).
• :FRAME_TYPE - specifies whether a frame (:BOX) is to be drawn around the text, or if there should be no frame (:OFF).
• :TEXT_DISP_MODE - specifies the mode for the label orientation:
  • :IN-PLANE positions the label in a fixed plane in space.
  • :IN-VIEW positions the label so that it is always normal to the view direction, regardless of how the model is rotated.
• :FILL - sets filled (:ON) or unfilled (:OFF) text characters. This will only affect text fonts that can be filled.
• :COLOR - sets the new label color. It automatically calls up the GET_RGB_COLOR_SA subaction. Use this subaction to specify the new RGB or HSL color.
• :ARROW_SIZE - specifies the new size of the label leader line arrowhead.
• :ANCHOR_PT - specifies the anchor point of the leader line on the label:
  • :UL sets an upper anchor.
  • :ML sets a middle anchor.
  • :LL sets a lower anchor.
• :ARROW_TYPE - specifies the type of arrowhead to end the leader line.
• :ARROW_FILL - sets filled (:ON) or unfilled (:OFF) arrowheads.
• :LINE_DIST - specifies the line spacing within labels as a fraction of the text size.
• :BORDER_WIDTH_LEFT - specifies the gap between the left side of the label and the label text, stated as a fraction of the text size.
• :BORDER_WIDTH_RIGHT - specifies the gap between the right side of the label and the label text, stated as a fraction of the text size.
• :BORDER_WIDTH_UPPER - specifies the gap between the top of the label and the label text, stated as a fraction of the text size.
• :BORDER_WIDTH_LOWER - specifies the gap between the bottom of the label and the label text, stated as a fraction of the text size.
• :LEADER_LENGTH - specifies an exact length of the leader line from the reference point to the base line of the label.
• :BASE_LENGTH - specifies an exact length of the base line from the leader line to the label.
• :GAP_EL_TO_ELEM - specifies the gap between the reference element to the beginning of the leader line.
• :GAP_DL_TO_BOX - specifies the gap between the end of the base line to the label.

When to use

Example

CF_LABEL_SETTINGS [select label] :SIZE 4 :BORDER_WIDTH_LEFT 2 :BORDER_WIDTH_RIGHT 2 :BORDER_WIDTH_UPPER 2 :BORDER_WIDTH_LOWER 2

See also