// This graphics layer will store the graphic used to display the user's location
var gl = new GraphicsLayer();
map.add(gl);

var locateWidget = new Locate({
  view: view,   // Attaches the Locate button to the view
  graphicsLayer: gl  // The layer the locate graphic is assigned to
});

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

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

Property Overview

Property Details

containerString|HTMLElement

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

declaredClassStringreadonly

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

destroyedBoolean

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

graphicGraphic autocast

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: Graphic({
      symbol: new SimpleMarkerSymbol()  // overwrites the default symbol used for the
      // graphic placed at the location of the user when found
    })
  }
});

idString

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.

viewMapView|SceneView

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

viewModelLocateViewModel autocast

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

Method Details

destroy()inherited

Destroys the widget instance.

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:

Type	Description
Boolean	Returns true if the class supports the input event.

locate(){Promise}

Animates the view to the user's location.

Returns:

Type	Description
Promise	Resolves to an object with the same specification as the event object defined in the locate event.

Example:

var locateWidget = new Locate({
  view: view
}, "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:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

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 Handle[] @type - handles to remove when 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:

Type	Description
Object	The 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

{position: Object}

{error: Error}

Event Details

locate

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

Property:

position Object Geoposition returned from the Geolocation API.

See also:

• locate()

locate-error

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

Property:

error Error The Error object that occurred while locating.

See also:

• locate()