Class BaseHilightMode

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

Hierarchy (View Summary)

APIScope
- BaseHilightMode
  - LiftHilightMode

Index

Constructors

Properties

$iApi config mode

Accessors

Methods

add getHilightLayer reloadHilight remove

Constructors

constructor

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

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:32

$vApp

get $vApp(): ComponentPublicInstance
The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

Returns ComponentPublicInstance
Memberof
APIScope
Inherited from APIScope.$vApp
- Defined in src/api/common.ts:28

Methods

add

add(graphics: Graphic | Graphic[]): 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:26

getHilightLayer

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

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

reloadHilight

reloadHilight(graphics: Graphic | Graphic[]): 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:46

remove

remove(graphics: Graphic | Graphic[] | undefined): Promise<void>
Removes the given graphics from the hilighter. No parmeter removes all graphics.
Parameters
- graphics: Graphic | Graphic[] | undefined
  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:36