var locateWidget = new Locate({
  viewModel: { // autocasts as new LocateViewModel()
    view: view   // attaches the Locate button to the view
  }
}, "locateDiv");

Property Overview

Property Details

declaredClassStringreadonly

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

stateStringreadonly

The current state of the widget.

Possible Values: disabled | ready | locating

Default Value: disabled

viewMapView|SceneView

The view associated with the widget.

Method Overview

Method Details

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.

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({
  viewModel: { // autocasts as new LocateViewModel()
    view: view
  }
}, "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. 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);
});

Event Overview

{error: Error}

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:

• locate()