User Tools

Site Tools


doc:project-files-format-legacy:label

Label

Documentation | Other Specifications | Project file format (legacy) | Label

This section includes label parameters (used on Layer)

Visible

Label.Visible=Parameter

Use Visible=FALSE to turn-off labels.

Parameters Description
BooleanTRUE, FALSE

Applies to Layer.

Allocator

Label.Allocator=Parameter

Use Allocator=TRUE to avoid label overlapping.

Parameters Description
BooleanTRUE, FALSE

Applies to Layer.

Duplicates

Label.Duplicates=Parameter

Use duplicates=FALSE to avoid duplicated label.

Parameters Description
BooleanTRUE, FALSE

Applies to Layer.

Field

Label.Field=Parameter

Data field for label contents.

If starting from ':' a character, then the multifield format applies.

General format:

:any text<[specifier]:[field_name]> any text<p>

Specifier can be:

- for numeric and string fields: a format string as applied for standard Format() function;

- for date fields: a format string as applied for standard FormatDateTime() function.

Parameters Description
Stringfield name or field list

Example

Field=NAME
Field=:State=<:NAME>\n<.8d:POPULATION\>

Applies to Layer.

Value

Label.Value=Parameter

Label value.

Parameters Description
Stringfield value

Applies to Layer.

Alignment

Label.Alignment=Parameter

Label alignment. FOLLOW is valid only for lines and means: rotate and follow the shape.

Parameters Description
AlignmentSINGLE, LEFTJUSTIFY, CENTER, RIGHTJUSTIFY, FOLLOW

Applies to Layer.

Position

Label.Position=Parameter

Label position. FLOW means that the label placement will be computed dynamically to guarantee label visibility (will not be based on a centroid).

Parameters Description
Position[:ANY] [:FLOW] [:LEFT] [:UPCENTER] [:UPRIGHT] [:MIDDLELEFT] [:MIDDLECENTER] [:MIDDLERIGHT] [:DOWNLEFT] [:DOWNCENTER] [:DOWNRIGHT] [:UPRRIGHTFIRST] [:UPLEFTFIRST] [:MIDDLEFIRST] [:FLOW]

Applies to Layer.

Color

Label.Color=Parameter

Background color for labels.

Parameters Description
Integerinteger BGR (e.g. $000000)
RGBred:green:blue (e.g. 213:24:58)
Namecolor name: AQUA, GRAY, NAVY, SILVER, BLACK, GREEN, OLIVE, TEAL, BLUE, LIME, PURPLE, WHITE, FUCHSIA, MAROON, RED, YELLOW

Applies to Layer.

Font.Name

Label.Font.Name=Parameter

Font name for labels.

Parameters Description
Stringfont value

Applies to Layer.

Font.Size

Label.Font.Size=Parameter

Font size for labels in points.

Parameters Description
Integersize value

Applies to Layer.

Font.Style

Label.Font.Style=Parameter

Style parameter for label font.

Parameters Description
FontStylefsBold, fsItalic, fsUnderline, fsStrikeOut

Applies to Layer.

Font.Color

Label.Font.Color=Parameter

Font color for labels.

Parameters Description
Integerinteger BGR (e.g. $000000)
RGBred:green:blue (e.g. 213:24:58)
Namecolor name: AQUA, GRAY, NAVY, SILVER, BLACK, GREEN, OLIVE, TEAL, BLUE, LIME, PURPLE, WHITE, FUCHSIA, MAROON, RED, YELLOW

If Pattern=CLEAR, then label text will be drawn with Label.Color outline. To avoid this, use the same color for Font.Color and Label.Color.

Applies to Viewer.

Height

Label.Height=Parameter

Maximum height for labels.

Parameters Description
Integersize value ( positive integer - size in twips; negative integer - size in pixels )

Applies to Layer.

Bitmap

Label.Bitmap=Parameter

Background bitmap fill for labels.

Parameters Description
Bitmappicture bitmap handle

Applies to Layer.

Pattern

Label.Pattern=Parameter

Background pattern fill for labels.

Parameters Description
BrushStyleSOLID, BDIAGONAL, FDIAGONAL, CROSS, DIAGCROSS, HORIZONTAL, VERTICAL, TRANSPARENT

If Label.Pattern=CLEAR, then label text will be drawn with Label.Color outline. To avoid this, use the same color for Font.Color and Label.Color. Used only if Label.Bitmap is not set.

Applies to Layer.

Width

Label.Width=Parameter

Maximum width for labels.

Parameters Description
Integersize value ( positive integer - size in twips; negative integer - size in pixels )

Applies to Layer.

OutlineColor

Label.OutlineColor=Parameter

Outline color for labels.

Parameters Description
Integerinteger BGR (e.g. $000000)
RGBred:green:blue (e.g. 213:24:58)
Namecolor name: AQUA, GRAY, NAVY, SILVER, BLACK, GREEN, OLIVE, TEAL, BLUE, LIME, PURPLE, WHITE, FUCHSIA, MAROON, RED, YELLOW

Applies to Viewer.

OutlineBitmap

Label.OutlineBitmap=Parameter

Outline bitmap fill for labels.

Parameters Description
Bitmappicture bitmap handle

Applies to Layer.

OutlineWidth

Label.OutlineWidth=Parameter

Outline width for labels.

Parameters Description
Integersize value ( positive integer - size in twips; negative integer - size in pixels )

Valid only if Marker.Symbol is not set or if the Viewer is performing incremental paint.

Applies to Layer.

OutlinePattern

Label.OutlinePattern=Parameter

Outline pattern fill for labels.

Parameters Description
BrushStyleSOLID, BDIAGONAL, FDIAGONAL, CROSS, DIAGCROSS, HORIZONTAL, VERTICAL, TRANSPARENT

Valid only if Marker.Symbol is not set or if the Viewer is performing incremental paint.

Applies to Layer.

SmartSize

Label.SmartSize=Parameter

Minimum bounding box size that is to be visible.

Parameters Description
Integersize value ( positive integer - size in twips; negative integer - size in pixels )

If the shape in the current zoom is smaller, the shape will be invisible.

Applies to Layer.

SmartSizeField

Label.SmartSizeField=Parameter

Field on which SmartSize will be computed. Thanks to this, it is possible to add a more advanced rule for hiding to the database. Field contents must be an integer value, which will be treated as “size of importance”.

Parameters Description
Stringfield name

If the shape in the current zoom is smaller, the shape will be invisible.

Applies to Layer.

2019/12/18 10:42

Page Tools