Class BaseHilightMode

A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.

Export

Hierarchy

Constructors

constructor

Properties

$iApi config mode

Accessors

$element $vApp

Methods

add getHilightLayer layerFetcher notImplementedError reloadHilight remove

Constructors

constructor

Properties

Readonly $iApi

$iApi: InstanceAPI

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

config

config: any = {}

mode

mode: HilightMode = HilightMode.NONE

Accessors

$element

  • get $element(): App<Element>

  • Returns App<Element>

$vApp

  • get $vApp(): ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

  • The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

    Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

    Memberof

    APIScope

Methods

add

getHilightLayer

Private layerFetcher

  • Provides a short grace period to avoid scenarios where the layer is still getting created. Not overly long, as the highlight layer is a local graphics layer so no server lag involved.

    Returns Promise<undefined | LayerInstance>

    Promise resolving in the LayerInstace, or undefined if we could not locate the layer.

Private notImplementedError

reloadHilight

remove

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc