Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for the HighlightedLabelGraphic configuration settings.

Hierarchy

  • HighlightedLabelConfig

Index

Properties

Optional anchor

The position to anchor the label in.

Optional angle

angle: number

The angle at which to place the highlighted label.

Optional calloutPixelSize

calloutPixelSize: number

The size (in pixels) of the callout arrow (width) for the highlight label if in callout mode.

Optional calloutWithIdTag

calloutWithIdTag: boolean

A boolean indicating whether this highlighted label will be in the style of a rectangular box or a callout with a circular id tag on the left and with an arrow pointing at the mapPoint.

Optional cornerRadius

cornerRadius: number

The corner radius if the highlight label is required to have rounded corners.

Optional fontFamily

fontFamily: string

The font family to use in the highlighted label. Defaults to "Arial".

Optional fontSize

fontSize: string

The font size for the highlighted label text. Defaults to "12px".

Optional highlightColor

highlightColor: Color

The highlight color of the highlight label.

Optional highlightOutlineSymbol

highlightOutlineSymbol: SimpleLineSymbol

An outline symbol if needed for the highlighted label.

Optional idTagText

idTagText: string

The text that will appear in the id tag placeholder, if this highlight label is a calloutWithIdTag.

Optional labelXoffset

labelXoffset: number

The x-offset for the highlighted label if required.

Optional labelYoffset

labelYoffset: number

The y-offset for the highlighted label if required.

layerId

layerId: string

The id for the layer to which the highlighted label should be added.

mapPoint

mapPoint: Point

The map point associated with this highlighted label.

Optional text

text: string

The text for the highlighted label. May be separated by a "\n" to span across multiple lines.

Optional textColor

textColor: Color

The text color of the text on the highlight label.