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
ProtectedoverviewThe instance of Vue R4MP application controlled by this InstanceAPI.
This is just a shorthand for this.$iApi.$vApp.
A promise that resolves when the map view has been created
ProtectedabstractProtectedapplyProtectedApplies 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
ProtectedcreateProtectedWill generate a ESRI map view and add it to the page Must provide the basemap or basemap id to be used when creating the map view
the id of the basemap that should be used when creating the map view
ProtecteddestroyProtecteddestroyProtectedfindProvides the spatial reference of the map
the map spatial reference in RAMP API format
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.
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
Sets the overview map's basemap to the basemap with the given id. Will refresh the map view if set basemap uses different tile schema.
Should only be called by the overview map component
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
Updates overviewmap extent and graphic based on main map extent
new main map extent
A promise that resolves when the overviewmap has finished updating
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
A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.
Export
APIScope