require(["esri/widgets/Locate/LocateViewModel"], (LocateVM) => { /* code goes here */ });
import LocateVM from "@arcgis/core/widgets/Locate/LocateViewModel.js";
esri/widgets/Locate/LocateViewModel
Provides the logic for the Locate widget, which animates the View to the user's current location.
The (geolocation) functionality is not supported on insecure origins. To use it, switch your application to a secure origin, such as HTTPS. Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that supports Window.isSecureContext (currently Chrome and Firefox).
As of version 4.2, the Locate Button no longer displays in non-secure web apps. At version 4.1 this only applied to Google Chrome.
let locateWidget = new Locate({
viewModel: { // autocasts as new LocateViewModel()
view: view // attaches the Locate button to the view
},
container: "locateDiv"
});
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
GeolocationPositionError|Error | Error that caused the last locate-error event to fire. | LocateViewModel | |
An object used for setting optional position parameters. | LocateViewModel | ||
Indicates whether to navigate the view to the position and scale of the geolocated result. | LocateViewModel | ||
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods. | LocateViewModel | ||
The graphic used to show the user's location on the map. | LocateViewModel | ||
Indicates whether to display the Popup of the result graphic from the locate() method. | LocateViewModel | ||
Indicates the scale to set on the view when navigating to the position of the geolocated result, after a location is returned from the track event. | LocateViewModel | ||
The current state of the widget. | LocateViewModel | ||
The view associated with the widget. | LocateViewModel |
Property Details
-
error
error GeolocationPositionError |Error
Since: ArcGIS Maps SDK for JavaScript 4.29LocateViewModel since 4.0, error added at 4.29. -
Error that caused the last locate-error event to fire.
- Default Value:null
Exampleif(locate.viewModel.state === 'error') console.error(locate.viewModel.error);
-
geolocationOptions
geolocationOptions Object
-
An object used for setting optional position parameters. Refer to the Geolocation API Specification for details on using these parameters.
- Default Value:null
Exampleconst track = new Track({ view: view, // Set optional position parameters geolocationOptions: { maximumAge: 0, timeout: 15000, enableHighAccuracy: true } });
-
goToLocationEnabled
goToLocationEnabled Boolean
-
Indicates whether to navigate the view to the position and scale of the geolocated result.
- Default Value:true
-
goToOverride
goToOverride GoToOverride
Since: ArcGIS Maps SDK for JavaScript 4.8LocateViewModel since 4.0, goToOverride added at 4.8. -
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
- See also
-
- esri/views/MapView#goTo
- SceneView
Example// The following snippet uses the Search widget but can be applied to any // widgets that support the goToOverride property. search.goToOverride = function(view, goToParams) { goToParams.options = { duration: updatedDuration }; return view.goTo(goToParams.target, goToParams.options); };
-
graphic
graphic Graphic
-
The graphic used to show the user's location on the map.
Exampleconst trackWidget = new Track({ // Assign the track widget to a view view: view, // Overwrite the default symbol used for the // graphic placed at the location of the user graphic: new Graphic ({ symbol: { // autocasts as new SimpleMarkerSymbol() type: "simple-marker", size: "12px", color: "blue", // autocasts as new SimpleLineSymbol() outline: { color: "#efefef", width: "1.5px" } } }) });
-
popupEnabled
popupEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.19LocateViewModel since 4.0, popupEnabled added at 4.19. -
- Default Value:true
- See also
-
scale
scale Number
Since: ArcGIS Maps SDK for JavaScript 4.7LocateViewModel since 4.0, scale added at 4.7. -
Indicates the scale to set on the view when navigating to the position of the geolocated result, after a location is returned from the track event.
By default, the view will navigate to a scale of
2500
for 3D and4514
for 2D. To override the default in 2D, set thescale
property and also set snapToZoom tofalse
. For 2D views the value should be within the effectiveMinScale and effectiveMaxScale.- Default Value:null
-
state
state Stringreadonly
-
The current state of the widget.
Possible Values:"disabled" |"ready" |"locating" |"feature-unsupported" |"error"
- Default Value:"disabled"
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device. | LocateViewModel | ||
Emits an event on the instance. | LocateViewModel | ||
Indicates whether there is an event listener on the instance that matches the provided event name. | LocateViewModel | ||
Returns true if a named group of handles exist. | Accessor | ||
Promise<Object> | Animates the view to the user's location. | LocateViewModel | |
Registers an event handler on the instance. | LocateViewModel | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Since: ArcGIS Maps SDK for JavaScript 4.9LocateViewModel since 4.0, cancelLocate added at 4.9. -
This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
locate
locate(){Promise<Object>}
-
Animates the view to the user's location.
ReturnsType Description Promise<Object> Resolves to an object with the same specification as the event object defined in the locate event. Examplelet locateWidget = new Locate({ viewModel: { // autocasts as new LocateViewModel() view: view }, container: "locateDiv" }); locateWidget.locate().then(function(){ // Fires after the user's location has been found });
-
on
on(type, listener){Object}
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersReturnsType Description Object Returns an event handler with a remove()
method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
Event Overview
Name | Type | Summary | Class |
---|---|---|---|
|
{position: Object} |
Fires after the locate() method is called and succeeds. |
LocateViewModel |
|
{error: GeolocationPositionError|Error} |
Fires after the locate() method is called and fails. |
LocateViewModel |
Event Details
-
Fires after the locate() method is called and succeeds.
- Property
-
position Object
Position returned from the Geolocation API.
- See also