Class LegendAPI

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
- LegendAPI

Constructors

constructor

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

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

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

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 | LegendConfig
Returns LegendConfig section of the global config file.

Returns undefined | LegendConfig

Memberof
LegendAPI
Overrides FixtureInstance.config
- Defined in src/fixtures/legend/api/legend.ts:158

Methods

`Private` _deleteItem

_deleteItem(item): boolean
Deletes the given legend item from the legend store
Parameters
- item: LegendItem
  
  the legend item to be deleted
Returns boolean
returns true if item was removed, false otherwise
- Defined in src/fixtures/legend/api/legend.ts:614

`Private` _insertItem

_insertItem(item, parent?): void
Add the given legend item to the legend store
Parameters
- item: LegendItem
  
  the legend item to be added
- Optional parent: LegendItem
  
  the parent legend item for this item
Returns void
- Defined in src/fixtures/legend/api/legend.ts:604

_parseConfig

_parseConfig(legendConfig?): void
Parses the legend config JSON snippet from the config file and save resulting objects to the fixture store.
Parameters
- Optional legendConfig: LegendConfig
Returns void
- Defined in src/fixtures/legend/api/legend.ts:14

`Private` _replaceItem

_replaceItem(oldItem, newItem): void
Parameters
- oldItem: LegendItem
- newItem: LegendItem
Returns void
- Defined in src/fixtures/legend/api/legend.ts:640

`Private` _searchTree

_searchTree(root, predicate): undefined | LegendItem
Search for first legend item that satisfies the predicate, starting from the given root item.
Parameters
- root: LegendItem
  
  the root item to start searching from
- predicate: ((item) => boolean)
  
  boolean predicate to test each item
  - - (item): boolean
    - Parameters
      
      item: LegendItem
      
      Returns boolean
Returns undefined | LegendItem
return the first item that satisfies the given predicate. returns undefined if item is not found.
- Defined in src/fixtures/legend/api/legend.ts:524

`Private` _searchTreeAll

_searchTreeAll(root, predicate): LegendItem[]
Search for all legend items that satisfy the predicate, starting from the given root item.
Parameters
- root: LegendItem
  
  the root item to start searching from
- predicate: ((item) => boolean)
  
  predicate boolean predicate to test each item
  - - (item): boolean
    - Parameters
      
      item: LegendItem
      
      Returns boolean
Returns LegendItem[]
return the first item that satisfies the given predicate. returns undefined if item is not found.
- Defined in src/fixtures/legend/api/legend.ts:547

`Private` _toggleState

_toggleState(item, options): void
Toggles visibility for all items or expands/collapses all groups.
Parameters
- item: LegendItem
  
  current legend item that is being checked
- options: any
  
  specifies whether visibility or expand/collapse functionality is to be changed
Returns void
- Defined in src/fixtures/legend/api/legend.ts:574

`Private` _treeWalker

_treeWalker(layer, node, extraConfig?): any
Parameters
- layer: LayerInstance
- node: TreeNode
- Optional extraConfig: object
Returns any
- Defined in src/fixtures/legend/api/legend.ts:645

addItem

addItem(item, parent?): LegendItem
Add a legend item given the legend config, or legend item instance
Parameters
- item: any
  
  the config for the legend item or a legend item instance
- Optional parent: LegendItem
  
  optional parent item to create this item under
Returns LegendItem
the added legend item

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:107

addLayerItem

addLayerItem(layer, parent?): Promise<LayerItem>
Add a layer legend item given a layer instance
Parameters
- layer: LayerInstance
  
  the layer to create an item for
- Optional parent: LegendItem
  
  optional parent item to create this item under
Returns Promise<LayerItem>
a promise that resolves with the added layer item

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:123

`Optional` added

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

createItem

createItem(itemConf, parent?): LegendItem
Construct a legend item given the legend config
Parameters
- itemConf: any
  
  legend item config
- Optional parent: LegendItem
  
  the parent legend item for the created item
Returns LegendItem
returns the constructed legend item

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:58

expandItems

expandItems(expanded, root?): void
Set the expanded state of legend items to expanded
Parameters
- expanded: boolean
  
  the expanded state the items will be set to
- Optional root: LegendItem
  
  the root item to start updating the expanded state from
Returns void

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:425

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

getAllExpanded

getAllExpanded(expanded?): LegendItem[]
Get all legend items with the given expanded state. Not specifying the expanded state will return all items with expanded set to true
Parameters
- Optional expanded: boolean
  
  the expanded state to check for
Returns LegendItem[]
the items with the given expanded state

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:262

getAllVisible

getAllVisible(visibility?): LegendItem[]
Get all legend items with the given visibility state. Not specifying the visibility state will return all items with visibility set to true
Parameters
- Optional visibility: boolean
  
  the visibility state to check for
Returns LegendItem[]
the items with the given expanded state

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:288

getItem

getItem(uid): undefined | LegendItem
Get a legend item given its uid.
Parameters
- uid: string
  
  the uid of the legend item
Returns undefined | LegendItem
return legend item with given uid. returns undefined if item is not found.

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:200

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

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

getLayerItem

getLayerItem(layer): undefined | LayerItem
Get a layer item connected to the layer with the given id/uid or the given layer instance.
Parameters
- layer: string | LayerInstance
  
  the id/uid of the layer or layer instance
Returns undefined | LayerItem
return layer item tied to the found layer. returns undefined if no such item is found.

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:222

getLegend

getLegend(): LegendItem[]
Returns the full legend tree. Note: This returns a direct reference to the legend tree. Mutations will persist.

Returns LegendItem[]
returns the full legend tree

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:169

getLegendConfig

getLegendConfig(): any
Maps the current legend tree into a legend config snippet.

In addition to legend config schema properties, this snippet will also include properties such as the item type, item's uid, layer uid etc.

Returns any
returns the legend config

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:185

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

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

`Optional` initialized

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

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

reloadLayerItem

reloadLayerItem(layerId): boolean
Reload the legend item connected to the layer with the given layer id/uid
Parameters
- layerId: string
  
  the id or uid of the reloaded layer
Returns boolean
returns true if item was successfully reloaded, false otherwise

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:461

remove

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

Returns LegendAPI

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

removeItem

removeItem(item): boolean
Removes the legend item with the given uid, or the item instance.
Parameters
- item: string | LegendItem
  
  the uid of item or legend item instance to be removed
Returns boolean
returns true if item was removed, false otherwise

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:487

removeLayerItem

removeLayerItem(layer): boolean
Remove the layer item connected to the layer with the given id/uid or the given layer instance.
Parameters
- layer: string | LayerInstance
  
  the id/uid of the layer or layer instance
Returns boolean
returns true if item was removed, false otherwise

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:505

`Optional` removed

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

showItems

showItems(visibility, root?): void
Set the visibility state of legend items to visibility
Parameters
- visibility: boolean
  
  the visibility state the items will be set to
- Optional root: LegendItem
  
  the root item to start updating the visibility state from
Returns void

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:443

updateLegend

updateLegend(layer): void
Update an existing layer item with data from the given layer Does nothing if the layer item is not found
Parameters
- layer: LayerInstance
  
  the layer to update the layer item with
Returns void

Memberof
LegendAPI
- Defined in src/fixtures/legend/api/legend.ts:313

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

Class LegendAPI

Export

Implements

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

iApi: InstanceAPI

Returns LegendAPI

Memberof

Properties

Readonly $iApi

Memberof

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 | LegendConfig

Memberof

Methods

Private _deleteItem

Parameters

item: LegendItem

Returns boolean

Private _insertItem

Parameters

item: LegendItem

Optional parent: LegendItem

Returns void

_parseConfig

Parameters

Optional legendConfig: LegendConfig

Returns void

Private _replaceItem

Parameters

oldItem: LegendItem

newItem: LegendItem

Returns void

Private _searchTree

Parameters

root: LegendItem

predicate: ((item) => boolean)

Parameters

item: LegendItem

Returns boolean

Returns undefined | LegendItem

Private _searchTreeAll

Parameters

root: LegendItem

predicate: ((item) => boolean)

Parameters

item: LegendItem

Returns boolean

Returns LegendItem[]

Private _toggleState

Parameters

item: LegendItem

options: any

Returns void

Private _treeWalker

Parameters

layer: LayerInstance

node: TreeNode

Optional extraConfig: object

Returns any

addItem

Parameters

item: any

Optional parent: LegendItem

`Readonly` $iApi

`Readonly` id

`Private` _deleteItem

`Private` _insertItem

`Optional` parent: LegendItem

`Optional` legendConfig: LegendConfig

`Private` _replaceItem

`Private` _searchTree

`Private` _searchTreeAll

`Private` _toggleState

`Private` _treeWalker

`Optional` extraConfig: object

`Optional` parent: LegendItem

`Optional` parent: LegendItem

`Optional` added

`Optional` parent: LegendItem

`Optional` root: LegendItem

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

`Optional` expanded: boolean

`Optional` visibility: boolean

Returns {
[layerId: string]: any;
}

`Optional` initialized