Class DevAPI

Contains endpoints useful for dev debugging and such

Hierarchy (View Summary)

APIScope
- DevAPI

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

new DevAPI(iApi: InstanceAPI): DevAPI
Parameters
- iApi: InstanceAPI
Returns DevAPI
Overrides APIScope.constructor
- Defined in src/api/dev.ts:9

Properties

`Readonly`$iApi

$iApi: InstanceAPI

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

Memberof

APIScope

Accessors

$element

get $element(): App<Element>
Returns App<Element>
Inherited from APIScope.$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 APIScope.$vApp
- Defined in src/api/common.ts:28

Methods

easyLayer

easyLayer(
layerConfig: RampLayerConfig,
legendConfig?: any,
): Promise<LayerInstance>
Add a layer to the map and legend (if legend exists)
Parameters
- layerConfig: RampLayerConfig
  a RAMP layer configuration object
- OptionallegendConfig: any
  optional legend block configuration object. If not provided, a default layer block will be created
Returns Promise<LayerInstance>
resolves with the layer instance
- Defined in src/api/dev.ts:20