the RAMP instance
Readonly $iThe instance of RampMap API scoped to a single Vue R4MP application.
APIScope
Private _activePrivate _basemapLocal storage of Basemap objects
Private _mousePrivate _panPrivate _rampThe active extent set in RAMP API Extent Set format. Allows a quick reference to the available extents if needed.
Private _rampSRThe map spatial reference in RAMP API Spatial Reference format. Saves us from converting from ESRI format every time it is needed
Private _targetThe viewDiv for the ESRI MapView The map will be rendered using this div object
Protected _viewIndicates if the map has been created
Private esriThe internal esri map. Avoid referencing outside of geoapi.
Private esriThe internal esri map view. Avoid referencing outside of geoapi.
Private handlersList of ESRI watch handlers
Private mapThe throttle level for map mouse move events
Private pointThe default zoom level when zooming to a point feature
The instance of Vue R4MP application controlled by this InstanceAPI.
This is just a shorthand for this.$iApi.$vApp.
APIScope
Returns if keys are active on map
MapAPI
Returns if map focus is caused by mouse click
MapAPI
Protected abstractAdds a layer to the map Optionally can specify the layer order index
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
Protected applyProtected
Sets 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
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
Protected createProtected
Will 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
Optional basemap: string | Basemapthe id of the basemap that should be used when creating the map view
Private createProtected destroyProtected findGet the top-most graphic at the given screen point Returns undefined if there is no point
The screen coordinates
a promise that resolves when a graphic is hit (undefined if no graphic was hit)
Provides the spatial reference of the map
the map spatial reference in RAMP API format
Private keyPrivate keyGet 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
Protected noReloads the map with the given map config and target div
the config for the map
the div to be used for the map view
Removes a layer from the map and fires the LAYER_REMOVE event
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 RAMP layer to be moved
the RAMP layer index for placing the layer
indicates if cosmetic layers should be ignored during reordering
Performs an identify request on all layers that support identify, and combines the results.
MapAPI
MapIdentifyResult
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
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/api-reference/esri-views-MapView.html#takeScreenshot Will default to quality = 1 and format = 'png'.
ESRI takeScreenshot() options
a promise that resolves with a Screenshot
Zooms the map to a given geometry.
A RAMP API geometry to zoom the map to
Optional scale: numberAn optional scale value of the map. Is ignored for non-Point geometries
Optional animate: boolean = trueAn optional animation setting. On by default
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
Generated using TypeDoc
A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.
Export