Protected constructorReadonly $iThe instance of RampMap API scoped to a single Vue R4MP application.
APIScope
Private _basemapLocal storage of Basemap objects
Private _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
Private _viewInternal deferred managing the view promise
Indicates if the map has been created
Private esriThe internal esri map. Avoid referencing outside of geoapi.
The internal esri map view. Changes from outside of RAMP may break the instance. Use caution.
Private handlersList of ESRI watch handlers
Any map labels defaulting
Private pointThe default zoom level when zooming to a point feature
Private trackTracks if we are watching for the first basemap to load.
The instance of Vue R4MP application controlled by this InstanceAPI.
This is just a shorthand for this.$iApi.$vApp.
APIScope
A promise that resolves when the map view has been created
Protected abstractProtected applyProtected
Applies the given basemap (or basemap with given id) to the esri map Throws error if basemap could not be found with the given id
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
This method should be overidden by child map classes
Optional basemap: string | Basemapthe id of the basemap that should be used when creating the map view
Protected destroyProtected destroyProtected findPrivate geomPrivate
Projects a geometry to the map's spatial reference
the RAMP API geometry to project
the geometry projected to the map's projection, in RAMP API Geometry format
Provides the spatial reference of the map
the map spatial reference in RAMP API format
Protected noWill attempt to change to another basemap if the very first basemap failed. If nothing is defined, will do nothing but manage our watching state.
This method is overidden as needed
the basemap schema id (where the fallback is defined)
Reloads the map with the given map config and target div
the config for the map
the div to be used for the map view
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.
This method should be overidden by child map classes
the basemap id
indicates if the schema has changed
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
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 = trueOption to turn off the zoom animation. On by default
Optional duration: number = 200Option to change animation duration (in milliseconds). Default of 200. Ignored if animate is off.
Optional easing: 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
Generated using TypeDoc
A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.
Export