Interface Highlight

Represents a highlight on a map. Instances of this type can only be obtained through a Highlighter.

interface Highlight {
    active(): boolean;
    getGraphics(): undefined | Graphic[];
    remove(): void;
}

Methods

active getGraphics remove

Methods

active

  • active(): boolean

  • Returns true if the highlight is still being displayed (i.e. it has not been removed yet).

    Returns boolean

getGraphics

  • getGraphics(): undefined | Graphic[]

  • Gets the graphic instances that are currently being displayed for this highlight. NOTE: This may return undefined also if active is true. This can happen if the highlight is rendered asynchronously. Currently there is no way to wait for the graphics. You need to poll this method until it returns a value.

    Returns undefined | Graphic[]

remove

  • remove(): void

  • Removes the highlight.

    Does nothing if the highlight is no longer active.

    Returns void

Settings

Member Visibility

On This Page

Methods