Class HilightAPI

Exposes methods to manage the hilighting of features on the map

Hierarchy (view full)

Constructors

constructor

Properties

$iApi hilightMode id persist

Accessors

$element $vApp config

Methods

_parseConfig addHilight added? constructGraphicKey deconstructGraphicKey extend getGraphicsByKey getHilightLayer getLayerFixtureConfig getLayerFixtureConfigs handlePanelTeleports handlePanelWidths initHilightLayer initialized mount reloadHilight remove removeHilight removed? updateBaseToInstance

Constructors

constructor

Properties

Readonly$iApi

$iApi: InstanceAPI

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

Memberof

APIScope

hilightMode

hilightMode: BaseHilightMode = ...

Readonlyid

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>

$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

config

  • get config(): any

  • Returns the fixture config section (JSON) taken from the global config.

    Returns any

    Memberof

    FixtureInstance

Methods

_parseConfig

addHilight

Optionaladded

constructGraphicKey

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

extend

  • extend(vueComponent, options?): any

  • A helper function to create a "subclass" of the base Vue constructor

    Parameters

    • vueComponent: Record<string, any>
    • Optionaloptions: ComponentOptions = {}

    Returns any

    Memberof

    FixtureInstance

getGraphicsByKey

  • getGraphicsByKey(origin?, uid?, oid?): 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[]>

getHilightLayer

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

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

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

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

initHilightLayer

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

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
    • __namedParameters: any = {}

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

    • destroy: (() => void)
        • (): void

        • Returns void

    • el: any
    • vNode: any

    Memberof

    FixtureInstance

reloadHilight

remove

  • remove(): this

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

    Returns this

    Memberof

    FixtureInstance

removeHilight

  • removeHilight(graphics?): Promise<void>

  • Remove the given Graphics from the Hilighter. If no graphics are provided, all highlighted items will be removed.

    Parameters

    Returns Promise<void>

    resolves when graphics have been removed

Optionalremoved

StaticupdateBaseToInstance

  • updateBaseToInstance(rawFixture, 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

    Returns FixtureInstance

    Static

    Memberof

    FixtureInstance

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods