Protected_Protected_Readonly$iThe instance of RampMap API scoped to a single Vue R4MP application.
Indicates 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
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. Attribute-less layers will return empty string;
Array of field definitions about the given layer's fields. Attribute-less layers will have empty arrays.
The geometry type of the layer.
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
If the layer is being managed by a RAMP functionality
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
ProtectedmaptipThe maptip arcade executor if a maptip formula is defined
ProtectedmaptipInternally tracks any arcade formula for the maptip value.
Field name that contains value considered the maptip of a feature. Not applicable for attribute-less layers. Ignored if maptipArcade is set. nameValue is used if neither are set.
If the layer should show maptips on the map
ReadonlymimeThe name of the layer.
ProtectednameThe name arcade executor if a name formula is defined
ProtectednameInternally tracks any arcade formula for the name value.
Field name that contains value considered the name of a feature. Not applicable for attribute-less layers. Ignored if nameArcade is set.
Field name that contains the object ID of a feature. Not applicable for attribute-less layers.
ProtectedorigThe 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
ProtectedviewReturns an array describing the draw order of features, if applicable.
DEPRECIATED #2595 Use maptips
DEPRECIATED #2595 Use maptips
Indicates if the Esri map layer exists
Arcade formula to derive maptip of the feature. Empty string indicates no formula in use. Not applicable for attribute-less layers.
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
Arcade formula to derive name of feature. Empty string indicates no formula in use. Not applicable for attribute-less layers.
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
DEPRECIATED #2595 Use maptipArcade
DEPRECIATED #2595 Use maptipField
DEPRECIATED #2595 Use maptipField
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
Requests that an attribute load request be aborted. Useful when encountering a massive dataset or a runaway process.
FunctionApplies the current filter settings to the physical map layer.
applySqlFilter
list of any filters to exclude from the result. omission includes all keys
Indicates if the attribute load has been aborted.
boolean if the process has been stopped
Cancels an in-progress initialize or load of the layer and places it in an Error state. Has no effect on a layer that is loaded, has been terminated, or never initiazed.
Indicates if layer should participate in an identify request.
FunctionChecks the visibility of the sublayers If all sublayers are invisible, then this layer is also set to invisible
checkVisibility
Requests that any downloaded attribute sets or cached geometry be removed from memory. The next requests will pull from the server again.
Check if layer controls is available on this layer.
the layer control to check
Indicates if the given control is enabled on this layer
The number of attributes currently downloaded (will update as download progresses)
current download count
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
Handles click events for WMS layers (makes a WMS GetFeatureInfo call behind the scenes).
a list of strings identifying the WMS sublayers to be queried
a RAMP Point indicating where the user clicked
the format to be requested for the response
a promise which resolves with the GetFeatureInfo response
Gets the fields whose string values should be trimmed.
the field names.
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 of the geometry for a given object id. Only valid for feature layers. Not applicable to point geometry.
the object id of the feature in question
resolves with the extent of the desired feature's geometry. Undefined for invalid requests
Gets the icon for a specific feature, as an SVG string.
the object id of the feature to find
resolves with an svg string encoding of the icon
Provides a tree structure describing the layer and any sublayers, including uid values. Should only be called after loadPromise resolves.
the root of the layer tree
Finds the appropriate legend URLs for WMS layers.
a list of objects identifying the WMS layers to be queried
a list of strings containing URLs for specified layers (order is preserved)
Attempts to find the local (client side) geometry for a given object id. Only valid for feature layers.
the object id of the feature in question
resolves with the geometry of the desired feature. Undefined if the feature is not local or request is invalid.
Returns the value of a named SQL filter for the layer.
the filter key / named filter to view
the value of the where clause for the filter. Empty string if not defined.
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
Sets up the internal layer object (ESRI) and initiates the loading process. The promise returned resolves when the object exists (i.e. .esriLayer is populated). This means the layer can be added to the map.
FunctionIndicates if the layer is not in a visible scale range.
isOffscale
OptionaltestScale: 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
FunctionDownload or refresh the internal symbology for the sublayer.
loadSymbology
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
Handles initialization logic for feature maptips. Only valid for layers that support attributes. Needs to be called after nameInitializer to ensure correct fallback defaults. Typically called by internal processes.
a ramp layer configuration object. Can pass empty object if n/a.
Given the attributes of a feature of this layer, returns the maptip of that feature. Valid only for layers that support attributes.
attribute values
the name
Handles initialization logic for feature names. Only valid for layers that support attributes. Typically called by internal processes.
a ramp layer configuration object. Can pass empty object if n/a.
name field as defined by the layer service. Not required
Given the attributes of a feature of this layer, returns the name of that feature. Valid only for layers that support attributes.
attribute values
the name
ProtectednoProtectednotInitiates actions after layer load error. Should generally only be called internally by the RAMP core.
Flag to detect error setting due to manual cancellation. Only genuine errors will raise notifications.
ProtectedonInitiates actions after layer load. Should generally only be called internally by the RAMP core.
ProtectedonAttempts to reload the internal layer object (ESRI). Effectively doing a terminate then initiate, and removing/re-adding layer to the map.
If layer is map bound, and has an esri layer in the esri map, remove it from esri map. Typically should only be called by RAMP internals.
Run a getFeatureInfo on a WMS layer, return the result as a promise. Options: specs to be added once finalized
additional arguemets, see above.
an object with identify results array and identify promise resolving when identify is complete; if an empty object is returned, it will be skipped
FunctionAdd a WMS layer parameter, maybe even refresh the layer
setCustomParameter
name of the key to be created or updated
value of the key
show the new fancy version of the layer or not
Sets a new arcade formula for the maptip value.
Promise that resolves when the arcade executor has been generated.
Sets a new arcade formula for the name value.
Promise that resolves when the arcade executor has been generated.
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
DEPRECIATED #2595 Use setMaptipArcade
ProtectedstartStart the draw/load timer for the layer, after which is a slow to load/draw notification is shown.
the type of timer to start (load or draw)
ProtectedstopStop the draw/load timer for the layer, if it was started.
the type of timer to stop (load or draw)
ProtectedstubResets 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.
DEPRECIATED #2595 Use maptipInitializer
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
Will zoom the map to the geometry for a given object id. Only valid for layers that support features
the object id of the feature in question
resolves with a boolean when the zoom finishes. The value indicates if the zoom was successful
Cause the map to zoom to this layer's boundary extent
resolves when map has finished zooming
Cause the map to zoom to a scale level where the layer is visible.
resolves when map has finished zooming
A layer class which implements an ESRI WMS Layer.