The instance of RampMap API scoped to a single Vue R4MP application.
Readonly$iThe instance of RampMap API scoped to a single Vue R4MP application.
Protected_parentProtected_sublayersProtectedattribsIndicates if the layer can be modified with filters.
Indicates if the layer can be reloaded.
The type of spatial data used to generate layer content
State of drawing / refreshing data for a layer
ProtectedesriThe internal ESRI API layer
The internal ESRI API sublayer. Valid only by sublayers
The internal ESRI API layer view
Object that contains values for the expected draw/response time.
The extent of the layer on the map
Feature count
Comma delimited string of field names (or '*' for all). Useful for numerous ESRI api calls. Non-feature layers will return empty string;
Array of field definitions about the given layer's fields. Non-feature layers will have empty arrays.
ProtectedfilterThe geometry type of the layer.
If the layer should show hovertips on the map
ID of this layer. Also known as the layerId.
If the layer is set to participate in identify requests
The type of logic used to identify items on the layer
State of the initiation / termination process of the layer
If the layer is non-interactive and only displays content on the map
If the layer was sourced from a file or a WFS source (which disconnects after load).
Tracks if layer is removed from map. Is false during the period "before" the layer gets added to map.
If the layer is a Sublayer
Timecode value for the start of most recent cancel request. Used to avoid races between async things returning after layers cancel or reload.
How the layer is instantiated in the map stack
Index of the layer. Aligns to index of arcgis server source, or defaults to 0 on other layers. Map Image Layers and layers that do not support attributes have a value of -1
State of the actual layer on the map, such as loading, loaded, error'd.
ProtectedlayerType of layer this is (describes the overall layer)
Legend symbols of the layer
ProtectedloadProtectedloadA boolean to track whether the promise is pending (false) or fulfilled/rejected (true)
If the layer type can exist on the map
The name of the layer.
Field name that contains value considered the name of a feature. Not applicable for non-feature layers.
Field name that contains the object ID of a feature. Not applicable for non-feature layers.
ProtectedorigProtectedsourceThe spatial reference of the source of geometry (e.g. map server). Undefined for non-ArcServer and non-spatial layers.
If the layer type can support Feature type requests and operations
If the layer type can support an identify request
If the layer has Sublayers
Tracks load and draw elapsed time
Unique identifier for this layer. Randomly generated at runtime.
url of the service
If the layer was added by user interaction during the session
ProtectedviewThe instance of Vue R4MP application controlled by this InstanceAPI.
This is just a shorthand for this.$iApi.$vApp.
Indicates if the layer is in a state that is makes sense to interact with. I.e. False if layer has not done it's initial load, or is in error state. Acts as a handy shortcut to inspecting the layerState.
true if layer is loaded
Indicates if the Esri map layer exists
Get the mouse tolerance in pixels for this layer
the mouse tolerance of this layer
Set the mouse tolerance for this layer in pixels
the new mouse tolerance
Returns the opacity of the layer.
opacity of the layer (range between 0 and 1)
Applies opacity to layer.
the new opacity setting (range between 0 and 1)
Get the parent layer for this layer Only supported for sublayers
the parent layer of this layer
Set the parent layer for this layer Only supported for sublayers
the new parent layer for this layer
Get the sublayers for this layer
the sublayers of this layer
Get the touch tolerance in pixels for this layer
the touch tolerance of this layer
Set the touch tolerance in pixels for this layer
the new touch tolerance
Returns the visibility of the layer.
visibility of the layer
Applies visibility to layer.
the new visibility setting
ProtectedconfigProcesses any layer order configuration and modifies the passed ESRI layer config with ESRI-friendly definitions
{RampLayerConfig} Ramp layer configuration object.
Check if layer controls is available on this layer.
the layer control to check
Indicates if the given control is enabled on this layer
Invokes the process to get the full set of attribute values for the layer. Repeat calls will re-use the downloaded values unless the values have been explicitly cleared.
resolves with set of attribute values
Returns a SQL WHERE condition that is combination of active filters.
Optionalexclusions: string[]list of any filter keys to exclude from the result. omission includes all filters
all non-excluded sql statements connected with AND operators.
Gets array of object ids that currently pass any filters for the layer
list of any filters keys to exclude from the result. omission includes all filters
if provided, the result list will only include features intersecting the extent
resolves with array of object ids that pass the filter. if no filters are active, resolves with undefined.
Gets information on a graphic in the most efficient way possible. Options object properties:
the object id of the graphic to find
options object for the request, see above
resolves with a Graphic containing the requested information
Gets the extent where the provided object id is on the map. Can only be used on feature layers with multipoint, polyline, polygon geometry.
the object id to query
resolves with the extent where the object id is present
Provides the spatial reference of how the underlying ESRI layer is encoding geometry on the client.
the layer spatial reference in RAMP API format
Invokes the process to get the full set of attribute values for the layer, formatted in a tabular format. Additional data properties are also included. Repeat calls will re-use the downloaded values unless the values have been explicitly cleared.
resolves with set of tabular attribute values
Will load and apply metadata from the ArcGIS Server endpoint to this layer.
loading options. Currently only supports custom renderer override
ProtectedmakeTake a layer config from the RAMP application and derives a configuration for an ESRI layer
snippet from RAMP for this layer
configuration object for the ESRI layer representing this layer
ProtectednoProtectednotProtectedonProtectedonRequests a set of features for this layer that match the criteria of the options
{Object} options to provide filters and helpful information.
resolves with an array of features that satisfy the criteria
Requests a set of features for this layer that match the criteria of the options
Each result item is loaded independently. This will capitalize on caching, but will be expensive when expecting a large result set and nothing currently cached.
{Object} options to provide filters and helpful information.
resolves in an array of object ids and promises resolving in each feature
Will return an array of object ids for features in the layer that satisfy the conditions of the query options parameter.
resolving with an array of numbers (object ids)
Baseline identify function for layers that do not support identify. Will return an empty result. Layers that support identify should override this method. Note: implementations that return real data must make that data reactive()
not used, present for nice signature of overrided function
an empty result set
Applies an SQL filter to the layer. Will overwrite any existing filter for the given key.
Use 1=2 for a "hide all" where clause.
the filter key / named filter to apply the SQL to
the WHERE clause of the filter
ProtectedstartProtectedstopProtectedstubResets the layer class to the state it was in "pre-initialize". Implementers can decide if they want to retain any state (e.g. UIDs/layerTree would be a good idea). Also an appropriate function to remove any event listeners/triggers. This would be called in situations like a layer getting deleted, or in a layer reload (initialize would be called again afterwards). Note this does not remove any layers from the map stack, that must be done by the caller.
Updates layer draw state and raises events. Should generally only be called internally by the RAMP core.
Updates layer layer state and raises events. Should generally only be called internally by the RAMP core.
Updates layer load state and raises events. Should generally only be called internally by the RAMP core.
load state the layer is entering
optional flag to indicate if an error state was intentional due to a user cancel request
A layer class which implements an ESRI Feature Layer with data from a zipped FlatGeobuf source.