Class LiftHilightMode

Hilight mode that places graphics in a top-most layer, essentially "lifting" them above other map elements.

Hierarchy

BaseHilightMode
- LiftHilightMode
  - FogHilightMode
  - GlowHilightMode

Index

Constructors

Properties

$iApi config mode

Accessors

Methods

add getHilightLayer reloadHilight remove

Constructors

constructor

new LiftHilightMode(config, iApi): LiftHilightMode
Parameters
- config: any
- iApi: InstanceAPI
Returns LiftHilightMode
Inherited from BaseHilightMode.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 BaseHilightMode.$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 BaseHilightMode.$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
Overrides BaseHilightMode.add
- Defined in src/fixtures/hilight/api/hilight-mode/lift-hilight-mode.ts:9

getHilightLayer

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

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

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
Overrides BaseHilightMode.reloadHilight
- Defined in src/fixtures/hilight/api/hilight-mode/lift-hilight-mode.ts:25

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
Overrides BaseHilightMode.remove
- Defined in src/fixtures/hilight/api/hilight-mode/lift-hilight-mode.ts:17

Generated using TypeDoc