Class DetailsAPI

A base class for Fixture subclasses. It provides some utility functions to Fixtures and also gives access to $iApi and $vApp globals.

Export

Implements

Hierarchy

FixtureInstance
- DetailsAPI

Constructors

constructor

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

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

Properties

`Readonly` $iApi

$iApi: InstanceAPI

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

Memberof

APIScope

`Private` detailsStore

detailsStore: Store<"details", _UnwrapAll<Pick<{}, "payload" | "properties" | "defaultTemplates" | "currentFeatureId" | "slowLoadingFlag" | "activeGreedy" | "lastHilight" | "hilightToggle">>, Pick<{}, never>, Pick<{}, "removeLayer" | "addConfigProperty">> = ...

`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(): undefined | DetailsConfig
Returns the fixture config section (JSON) taken from the global config.

Returns undefined | DetailsConfig

Memberof
FixtureInstance
Overrides FixtureInstance.config
- Defined in src/fixtures/details/api/details.ts:19

Methods

_loadDetailsConfig

_loadDetailsConfig(layer): void
Parameters
- layer: undefined | LayerInstance
Returns void
- Defined in src/fixtures/details/api/details.ts:165

_parseConfig

_parseConfig(config?): void
Read the details section of the layers' fixture config
Parameters
- Optional config: DetailsConfig
Returns void

Memberof
DetailsAPI
- Defined in src/fixtures/details/api/details.ts:126

_validateItems

_validateItems(): void
Check to see if the stored components are registered properly.

Returns void

Memberof
DetailsAPI
- Defined in src/fixtures/details/api/details.ts:192

`Optional` added

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

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

getHilightGraphics

getHilightGraphics(items, layerUid): Promise<Graphic[]>
Return the graphics of the given IdentifyItems.
Parameters
- items: IdentifyItem[]
  
  items to hilight
- layerUid: string
  
  uid of layer the items belong to
Returns Promise<Graphic[]>
- Defined in src/fixtures/details/api/details.ts:282

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

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

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

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

hasHilighter

hasHilighter(): boolean
Return whether or not a HilightMode has been defined (other than NONE)

Returns boolean
- Defined in src/fixtures/details/api/details.ts:340

hilightDetailsItems

hilightDetailsItems(items, layerUid): Promise<void>
Highlight identified items
Parameters
- items: IdentifyItem | IdentifyItem[]
  
  items to add
- layerUid: string
  
  uid of layer the items belong to
Returns Promise<void>
- Defined in src/fixtures/details/api/details.ts:206

`Optional` initialized

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

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

onHilightToggle

onHilightToggle(hilightOn, items, layerUid): void
Updates hilighted graphics when the hilight toggler is toggled.
Parameters
- hilightOn: boolean
  
  Whether the toggler has been turned on/off
- items: IdentifyItem | IdentifyItem[]
  
  The items that are affected by the toggle
- layerUid: string
  
  the layer UID
Returns void
- Defined in src/fixtures/details/api/details.ts:321

openDetails

openDetails(payload): void
Updates the identify result in the store, and then opens the details panel.
Parameters
- payload: IdentifyResult[]
Returns void

Memberof
DetailsAPI
- Defined in src/fixtures/details/api/details.ts:29

reloadDetailsHilight

reloadDetailsHilight(items, layerUid): Promise<void>
Reload map elements of the hilighter.
Parameters
- items: IdentifyItem | IdentifyItem[]
  
  items to reload
- layerUid: string
  
  uid of layer the items belong to
Returns Promise<void>
- Defined in src/fixtures/details/api/details.ts:261

remove

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

Returns DetailsAPI

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

removeDetailsHilight

removeDetailsHilight(): Promise<void>
Remove all details panel map hilights.

Returns Promise<void>
- Defined in src/fixtures/details/api/details.ts:245

`Optional` removed

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

toggleFeature

toggleFeature(featureData, open): void
Provided with the data for a single feature, toggles the details panel directly with the feature screen.
Parameters
- featureData: {
      data: any;
      format: string;
      uid: string;
  }
  - data: any
  - format: string
  - uid: string
- open: undefined | boolean
Returns void

Memberof
DetailsAPI
- Defined in src/fixtures/details/api/details.ts:58

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

Class DetailsAPI

Export

Implements

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

iApi: InstanceAPI

Returns DetailsAPI

Memberof

Properties

Readonly $iApi

Memberof

Private detailsStore

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 undefined | DetailsConfig

Memberof

Methods

_loadDetailsConfig

Parameters

layer: undefined | LayerInstance

Returns void

_parseConfig

Parameters

Optional config: DetailsConfig

Returns void

Memberof

_validateItems

Returns void

Memberof

Optional added

Returns void

extend

Parameters

vueComponent: Record<string, any>

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

Returns any

Memberof

getHilightGraphics

Parameters

items: IdentifyItem[]

layerUid: string

Returns Promise<Graphic[]>

getLayerFixtureConfig

Parameters

layerId: string

Returns any

getLayerFixtureConfigs

Returns { [layerId: string]: any; }

[layerId: string]: any

handlePanelTeleports

Parameters

panels: string[]

Returns void

handlePanelWidths

Parameters

panels: string[]

Returns void

hasHilighter

Returns boolean

hilightDetailsItems

Parameters

items: IdentifyItem | IdentifyItem[]

layerUid: string

Returns Promise<void>

Optional initialized

`Readonly` $iApi

`Private` detailsStore

`Readonly` id

`Optional` config: DetailsConfig

`Optional` added

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

Returns {
[layerId: string]: any;
}

`Optional` initialized

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

`Optional` removed

featureData: {
data: any;
format: string;
uid: string;
}

`Static` updateBaseToInstance