Interface TextSymbolJson

Text symbols are used to add text to a feature (labeling).

See https://developers.arcgis.com/web-map-specification/objects/esriTS_symbol/.

interface TextSymbolJson {
    angle?: number;
    backgroundColor?: ColorJson;
    borderLineColor?: ColorJson;
    borderLineSize?: number;
    color?: ColorJson;
    font?: FontJson;
    haloColor?: ColorJson;
    haloSize?: number;
    horizontalAlignment?:
        | "center"
        | "left"
        | "right"
        | "justify";
    kerning?: boolean;
    rightToLeft?: boolean;
    rotated?: boolean;
    text?: string;
    type: "esriTS";
    verticalAlignment?:
        | "baseline"
        | "top"
        | "middle"
        | "bottom";
    xoffset?: number;
    yoffset?: number;
}

Hierarchy (view full)

Properties

angle? backgroundColor? borderLineColor? borderLineSize? color? font? haloColor? haloSize? horizontalAlignment? kerning? rightToLeft? rotated? text? type verticalAlignment? xoffset? yoffset?

Properties

Optionalangle

angle?: number

A numeric value that defines the number of degrees (0 to 360) that a text symbol is rotated. The rotation is from East in a counter-clockwise direction where East is the 0° axis.

OptionalbackgroundColor

backgroundColor?: ColorJson

Background color of the text.

OptionalborderLineColor

borderLineColor?: ColorJson

Value indicating the the color of the border line.

OptionalborderLineSize

borderLineSize?: number

Numeric value indicating the the size of the border line in points.

Optionalcolor

color?: ColorJson

Color is represented as a four-element array. The four elements represent values for red, green, blue, and alpha in that order. Values range from 0 through 255. If color is undefined for a symbol, the color value is null.

Optionalfont

font?: FontJson

Font used for text symbols.

OptionalhaloColor

haloColor?: ColorJson

Color of the halo around the text.

OptionalhaloSize

haloSize?: number

Numeric value indicating the point size of a halo around the text symbol.

OptionalhorizontalAlignment

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

The horizontal alignment of the text.

Optionalkerning

kerning?: boolean

Boolean value indicating whether to adjust the spacing between characters in the text string.

OptionalrightToLeft

rightToLeft?: boolean

Boolean value, set to true if using Hebrew or Arabic fonts.

Optionalrotated

rotated?: boolean

Boolean value indicating whether every character in the text string is rotated.

Optionaltext

text?: string

Only applicable when specified as a client-side graphic.

type

type

The type of symbol. See SymbolJsonType.

OptionalverticalAlignment

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

The vertical alignment of the text.

Optionalxoffset

xoffset?: number

Numeric value indicating the offset on the x-axis in pixels.

Optionalyoffset

yoffset?: number

Numeric value indicating the offset on the y-axis in pixels.

Settings

Member Visibility

On This Page

Properties