Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TextSymbol

Hierarchy

Index

Properties

angle

angle: number

The angle of the text.

Read more...

backgroundColor

backgroundColor: Color

The background color of the label's bounding box.

Read more...

borderLineColor

borderLineColor: Color

The border color of the label's bounding box.

Read more...

borderLineSize

borderLineSize: number

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

Read more...

color

color: Color

The color of the symbol.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

font

font: Font

The Font used to style the text.

Read more...

haloColor

haloColor: Color

The color of the text symbol's halo.

Read more...

haloSize

haloSize: number

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

Read more...

horizontalAlignment

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

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

Read more...

initialized

initialized: boolean

kerning

kerning: boolean

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

Read more...

lineHeight

lineHeight: number

The height of the space between each line of text.

Read more...

lineWidth

lineWidth: number

The maximum length in points for each line of text.

Read more...

rotated

rotated: boolean

Determines whether every character in the text string is rotated.

Read more...

text

text: string

The text string to display in the view.

Read more...

Readonly type

type: "text"

verticalAlignment

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

Adjusts the vertical alignment of the text.

Read more...

xoffset

xoffset: number

The offset on the x-axis in points.

Read more...

yoffset

yoffset: number

The offset on the y-axis in points.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): TextSymbol
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns TextSymbol

clone

  • Creates a deep clone of the symbol.

    Read more...

    Returns TextSymbol

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns TextSymbol

  • Parameters

    Returns TextSymbol

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc