Class BaseHilightMode

Base mode for hilighter modes. On its own, this mode will not hilight anything.

Hierarchy

APIScope
- BaseHilightMode
  - LiftHilightMode

Index

Constructors

Properties

$iApi config mode

Accessors

Methods

add getHilightLayer layerFetcher notImplementedError reloadHilight remove

Constructors

constructor

new BaseHilightMode(config, iApi): BaseHilightMode
Parameters
- config: any
- iApi: InstanceAPI
Returns BaseHilightMode
Overrides APIScope.constructor
- Defined in src/fixtures/hilight/api/hilight-mode/base-hilight-mode.ts:19

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>
Inherited from APIScope.$element
- Defined in src/api/common.ts:31

$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
Inherited from APIScope.$vApp
- Defined in src/api/common.ts:27

Methods

add

add(graphics): Promise<void>
Adds the given graphics to the hilighter.
Parameters
- graphics: Graphic | Graphic[]
  
  one or more RAMP Graphics to hilight
Returns Promise<void>
resolves when graphics have been added
- Defined in src/fixtures/hilight/api/hilight-mode/base-hilight-mode.ts:31

getHilightLayer

getHilightLayer(): Promise<undefined | CommonGraphicLayer>
Returns the Hilight layer, if it exists.

Returns Promise<undefined | CommonGraphicLayer>
- Defined in src/fixtures/hilight/api/hilight-mode/base-hilight-mode.ts:62

`Private` layerFetcher

layerFetcher(): Promise<undefined | LayerInstance>
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.
- Defined in src/fixtures/hilight/api/hilight-mode/base-hilight-mode.ts:92

`Private` notImplementedError

notImplementedError(method): void
Parameters
- method: string
Returns void
- Defined in src/fixtures/hilight/api/hilight-mode/base-hilight-mode.ts:80

reloadHilight

reloadHilight(graphics): Promise<void>
Reload the provided graphics that are currently highlighted.
Parameters
- graphics: Graphic | Graphic[]
  
  one or more RAMP Graphics to reload
Returns Promise<void>
resolves when graphics have been reloaded
- Defined in src/fixtures/hilight/api/hilight-mode/base-hilight-mode.ts:53

remove

remove(graphics): Promise<void>
Removes the given graphics from the hilighter. No parmeter removes all graphics.
Parameters
- graphics: undefined | Graphic | Graphic[]
  
  one or more RAMP Graphics to remove
Returns Promise<void>
resolves when graphics have been added
- Defined in src/fixtures/hilight/api/hilight-mode/base-hilight-mode.ts:41

Generated using TypeDoc