Readonly $iThe instance of RampMap API scoped to a single Vue R4MP application.
APIScope
Protected _parentProtected _sublayersProtected attribsIndicates if the layer can be modified with filters.
The type of spatial data used to generate layer content
State of drawing / refreshing data for a layer
The 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.
Protected filterThe geometry type of the layer.
If the layer should show hovertips on the map
ID of this layer. Also known as the layerId.
LayerInstance
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
How the layer is instantiated in the map stack
Index of the layer. Aligns to index of arcgis server, or defaults to 0 on other layers
State of the actual layer on the map, such as loading, loaded, error'd.
Protected layerType of layer this is (describes the overall layer)
Legend symbols of the layer
Protected loadProtected loadIf the layer type can exist on the map
How long layer can load for before error (milliseconds)
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.
Protected origIf the layer type can support Feature type requests and operations
If the layer type can support an identify request
If the layer has Sublayers
Unique identifier for this layer. Randomly generated at runtime.
If the layer was added by user interaction during the session
Protected viewThe instance of Vue R4MP application controlled by this InstanceAPI.
This is just a shorthand for this.$iApi.$vApp.
APIScope
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
isLoaded
Indicates if the Esri map sublayer and the parent's Esri map layer exist.
Get the mouse tolerance in pixels for this sublayer's parent layer
the mouse tolerance of the parent layer
Set the mouse tolerance for this sublayer's parent layer in pixels
the new mouse tolerance
Returns the opacity of the sublayer.
opacity of the sublayer
getOpacity
Applies opacity to sublayer.
the new opacity setting
setOpacity
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 sublayer's parent layer
the touch tolerance of the parent layer
Set the touch tolerance in pixels for this sublayer's parent layer
the new touch tolerance of the parent layer
Returns the visibility of the sublayer.
visibility of the sublayer
getVisibility
Applies visibility to sublayer.
the new visibility setting
setVisibility
Check if layer controls is available on this layer.
the layer control to check
Indicates if the given control is enabled on this layer
Set the ESRI sublayer using the parent's sublayer list
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.
Optional exclusions: string[]list of any filter keys to exclude from the result. omission includes all filters
all non-excluded sql statements connected with AND operators.
getCombinedSqlFilter
Gets array of object ids that currently pass any filters
Optional exclusions: string[] = []list of any filters keys to exclude from the result. omission includes all filters
Optional extent: Extent = undefinedif 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.
getFilterOIDs
Gets information on a graphic in the most efficient way possible. Options object properties:
the object id of the graphic to find
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 the parent MIL.
the layer spatial reference in RAMP API format
Private getPrivate
Attempts to get an sublayer based on the index or uid provided.
the uid or numeric index of the item we are interested in
the matching feature class object, or undefined if the root was requested
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
Indicates if the layer is not in a visible scale range.
Optional testScale: number = undefinedoptional scale to test against. if not provided, current map scale is used.
true if the layer is outside of a visible scale range
isOffscale
Will load and apply metadata from the ArcGIS Server endpoint to this layer.
loading options. Currently only supports custom renderer override
Protected makeTake 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
Private mapProtected noProtected notProtected onRequests 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
{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.
{Object} options to provide filters and helpful information.
resolves 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
Add a WMS layer parameter, maybe even refresh the layer
name of the key to be created or updated
value of the key
show the new fancy version of the layer or not
setCustomParameter
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
Protected startProtected stopProtected stubResets 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.
Generated using TypeDoc
A layer class which implements an ESRI Map Image Sublayer.