LocateViewModel

AMD: require(["esri/widgets/Locate/LocateViewModel"], (LocateVM) => { /* code goes here */ });
ESM: import LocateVM from "@arcgis/core/widgets/Locate/LocateViewModel";
Class: esri/widgets/Locate/LocateViewModel
Inheritance: LocateViewModel Accessor
Since: ArcGIS API for JavaScript 4.0

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.

See also
Example
let locateWidget = new Locate({
  viewModel: { // autocasts as new LocateViewModel()
    view: view   // attaches the Locate button to the view
  },
  container: "locateDiv"
});

Constructors

new LocateViewModel(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
Object

An object used for setting optional position parameters.

more details
LocateViewModel
Boolean

Indicates whether to navigate the view to the position and scale of the geolocated result.

more details
LocateViewModel
GoToOverride

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

more details
LocateViewModel
Graphic

The graphic used to show the user's location on the map.

more details
LocateViewModel
Boolean

Indicates whether to display the Popup of the result graphic from the locate() method.

more details
LocateViewModel
Number

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.

more details
LocateViewModel
String

The current state of the widget.

more details
LocateViewModel
MapView|SceneView

The view associated with the widget.

more details
LocateViewModel

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

geolocationOptions Object

An object used for setting optional position parameters. Refer to the Geolocation API Specification for details on using these paramters.

Default Value:null
Example
const track = new Track({
  view: view,
  // Set optional position paramters
  geolocationOptions: {
    maximumAge: 0,
    timeout: 15000,
    enableHighAccuracy: true
  }
});
goToLocationEnabled Boolean

Indicates whether to navigate the view to the position and scale of the geolocated result.

Default Value:true
goToOverride GoToOverride
Since: ArcGIS API for JavaScript 4.8

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

See also
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

The graphic used to show the user's location on the map.

Example
const 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 Boolean
Since: ArcGIS API for JavaScript 4.19

Indicates whether to display the Popup of the result graphic from the locate() method.

Default Value:true
See also
scale Number
Since: ArcGIS API for JavaScript 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 and 4514 for 2D. To override the default in 2D, set the scale property and also set snapToZoom to false. For 2D views the value should be within the effectiveMinScale and effectiveMaxScale.

Default Value:null
state Stringreadonly

The current state of the widget.

Possible Values:"disabled"|"ready"|"locating"

Default Value:disabled

The view associated with the widget.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor

This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device.

more details
LocateViewModel
Boolean

Emits an event on the instance.

more details
LocateViewModel
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
LocateViewModel
Boolean

Returns true if a named group of handles exist.

more details
Accessor
Promise<object>

Animates the view to the user's location.

more details
LocateViewModel
Object

Registers an event handler on the instance.

more details
LocateViewModel

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

cancelLocate()
Since: ArcGIS API for JavaScript 4.9

This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device.

emit(type, event){Boolean}
Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters
type String

The name of the event.

event Object
optional

The event payload.

Returns
Type Description
Boolean true if a listener was notified
hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter
type String

The name of the event.

Returns
Type Description
Boolean Returns true if the class supports the input event.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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(){Promise<object>}

Animates the view to the user's location.

Returns
Type Description
Promise<object> Resolves to an object with the same specification as the event object defined in the locate event.
Example
let 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(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns
Type 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.
Example
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Event Overview

Name Type Summary Class
{error: Error}

Fires after the locate() method is called and fails.

more details
LocateViewModel

Event Details

locate-error

Fires after the locate() method is called and fails.

Property
error Error

The Error object that occurred while locating.

See also

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.