LocateViewModel

require(["esri/widgets/Locate/LocateViewModel"], function(LocateVM) { /* code goes here */ });
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:
var 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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Object

The HTML5 Geolocation Position options for locating.

more details
more detailsLocateViewModel
Boolean

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

more details
more detailsLocateViewModel
Graphic

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

more details
more detailsLocateViewModel
Number

The scale to set on the view when navigating to the position of the geolocated result.

more details
more detailsLocateViewModel
String

The current state of the widget.

more details
more detailsLocateViewModel
MapView | SceneView

The view associated with the widget.

more details
more detailsLocateViewModel

Property Details

declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

geolocationOptionsObject

The HTML5 Geolocation Position options for locating. Refer to Geolocation API Specification for details.

Default Value:{ maximumAge: 0, timeout: 15000, enableHighAccuracy: true }
goToLocationEnabledBoolean

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

Default Value:true
graphicGraphic

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

Example:
var locateWidget = new Locate({
  viewModel: { // autocasts as new LocateViewModel()
    view: view,  // Assigns the locate widget to a view
    graphic: new Graphic({
      symbol: { type: "simple-marker" }  // Overwrites the default symbol used for the
      // graphic placed at the location of the user when found
    })
  }
});
scaleNumber
Since: ArcGIS API for JavaScript 4.7

The scale to set on the view when navigating to the position of the geolocated result. If a scale value is not explicitly set, then the view will navigate to a default scale of 2500.

Default Value:null
stateStringreadonly

The current state of the widget.

Possible Values: disabled | ready | locating

Default Value:disabled

The view associated with the widget.

Method Overview

NameReturn TypeSummaryClass

Emits an event on the instance.

more details
more detailsLocateViewModel
Boolean

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

more details
more detailsLocateViewModel
Promise<Object>

Animates the view to the user's location.

more details
more detailsLocateViewModel
Object

Registers an event handler on the instance.

more details
more detailsLocateViewModel

Method Details

emit(type, event)
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

The event payload.

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:
TypeDescription
BooleanReturns true if the class supports the input event.
locate(){Promise<Object>}

Animates the view to the user's location.

Returns:
TypeDescription
Promise<Object>Resolves to an object with the same specification as the event object defined in the locate event.
Example:
var 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:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

Event Overview

NameTypeSummaryClass
{error: Error}

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

more details
more detailsLocateViewModel

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:
Searching...

API Reference search results

NameTypeModule

There were no match results from your search criteria.