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

FixtureInstance

Implements

Hierarchy (view full)

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

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

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

Methods

_parseConfig

_parseConfig(config?): void
Read the details section of the layers' fixture config
Parameters
- Optionalconfig: DetailsConfig
Returns void
Memberof
DetailsAPI
- Defined in src/fixtures/details/api/details.ts:133

_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:208

`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

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

getHilightGraphics

getHilightGraphics(items, layerUid): Promise<Graphic[]>
Return the graphics of the given IdentifyItems once the items have loaded.
Parameters
- items: IdentifyItem[]
  identify items to hilight. Items should be of ESRI format
- layerUid: string
  uid of layer the items belong to
Returns Promise<Graphic[]>
resolves with array of graphics
- Defined in src/fixtures/details/api/details.ts:302

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

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

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

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

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

`Optional`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
Inherited from FixtureInstance.initialized
- Defined in src/api/fixture.ts:406

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

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
- Optionalitems: IdentifyItem | IdentifyItem[]
  The identify items to highlight. Only required if turning on
- OptionallayerUid: string
  the layer UID that owns the items. Only required if turning on
Returns void
- Defined in src/fixtures/details/api/details.ts:334

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

reloadDetailsHilight

reloadDetailsHilight(items, layerUid): Promise<void>
Reload map elements of the hilighter for a set of identify items.
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:273

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

removeDetailsHilight

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

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

`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

toggleFeature

toggleFeature(featureData, open): void
Provided with the data for a single feature, shows or hides details panel. If panel is closed or incoming data is different than current content, panel is shown. If panel open and incoming data is what is currently shown, panel closes. The open parameter can override the behavior. featureData payload (can be empty if forcing closed)
- uid : uid string of the layer hosting the feature
- format : structure of the data. IdentifyResultFormat value.
- data : source information for the feature. Analogous to the data property of an IdentifyItem
- layerId : optional layerId string of the layer hosting the feature. Will be looked up if not provided
Parameters
- featureData: {
      data: any;
      format: IdentifyResultFormat;
      layerId?: string;
      uid: string;
  }
  - data: any
  - format: IdentifyResultFormat
  - OptionallayerId?: string
  - uid: string
- open: undefined | boolean
  can force the panel to open (true) or close (false) regardless of current panel state
Returns void
Memberof
DetailsAPI
- Defined in src/fixtures/details/api/details.ts:66

`Static`updateBaseToInstance

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

Class DetailsAPI

Export

Implements

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DetailsAPI

Memberof

Properties

Readonly$iApi

Memberof

Readonlyid

Memberof

persist

Memberof

Accessors

$element

Returns App<Element>

$vApp

Returns ComponentPublicInstance

Memberof

config

Returns undefined | DetailsConfig

Memberof

Methods

_parseConfig

Parameters

Returns void

Memberof

_validateItems

Returns void

Memberof

Optionaladded

Returns void

Memberof

extend

Parameters

Returns any

Memberof

getHilightGraphics

Parameters

Returns Promise<Graphic[]>

getLayerFixtureConfig

Parameters

Returns any

getLayerFixtureConfigs

Returns { [layerId: string]: any; }

[layerId: string]: any

handlePanelTeleports

Parameters

Returns void

handlePanelWidths

Parameters

Returns void

hasHilighter

Returns boolean

hilightDetailsItems

Parameters

Returns Promise<void>

Optionalinitialized

Returns void

Memberof

mount

Parameters

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

destroy: (() => void)

Returns void

el: any

vNode: any

Memberof

onHilightToggle

Parameters

Returns void

openDetails

`Readonly`$iApi

`Readonly`id

`Optional`added

Returns {
[layerId: string]: any;
}

`Optional`initialized

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

`Optional`removed

`Optional`layerId?: string

`Static`updateBaseToInstance