Class PinDropAPI

Exposes methods to manage a pin drop on the map

Hierarchy (View Summary)

FixtureInstance
- PinDropAPI

Constructors

constructor

new PinDropAPI(id: string, iApi: InstanceAPI): PinDropAPI
Creates an instance of FixtureInstance.
Parameters
- id: string
- iApi: InstanceAPI
Returns PinDropAPI
Memberof
FixtureInstance
Inherited from FixtureInstance.constructor
- Defined in src/api/fixture.ts:329

Properties

`Readonly`$iApi

$iApi: InstanceAPI

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

Memberof

APIScope

`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

active

get active(): boolean
Toggleable flag to enable/disable the pin drop.

Returns boolean
- Defined in src/fixtures/pindrop/api/pindrop.ts:76
set active(newValue: boolean): void
Parameters
- newValue: boolean
Returns void
- Defined in src/fixtures/pindrop/api/pindrop.ts:80

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

linkDetails

get linkDetails(): boolean
Makes the pin show and hide when the details panel is active.

Returns boolean
- Defined in src/fixtures/pindrop/api/pindrop.ts:125
set linkDetails(newValue: boolean): void
Parameters
- newValue: boolean
Returns void
- Defined in src/fixtures/pindrop/api/pindrop.ts:129

linkIdentify

get linkIdentify(): boolean
Makes the pin automatically drop when a map identify occurs

Returns boolean
- Defined in src/fixtures/pindrop/api/pindrop.ts:94
set linkIdentify(newValue: boolean): void
Parameters
- newValue: boolean
Returns void
- Defined in src/fixtures/pindrop/api/pindrop.ts:98

pindropLayerName

get pindropLayerName(): string
Return the Pindrop Layer name

Returns string
- Defined in src/fixtures/pindrop/api/pindrop.ts:283

pinSymbol

get pinSymbol(): PointStyleOptions
How to symbolize the pin point

Returns PointStyleOptions
- Defined in src/fixtures/pindrop/api/pindrop.ts:65
set pinSymbol(newSymbol: PointStyleOptions): void
Parameters
- newSymbol: PointStyleOptions
Returns void
- Defined in src/fixtures/pindrop/api/pindrop.ts:69

Methods

_parseConfig

_parseConfig(pindropConfig?: PinDropConfig): void
Parameters
- OptionalpindropConfig: PinDropConfig
Returns void
- Defined in src/fixtures/pindrop/api/pindrop.ts:198

`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:413

cleanup

cleanup(): void
Cleans up fixture when its done.

Returns void
- Defined in src/fixtures/pindrop/api/pindrop.ts:189

dropPin

dropPin(dropPoint: Point): void
Place a pin at the given point on the map
Parameters
- dropPoint: Point
  map location for the new pin
Returns void
- Defined in src/fixtures/pindrop/api/pindrop.ts:239

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

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

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

getPindropLayer

getPindropLayer(): CommonGraphicLayer | undefined
Return the Pindrop Layer

Returns CommonGraphicLayer | undefined
- Defined in src/fixtures/pindrop/api/pindrop.ts:273

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

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

hidePin

hidePin(): void
Hide the pin but retain the position for a future restorePin() call

Returns void
- Defined in src/fixtures/pindrop/api/pindrop.ts:257

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/pindrop/api/pindrop.ts:179

initPinLayer

initPinLayer(): Promise<void>
Initialize the pin layer.

Returns Promise<void>
resolves when layer is added to the map
- Defined in src/fixtures/pindrop/api/pindrop.ts:221

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

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

`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:414

removePin

removePin(): void
Remove the pin from the map for good.

Returns void
- Defined in src/fixtures/pindrop/api/pindrop.ts:249

restorePin

restorePin(): void
If a pin was hidden, show it again.

Returns void
- Defined in src/fixtures/pindrop/api/pindrop.ts:264

`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 that do not 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:287

Class PinDropAPI

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PinDropAPI

Memberof

Properties

Readonly$iApi

Memberof

Readonlyid

Memberof

persist

Memberof

Accessors

$element

Returns App<Element>

$vApp

Returns ComponentPublicInstance

Memberof

active

Returns boolean

Parameters

Returns void

config

Returns any

Memberof

linkDetails

Returns boolean

Parameters

Returns void

linkIdentify

Returns boolean

Parameters

Returns void

pindropLayerName

Returns string

pinSymbol

Returns PointStyleOptions

Parameters

Returns void

Methods

_parseConfig

Parameters

Returns void

Optionaladded

Returns void

Memberof

cleanup

Returns void

dropPin

Parameters

Returns void

extend

Parameters

Returns any

Memberof

getLayerFixtureConfig

Parameters

Returns any

getLayerFixtureConfigs

Returns { [layerId: string]: any }

getPindropLayer

Returns CommonGraphicLayer | undefined

handlePanelTeleports

Parameters

Returns void

handlePanelWidths

Parameters

Returns void

hidePin

Returns void

initialized

Returns void

Memberof

`Readonly`$iApi

`Readonly`id

`Optional`added

`Optional`removed

`Static`updateBaseToInstance