Class HilightAPI

Exposes methods to manage the hilighting of features on the map

Hierarchy

FixtureInstance
- HilightAPI

Index

Constructors

constructor

new HilightAPI(id, iApi): HilightAPI
Creates an instance of FixtureInstance.
Parameters
- id: string
- iApi: InstanceAPI
Returns HilightAPI

Memberof
FixtureInstance
Inherited from FixtureInstance.constructor
- Defined in src/api/fixture.ts:294

Properties

`Readonly` $iApi

$iApi: InstanceAPI

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

Memberof

APIScope

hilightMode

hilightMode: BaseHilightMode = ...

`Readonly` id

id: string

ID of this fixture.

Memberof

FixtureInstance

Accessors

$element

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

config

get config(): any
Returns the fixture config section (JSON) taken from the global config.

Returns any

Memberof
FixtureInstance
Inherited from FixtureInstance.config
- Defined in src/api/fixture.ts:385

Methods

_parseConfig

_parseConfig(hilightConfig?): void
Parameters
- Optional hilightConfig: HilightConfig
Returns void
- Defined in src/fixtures/hilight/api/hilight.ts:25

addHilight

addHilight(graphics): Promise<void>
Add the given Graphics to the Hilighter
Parameters
- graphics: Graphic | Graphic[]
  
  Graphics to add
Returns Promise<void>
resolves when graphics have been added
- Defined in src/fixtures/hilight/api/hilight.ts:88

`Optional` added

added(): void
Returns void
Inherited from FixtureInstance.added
- Defined in src/api/fixture.ts:374

constructGraphicKey

constructGraphicKey(origin, uid, oid): string
Return a well-formed graphic key
Parameters
- origin: string
- uid: string
- oid: number
Returns string
- Defined in src/fixtures/hilight/api/hilight.ts:159

deconstructGraphicKey

deconstructGraphicKey(key): {
    oid: number;
    origin: string;
    uid: string;
}
Return a deconstructed graphic key.
Parameters
- key: string
  
  The graphic key to deconstruct
Returns {
    oid: number;
    origin: string;
    uid: string;
}
- oid: number
- origin: string
- uid: string
- Defined in src/fixtures/hilight/api/hilight.ts:168

extend

extend(vueComponent, options?): any
A helper function to create a "subclass" of the base Vue constructor
Parameters
- vueComponent: Record<string, any>
- Optional options: ComponentOptions<{}, any, any, any, any, any, any, any, any> = {}
Returns any

Memberof
FixtureInstance
Inherited from FixtureInstance.extend
- Defined in src/api/fixture.ts:320

getGraphicsByKey

getGraphicsByKey(origin?, uid?, oid?): Promise<Graphic[]>
Return all Graphics that match the given origin/uid/oid
Parameters
- Optional origin: string
  
  Graphic origin
- Optional uid: string
  
  Associated layer UID of the Graphic
- Optional oid: number
  
  Associated OID of the Graphic
Returns Promise<Graphic[]>
- Defined in src/fixtures/hilight/api/hilight.ts:126

getHilightLayer

getHilightLayer(): Promise<undefined | CommonGraphicLayer>
Return the hilightLayer

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

getLayerFixtureConfig

getLayerFixtureConfig(layerId): any
Get this fixture's config from the layer config with the given layer id Will return undefined if layer config did not specify a config for this fixture
Parameters
- layerId: string
  
  The layer's id
Returns any
This fixture's config for the given layer
Inherited from FixtureInstance.getLayerFixtureConfig
- Defined in src/api/fixture.ts:397

getLayerFixtureConfigs

getLayerFixtureConfigs(): {
[layerId: string]: any;
}
Combines this fixtures configs from layer configs into an indexed-dictionary

Returns {
[layerId: string]: any;
}
Dictionary where key is the layer id and the value is this fixture's config for that layer
- [layerId: string]: any
Inherited from FixtureInstance.getLayerFixtureConfigs
- Defined in src/api/fixture.ts:408

handlePanelTeleports

handlePanelTeleports(panels): void
If the panelTeleport property is provided, handle specified panelTeleport for the given fixture.
Parameters
- panels: string[]
  
  list of panel names for the calling fixture
Returns void
Inherited from FixtureInstance.handlePanelTeleports
- Defined in src/api/fixture.ts:482

handlePanelWidths

handlePanelWidths(panels): void
If the panelWidth property is provided, handle default and specified panel widths for the given fixture.
Parameters
- panels: string[]
  
  list of panel names for the calling fixture
Returns void
Inherited from FixtureInstance.handlePanelWidths
- Defined in src/api/fixture.ts:442

initHilightLayer

initHilightLayer(): Promise<void>
Initialize the Hilight layer.

Returns Promise<void>
resolves when layer is initialized
- Defined in src/fixtures/hilight/api/hilight.ts:71

initialized

initialized(): void
Returns void
Overrides FixtureInstance.initialized
- Defined in src/fixtures/hilight/api/hilight.ts:20

mount

mount(component, __namedParameters?): {
    destroy: (() => void);
    el: any;
    vNode: any;
}
Helper with programatically creating a component in Vue 3 (replaces the deprecated Vue.extend)
Parameters
- component: Component<any, any, any, ComputedOptions, MethodOptions>
- __namedParameters: any = {}
Returns {
    destroy: (() => void);
    el: any;
    vNode: any;
}
- destroy: (() => void)
  - - (): void
    - Returns void
- el: any
- vNode: any
Memberof
FixtureInstance
Inherited from FixtureInstance.mount
- Defined in src/api/fixture.ts:352

reloadHilight

reloadHilight(graphics): Promise<void>
Reload the provided graphics that are currently highlighted.
Parameters
- graphics: Graphic | Graphic[]
Returns Promise<void>
- Defined in src/fixtures/hilight/api/hilight.ts:114

remove

remove(): HilightAPI
Removes the specified fixture from R4MP instance. This is a proxy to rInstance.fixture.remove(...).

Returns HilightAPI

Memberof
FixtureInstance
Inherited from FixtureInstance.remove
- Defined in src/api/fixture.ts:307

removeHilight

removeHilight(graphics?): Promise<void>
Remove the given Graphics from the Hilighter. If no graphics are provided, all highlighted items will be removed.
Parameters
- Optional graphics: Graphic | Graphic[]
  
  Graphics to remove
Returns Promise<void>
resolves when graphics have been removed
- Defined in src/fixtures/hilight/api/hilight.ts:100

`Optional` removed

removed(): void
Returns void
Inherited from FixtureInstance.removed
- Defined in src/api/fixture.ts:375

`Static` updateBaseToInstance

updateBaseToInstance(value, id, $iApi): FixtureInstance
Adds missing functions and properties to the object implementing FixtureBase interface. This is only needed for external fixtures as they can't inherit from FixtureInstance.

TODO: If you know a better way to deep-mixin props/getters/functions from a class into another class instance, please tell me. I honestly don't know 🤷‍♂️.
Parameters
- value: FixtureBase
- id: string
- $iApi: InstanceAPI
Returns FixtureInstance

Static

Memberof
FixtureInstance
Inherited from FixtureInstance.updateBaseToInstance
- Defined in src/api/fixture.ts:251

Class HilightAPI

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

iApi: InstanceAPI

Returns HilightAPI

Memberof

Properties

Readonly $iApi

Memberof

hilightMode

Readonly id

Memberof

Accessors

$element

Returns App<Element>

$vApp

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

Memberof

config

Returns any

Memberof

Methods

_parseConfig

Parameters

Optional hilightConfig: HilightConfig

Returns void

addHilight

Parameters

graphics: Graphic | Graphic[]

Returns Promise<void>

Optional added

Returns void

constructGraphicKey

Parameters

origin: string

uid: string

oid: number

Returns string

deconstructGraphicKey

Parameters

key: string

Returns { oid: number; origin: string; uid: string; }

oid: number

origin: string

uid: string

extend

Parameters

vueComponent: Record<string, any>

Optional options: ComponentOptions<{}, any, any, any, any, any, any, any, any> = {}

Returns any

Memberof

getGraphicsByKey

Parameters

Optional origin: string

Optional uid: string

Optional oid: number

Returns Promise<Graphic[]>

getHilightLayer

Returns Promise<undefined | CommonGraphicLayer>

getLayerFixtureConfig

Parameters

layerId: string

Returns any

getLayerFixtureConfigs

Returns { [layerId: string]: any; }

[layerId: string]: any

handlePanelTeleports

Parameters

panels: string[]

Returns void

handlePanelWidths

Parameters

`Readonly` $iApi

`Readonly` id

`Optional` hilightConfig: HilightConfig

`Optional` added

Returns {
oid: number;
origin: string;
uid: string;
}

`Optional` options: ComponentOptions<{}, any, any, any, any, any, any, any, any> = {}

`Optional` origin: string

`Optional` uid: string

`Optional` oid: number

Returns {
[layerId: string]: any;
}

Returns {
destroy: (() => void);
el: any;
vNode: any;
}

`Optional` graphics: Graphic | Graphic[]

`Optional` removed

`Static` updateBaseToInstance