Class FogHilightMode

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

Export

Hierarchy

LiftHilightMode
- FogHilightMode

Index

Constructors

Properties

$iApi config handlers lastAdd mode offOpacity onOpacity

Accessors

Methods

add getFogLayer getHilightLayer hilightSetup reloadHilight remove reorderFogLayer updateFogLayer

Constructors

constructor

new FogHilightMode(config, iApi): FogHilightMode
Parameters
- config: any
- iApi: InstanceAPI
Returns FogHilightMode
Overrides LiftHilightMode.constructor
- Defined in src/fixtures/hilight/api/hilight-mode/fog-hilight-mode.ts:16

Properties

`Readonly` $iApi

$iApi: InstanceAPI

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

Memberof

APIScope

config

config: any = {}

handlers

handlers: string[] = []

`Private` lastAdd

lastAdd: number = 0

mode

mode: HilightMode = HilightMode.NONE

offOpacity

offOpacity: number

onOpacity

onOpacity: number

Accessors

$element

get $element(): App<Element>
Returns App<Element>
Inherited from LiftHilightMode.$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 LiftHilightMode.$vApp
- Defined in src/api/common.ts:27

Methods

add

add(graphics): Promise<void>
Adds the given graphics to the hilight layer.
Parameters
- graphics: Graphic[]
Returns Promise<void>
Overrides LiftHilightMode.add
- Defined in src/fixtures/hilight/api/hilight-mode/fog-hilight-mode.ts:98

`Private` getFogLayer

getFogLayer(): undefined | TileLayer
Returns the Hilight layer.

Returns undefined | TileLayer
- Defined in src/fixtures/hilight/api/hilight-mode/fog-hilight-mode.ts:153

getHilightLayer

getHilightLayer(): Promise<undefined | CommonGraphicLayer>
Returns the Hilight layer.

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

`Private` hilightSetup

hilightSetup(): Promise<void>
Returns Promise<void>
- Defined in src/fixtures/hilight/api/hilight-mode/fog-hilight-mode.ts:47

reloadHilight

reloadHilight(graphics): Promise<void>
Reload the hilighter's map elements.
Parameters
- graphics: Graphic[]
Returns Promise<void>
Overrides LiftHilightMode.reloadHilight
- Defined in src/fixtures/hilight/api/hilight-mode/fog-hilight-mode.ts:145

remove

remove(graphics?): Promise<void>
Removes the given graphics from the hilight layer.
Parameters
- Optional graphics: Graphic[]
Returns Promise<void>
Overrides LiftHilightMode.remove
- Defined in src/fixtures/hilight/api/hilight-mode/fog-hilight-mode.ts:115

`Private` reorderFogLayer

reorderFogLayer(): Promise<void>
Returns Promise<void>
- Defined in src/fixtures/hilight/api/hilight-mode/fog-hilight-mode.ts:77

`Private` updateFogLayer

updateFogLayer(): Promise<void>
Returns Promise<void>
- Defined in src/fixtures/hilight/api/hilight-mode/fog-hilight-mode.ts:72

Generated using TypeDoc