the RAMP instance
Readonly$iThe instance of RampMap API scoped to a single Vue R4MP application.
Indicates if the map has been created
The internal esri map view. Changes from outside of RAMP may break the instance. Use caution.
Any map labels defaulting
Map wide defaults for layer times. Layers can override.
Identifies the map. Primarily used for debugging.
A promise that resolves when the map view has been created
ProtectedabstractRegisters a layer with the instance and attempts to add it to the the map. The return value provides an async indicator if the map add was successful, but the layer is registered regardless. Optionally can specify the layer order index for map layers.
the Ramp layer to add
optional order index to add the layer to
a promise that resolves when the layer has been added to the map
ProtectedapplyProtectedSets the basemap to the basemap with the given id or the basemap object Throws error if basemap could not be found
the basemap id or object
resolves when the basemap has been applied
Will generate the actual Map control objects and construct it on the page
the config for the map
the div to be used for the map view
resolves when the map has been created
ProtectedcreateProtectedWill generate a ESRI map view and add it to the page Can optionally provide the basemap or basemap id to be used when creating the map view
Optionalbasemap: string | Basemapthe id of the basemap that should be used when creating the map view
resolves when the map view has been created.
Destroys the ESRI map. Typically called by internal system, use at your own risk.
ProtecteddestroyProtectedDestroys the ESRI map view
ProtectedfindProtectedSearches the local basemap list for a basemap with the given id Throws error if basemap could not be found
basemap id
resolves with the found basemap
FunctionFinds the tile scale (level of detail) closest to the provided scale. If using a map with no scale levels, will return the given scale.
findClosestScale
scale value to search for in the levels of detail
the level of detail scale closest to the input
Get the id of the currently used basemap Returns undefined if there is no map
current basemap id
Get the top-most graphic at the given screen point Returns undefined if there is no graphic
The screen coordinates to inspect
resolves with topmost graphic or undefined
Get the height of the map on the screen in pixels
pixel height
Get the width of the map on the screen in pixels
pixel width
Provides the resolution of the map. This means the number of map units that is covered by one pixel.
the map resolution
Provides the scale of the map (the scale denominator as integer)
the map scale
Provides the spatial reference of the map
the map spatial reference in RAMP API format
Provides the zoom level of the map
the map zoom level
Utility method to insert a Map Layer into the ESRI map. The position in ESRI map is derived from global order and what layers are currently in the map.
the RAMP layer to insert. Must be a Map layer
Get a pixel in screen co-ordinates corresponding to a point in map co-ordinates.
point on the map
the screen point analagous to the map point
ProtectednoWill attempt to change to another basemap if the very first basemap failed. If nothing is defined, will do nothing but manage our watching state.
the basemap schema id (where the fallback is defined)
resolves after recovery has initiated
Register an optional provider that can adjust map identify geometry.
provider to register
function that unregisters the provider
Reloads the map with the given map config and target div. This breaks down and re-creates the internal map state.
the config for the map
the div to be used for the map view
resolves when the map has been re-created. Layers may still be loading.
Removes a layer from the map and fires the layer remove event. This will also unregister the layer from the Ramp instance.
the Ramp layer or layer id/uid to remove
a promise that resolves when the layer has been removed from the map
Removes a sublayer from the map
a promise that resolves when the layer has been removed from the map
Reorders a layer on the map. The position is based on the instance layer order state maintained by the LayerAPI. If ignoreCosmetic is set, the index changes to a different basis. Essentially the as if cosmetic layers did not exists in the layer order state.
the RAMP layer to be moved. If a sublayer is passed, the parent will be reordered.
the RAMP layer index where the layer will be moved to
indicates if the index should ignore cosmetic layers
Performs an identify request on all layers that support identify, and combines the results.
results of the identify
Get a point in map co-ordinates corresponding to a pixel in screen co-ordinates.
pixel screen co-ord of the point on the map
the map point analagous to the screen point
Set the map's basemap to the basemap with the given id. If the new basemap's tile schema differs from the current one, the map view will be refreshed
The returned boolean indicates if the schema has changed.
the basemap id
resolves with boolean indicates if the schema has changed
Set's the map's mapMouseThrottle value to newThrottle. If newThrottle is not a positive number, a console error is thrown.
The returned boolean indicates if the value has been successfully set.
the new mapMouseThrottle value, which must be a positive number
indicates if the value was set successfully
Set's the map's pointZoomScale value to newScale. If newScale is not a positive number, a console error is thrown.
The returned boolean indicates if the value has been successfully set.
the new pointZoomScale value, which must be a positive number
indicates if the value was set successfully
Create a screenshot of the current view.
Possible ESRI takeScreenshot() options: https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#takeScreenshot Will default to quality = 1 and format = 'png'.
ESRI takeScreenshot() options
a promise that resolves with a Screenshot
Unregister a map identify geometry provider.
provider to unregister
Zooms the map to the next zoom level in towards the earth. The center point will not change. In the rare case where there is no basemap, this will likely do nothing
A promise that resolves when the map has finished zooming
Zooms the map to a given geometry.
A RAMP API geometry to zoom the map to
Optionalscale: numberAn optional scale value of the map. Is ignored for non-Point geometries
Optionalanimate: boolean = trueOption to turn off the zoom animation. On by default
Optionalduration: number = 200Option to change animation duration (in milliseconds). Default of 200. Ignored if animate is off.
Optionaleasing: ZoomEasing = 'ease'Option to change animation easing function. Default of 'ease'. Ignored if animate is off.
A promise that resolves when the map has finished zooming
Zooms the map to the next zoom level out away from the earth. The center point will not change. In the rare case where there is no basemap, this will likely do nothing
A promise that resolves when the map has finished zooming
Zooms the map to a given zoom level. The center point will not change. In the rare case where there is no basemap, this will likely do nothing
An integer matching the level of detail / zoom level the map should adjust to
A promise that resolves when the map has finished zooming
Zooms the map to the closest zoom level that will be visible for a given scale set. Does nothing if scale set is already visible for the map.
A promise that resolves when the map has finished zooming
A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.
Export
APIScope