TextSymbolProperties | @types/arcgis-js-api

Hierarchy

SymbolProperties
- TextSymbolProperties

Index

Properties

Optional angle

angle: number

The angle of the text.

Optional backgroundColor

backgroundColor: string | Color | number[]

The background color of the label's bounding box.

Optional borderLineColor

borderLineColor: string | Color | number[]

The border color of the label's bounding box.

Optional borderLineSize

borderLineSize: number

The border size or width of the label's bounding box.

Optional color

color: string | Color | number[]

The color of the symbol.

Optional font

font: FontProperties

The Font used to style the text.

Optional haloColor

haloColor: string | Color | number[]

The color of the text symbol's halo.

Optional haloSize

haloSize: string | number

The size in points of the text symbol's halo.

Optional horizontalAlignment

horizontalAlignment: "center" | "left" | "right" | "justify"

Adjusts the horizontal alignment of the text in multi-lines.

Optional kerning

kerning: boolean

Determines whether to adjust the spacing between characters in the text string.

Optional lineHeight

lineHeight: number

The height of the space between each line of text.

Optional lineWidth

lineWidth: string | number

The maximum length in points for each line of text.

Optional rotated

rotated: boolean

Determines whether every character in the text string is rotated.

Optional text

text: string

The text string to display in the view.

Optional verticalAlignment

verticalAlignment: "top" | "bottom" | "baseline" | "middle"

Adjusts the vertical alignment of the text.

Optional xoffset

xoffset: string | number

The offset on the x-axis in points.

Optional yoffset

yoffset: string | number

The offset on the y-axis in points.