Creates an instance of APIScope.
APIScope
Readonly $iThe instance of RampMap API scoped to a single Vue R4MP application.
APIScope
The instance of Vue R4MP application controlled by this InstanceAPI.
This is just a shorthand for this.$iApi.$vApp.
APIScope
Will apply any field config metadata to a layer. Should be used after loading process has populated .fields property of the layer
the layer to apply the additional configuration to. Will be modified.
field settings from the config object. can be undefined
Private arcWill load an attribute set from an ArcGIS Server, recursively batching to work around maximum result limits.
defines the parameters for what to load
the controller which provides asyncronous hooks into the load, including loaded count and ability to abort
Util function to manage trickery. Non-Arcgis layer sources can have field names that are bad keys. Our loader will have corrected them, but the ramp layer config may still be referencing the original names (e.g. nameField, tooltipField). This function will attempt to return the valid field name for a given original field name.
array of valid fields for the layer
field name as defined in the source
a valid field name to use. Empty string if none found
Will generate the tabular transformation of an attribute set for a layer. The result will also be cached in the attribute source. If the result is already cached, it will be returned. The layer must be the owner of the attribute source. This method is generally called from an internal call within a layer. It exists as a public API to allow re-use across diverging layer types.
the layer owning the attributes and the attribute source
the attribute source for the attributes to transform
Private generateWorker method for the above generateTabularAttributes call. Separating allows us to use async syntax for the heavy lifting, but provides a promise via method that can easily be assigned to the cache. Difficult to save your own async promise within your own method.
the layer owning the attributes and the attribute source
the attribute source for the attributes to transform
Will load an attribute set from an ArcGIS Server layer source.
defines the parameters for what to load
the controller which provides asyncronous hooks into the load, including loaded count and ability to abort
Will generate an attribute set from a compact json object. This is our base format for DataLayer sources that are not hosted on ArcGIS server. Provided sourceDataJson on the details parameter has already been cleaned and has object ids inserted.
defines the parameters for what to load
the controller which provides asyncronous hooks into the load, including loaded count and ability to abort
Will generate an attribute set from a feature layer with local data (i.e. a file layer).
defines the parameters for what to load
the controller which provides asyncronous hooks into the load, including loaded count and ability to abort
Private oidWill populate the object id index for an attribute set.
attribute set that has features populated
name of the object id field in the attribute set
Will order the fields of a layer based on its fieldInfo.
the current order of the fields
the fieldInfo config that contains the order the fields should be displayed in
Generated using TypeDoc
Provides methods for handling ESRI-style attributes