Class HilightAPI

Exposes methods to manage the hilighting of features on the map

Hierarchy (View Summary)

FixtureInstance
- HilightAPI

Constructors

constructor

new HilightAPI(id: string, iApi: InstanceAPI): 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:320

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

persist

persist: boolean

Indicates whether to keep the fixture when the language changes. Defaults to true. If only one config is provided for all languages, the fixture will be kept on language change, regardless of the value of the flag.

Memberof

Fixture

Accessors

$element

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

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

hilightLayerName

get hilightLayerName(): string
Return the hilight Layer name

Returns string
- Defined in src/fixtures/hilight/api/hilight.ts:173

Methods

_parseConfig

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

`Optional`added

added?(): void
[Optional] Called synchronously when the fixture is added to R4MP.

Returns void
Memberof
Fixture
Inherited from FixtureInstance.added
- Defined in src/api/fixture.ts:404

addHilight

addHilight(graphics: Graphic | Graphic[]): 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:70

constructGraphicKey

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

deconstructGraphicKey

deconstructGraphicKey(
key: string,
silent?: boolean,
): { oid: number; origin: string; uid: string }
Return a deconstructed graphic key.
Parameters
- key: string
  The graphic key to deconstruct
- Optionalsilent: boolean = false
  Flag to stop console warns for bad keys (e.g. using this method as a test)
Returns { oid: number; origin: string; uid: string }
- Defined in src/fixtures/hilight/api/hilight.ts:143

extend

extend(vueComponent: Record<string, any>, options?: ComponentOptions): any
A helper function to create a "subclass" of the base Vue constructor
Parameters
- vueComponent: Record<string, any>
- Optionaloptions: ComponentOptions = {}
Returns any
Memberof
FixtureInstance
Inherited from FixtureInstance.extend
- Defined in src/api/fixture.ts:347

getGraphicsByKey

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

getHilightLayer

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

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

getLayerFixtureConfig

getLayerFixtureConfig(layerId: string): 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:427

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
Inherited from FixtureInstance.getLayerFixtureConfigs
- Defined in src/api/fixture.ts:437

handlePanelTeleports

handlePanelTeleports(panels: string[]): 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:506

handlePanelWidths

handlePanelWidths(panels: string[]): 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:467

initHilightLayer

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

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

initialized

initialized(): void
[Optional] Called after the core map logic has executed. If the fixture is added after the map initialization, this is called immediately.

At this point, any custom content (panels, on-map components, etc.) can be added to R4MP. Custom content can also be added throughout the life of the [module].

Returns void
Memberof
Fixture
Overrides FixtureInstance.initialized
- Defined in src/fixtures/hilight/api/hilight.ts:16

mount

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

reloadHilight

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

remove

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

Returns this
Memberof
FixtureInstance
Inherited from FixtureInstance.remove
- Defined in src/api/fixture.ts:334

`Optional`removed

removed?(): void
[Optional] Called synchronously when the fixture is removed from R4MP.

Returns void
Memberof
Fixture
Inherited from FixtureInstance.removed
- Defined in src/api/fixture.ts:405

removeHilight

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

`Static`updateBaseToInstance

updateBaseToInstance(
    rawFixture: FixtureBase,
    id: string,
    $iApi: InstanceAPI,
): 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
- rawFixture: FixtureBase
- id: string
- $iApi: InstanceAPI
Returns FixtureInstance
Static
Memberof
FixtureInstance
Inherited from FixtureInstance.updateBaseToInstance
- Defined in src/api/fixture.ts:278

Class HilightAPI

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns HilightAPI

Memberof

Properties

Readonly$iApi

Memberof

hilightMode

Readonlyid

Memberof

persist

Memberof

Accessors

$element

Returns App<Element>

$vApp

Returns ComponentPublicInstance

Memberof

config

Returns any

Memberof

hilightLayerName

Returns string

Methods

_parseConfig

Parameters

Returns void

Optionaladded

Returns void

Memberof

addHilight

Parameters

Returns Promise<void>

constructGraphicKey

Parameters

Returns string

deconstructGraphicKey

Parameters

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

extend

Parameters

Returns any

Memberof

getGraphicsByKey

Parameters

Returns Promise<Graphic[]>

getHilightLayer

Returns Promise<CommonGraphicLayer | undefined>

getLayerFixtureConfig

Parameters

Returns any

getLayerFixtureConfigs

Returns { [layerId: string]: any }

handlePanelTeleports

Parameters

Returns void

handlePanelWidths

Parameters

Returns void

initHilightLayer

Returns Promise<void>

initialized

Returns void

Memberof

mount

Parameters

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

Memberof

reloadHilight

Parameters

Returns Promise<void>

remove

`Readonly`$iApi

`Readonly`id

`Optional`added

`Optional`removed

`Static`updateBaseToInstance