require(["esri/widgets/Locate"], function(Locate) { /* code goes here */ });
Class: esri/widgets/Locate
Inheritance: Locate Widget Accessor
Since: ArcGIS API for JavaScript 4.0

Provides a simple widget that animates the View to the user's current location. By default the widget looks like the following:

locate-button

The Locate widget 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.

If the spatial reference of the View is not Web Mercator or WGS84, the user's location must be reprojected to match the view's spatial reference. This is done with the GeometryService URL referenced in esriConfig. You can optionally set the geometryServiceUrl in esriConfig to your own GeometryService instance. If not specified, however, it will refer to the service hosted in the default portal instance. See esriConfig.geometryServiceUrl for an example.

You can use the view's DefaultUI to add widgets to the view's user interface via the ui property on the view. The snippet below demonstrates this.

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
var locateWidget = new Locate({
  view: view,   // Attaches the Locate button to the 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
  })
});

view.ui.add(locateWidget, "top-right");

Constructors

new Locate(properties)

Parameter:
properties Object
optional

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

Example:
// typical usage
var locate = new Locate({
  view: view
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String | HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

When true, this property indicates whether the widget has been destroyed.

more details
more detailsWidget
Object

The HTML5 Geolocation Position options for locating.

more details
more detailsLocate
Boolean

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

more details
more detailsLocate
Graphic

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

more details
more detailsLocate
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
MapView | SceneView

A reference to the MapView or SceneView.

more details
more detailsLocate
LocateViewModel

The view model for this widget.

more details
more detailsLocate

Property Details

The ID or node representing the DOM element containing the widget. This property can only be set once.

declaredClassStringreadonly inherited

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

When true, this property indicates whether the widget has been destroyed.

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 the widget should navigate the view to the position and scale of the geolocated result.

Default Value: true

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
    })
  }
});

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the LocateViewModel class to access all properties and methods on the widget.

Method Overview

NameReturn TypeSummaryClass

Destroys the widget instance.

more details
more detailsWidget

Emits an event on the instance.

more details
more detailsWidget
Boolean

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

more details
more detailsWidget
Promise<Object>

Animates the view to the user's location.

more details
more detailsLocate
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Finalizes the creation of the widget.

more details
more detailsWidget

Method Details

destroy()inherited

Destroys the widget instance.

emit(type, event)protectedinherited

Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses that inherit from Evented.

Parameters:
type String

The name of the event.

event Object

The event payload.

hasEventListener(type){Boolean}inherited

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({
  view: view,
  container: "locateDiv"
});

locateWidget.locate().then(function(){
  // Fires after the user's location has been found
});

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

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);
});

own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
TypeDescription
ObjectThe rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

startup()inherited

Deprecated
  • since version 4.2.

Finalizes the creation of the widget.

Event Overview

NameTypeSummaryClass
{position: Object}

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

more details
more detailsLocate
{error: Error}

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

more details
more detailsLocate

Event Details

locate

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

Property:
position Object

Geoposition returned from the Geolocation API.

See also:

locate-error

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

Property:
error Error

The Error object that occurred while locating.

See also:

API Reference search results

NameTypeModule

There were no match results from your search criteria.