Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HighlightedLabelGraphic

Creates a highlighted label and adds it to a specified graphics layer on the map. The label could be a simple rectangle or a callout with an id text tag and a pointer pointing to the map point associated with this label.

Hierarchy

  • HighlightedLabelGraphic

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _calloutSizeWidthFraction

_calloutSizeWidthFraction: number

Protected _config

_config: HighlightedLabelConfig

Protected _height

_height: number

Protected _key

_key: string

Protected _padding

_padding: number

Protected _tagHeightPercentage

_tagHeightPercentage: number

Protected _width

_width: number

app

app: ViewerApplication

calculateLabelPoint

calculateLabelPoint: function

Type declaration

    • (): void

    • Returns void

graphicsLayer

graphicsLayer: GraphicsLayer

highlightGraphic

highlightGraphic: Graphic

highlightIdTagGraphic

highlightIdTagGraphic: Graphic

highlightIdTagSymbol

highlightIdTagSymbol: SimpleMarkerSymbol

highlightSymbol

highlightSymbol: SimpleMarkerSymbol

textGraphics

textGraphics: Graphic[]

textSymbols

textSymbols: TextSymbol[]

Methods

Protected _executeSetupRoutine

  • _executeSetupRoutine(): void

  • Returns void

Protected _processConfig

addToLayer

  • addToLayer(show?: boolean): void

  • Parameters

    • Optional show: boolean

    Returns void

assignGraphicIdentifierKey

  • assignGraphicIdentifierKey(key: string, value: string): void

  • Parameters

    • key: string
    • value: string

    Returns void

Protected configureHighlightIdTagSymbol

  • configureHighlightIdTagSymbol(highlightColor: Color, fontSize: string): void

  • Parameters

    • highlightColor: Color
    • fontSize: string

    Returns void

Protected configureHighlightSymbol

  • configureHighlightSymbol(highlightColor: Color, highlightOutlineSymbol: SimpleLineSymbol, fontSize: string): void

  • Parameters

    • highlightColor: Color
    • highlightOutlineSymbol: SimpleLineSymbol
    • fontSize: string

    Returns void

Protected configureTextSymbol

  • configureTextSymbol(textLineIndex: number, lineText: string, textColor: Color, font: Font, angle: number, verticalOffset: number): void

  • Parameters

    • textLineIndex: number
    • lineText: string
    • textColor: Color
    • font: Font
    • angle: number
    • verticalOffset: number

    Returns void

exportState

getConfig

getHeight

  • getHeight(): number

  • Returns number

getMapPoint

  • getMapPoint(): Point

  • Returns Point

getTextFontFamily

  • getTextFontFamily(): string

  • Returns string

getTextFontSize

  • getTextFontSize(): string

  • Returns string

getTotalHeight

  • getTotalHeight(): number

  • Returns number

getTotalWidth

  • getTotalWidth(): number

  • Returns number

getWidth

  • getWidth(): number

  • Returns number

hide

Protected initializeHighlightDimensions

  • initializeHighlightDimensions(): void

  • Returns void

Protected initializeHighlightGraphic

  • initializeHighlightGraphic(): void

  • Returns void

Protected initializeHighlighteIdTagGraphic

  • initializeHighlighteIdTagGraphic(): void

  • Returns void

Protected initializeTextGraphicsAndSymbols

  • initializeTextGraphicsAndSymbols(): void

  • Returns void

isVisible

  • isVisible(): boolean

  • Returns boolean

moveToTop

  • moveToTop(): void

  • Returns void

refresh

  • refresh(newLabelText: string): void

  • Parameters

    • newLabelText: string

    Returns void

removeFromLayer

  • removeFromLayer(destroy?: boolean): void

  • Parameters

    • Optional destroy: boolean

    Returns void

Protected setHighlightAnchor

  • setHighlightAnchor(): void

  • Returns void

setHighlightColor

  • setHighlightColor(color: Color): void

  • Parameters

    • color: Color

    Returns void

setMapPoint

  • setMapPoint(point: Point): void

  • Parameters

    • point: Point

    Returns void

Protected setTextAnchor

  • setTextAnchor(textLineIndex: number, verticalOffset: number): void

  • Parameters

    • textLineIndex: number
    • verticalOffset: number

    Returns void

setTextColor

  • setTextColor(color: Color): void

  • Parameters

    • color: Color

    Returns void

show

update

  • update(mapPoint: Point, text: string): void

  • Parameters

    • mapPoint: Point
    • text: string

    Returns void

updateIdTagText

  • updateIdTagText(newId: string): void

  • Parameters

    • newId: string

    Returns void

Static fromExportedState