var trackWidget = new Track({
  viewModel: {  // autocasts as new TrackViewModel()
    view: view,   // attaches the Track to the view
  }
}, "trackDiv");

Property Overview

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

goToOverrideGoToOverride

Since: ArcGIS API for JavaScript 4.8

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

See also:

• MapView
• SceneView

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

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 | tracking | waiting

Default Value:disabled

trackingBooleanreadonly

Indicates whether new positions are being watched.

Default Value:false

viewMapView|SceneView

The view associated with the widget.

Method Overview

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:

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

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:

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

start()

When executed, tracking starts at the user's location.

stop()

Stops tracking the user's location when executed.

Event Overview

{position: Object}

{error: Error}

Event Details

track

Fires after the start() method is called and a position is found.

Property:

position Object Geoposition returned from the Geolocation API.

track-error

Fires after the start() method is called and an error is returned.

Property:

error Error The Error object returned if an error occurred while tracking.