Class AreasOfInterestAPI

Readonly$iApi

Readonlyid

persist

$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

Optionaladded

• added?(): void

  [Optional] Called synchronously when the fixture is added to R4MP.

  Returns void

  Memberof

  Fixture

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

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

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

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

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

Optionalinitialized

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

remove

• remove(): this

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

  Returns this

  Memberof

  FixtureInstance

Optionalremoved

• removed?(): void

  [Optional] Called synchronously when the fixture is removed from R4MP.

  Returns void

  Memberof

  Fixture

StaticupdateBaseToInstance

• 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