require(["esri/widgets/Track"], (Track) => { /* code goes here */ });
import Track from "@arcgis/core/widgets/Track.js";
esri/widgets/Track
Provides a simple button that animates the View to the user's location when clicked. The view rotates based on device heading. While tracking, the default button looks like the following:
The default heading symbol will display when speed is greater than zero and the browser provides heading information:
You can use the view's DefaultUI to add widgets to the view's user interface via the ui property.
let trackWidget = new Track({
view: view
});
view.ui.add(trackWidget, "top-left");
The Track widget is only available in secure contexts, such as HTTPS. Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that support Window.isSecureContext.
For additional information regarding this, visit the ArcGIS blog, Increased Web API security in Google Chrome.
Known Limitations
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example// typical usage let track = new Track({ view: view });
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The ID or node representing the DOM element containing the widget. | Widget | ||
The name of the class. | Accessor | ||
An object used for setting optional position parameters. | Track | ||
Indicates whether the widget will automatically navigate the view to the user's position when a geolocation result is found. | Track | ||
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods. | Track | ||
The graphic used to show the user's location on the map. | Track | ||
Icon displayed in the widget's button. | Track | ||
The unique ID assigned to the widget when the widget is created. | Widget | ||
The widget's default label. | Track | ||
Indicates whether the widget will automatically rotate to the device heading based on the Geolocation APIs | Track | ||
Indicates the scale to set on the view when navigating to the position of the geolocated result, after a location is returned from the track event. | Track | ||
Indicates whether the widget is watching for new positions. | Track | ||
Track | |||
The viewModel for this widget. | Track | ||
Indicates whether the widget is visible. | Widget |
Property Details
-
container
InheritedPropertycontainer String |HTMLElement
Inherited from Widget -
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.
Examples// Create the HTML div element programmatically at runtime and set to the widget's container const basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div") }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
// Specify an already-defined HTML div element in the widget's container const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" }); // HTML markup <body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div> </body>
// Specify the widget while adding to the view's UI const basemapGallery = new BasemapGallery({ view: view }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
-
geolocationOptions
geolocationOptions Object
-
An object used for setting optional position parameters. Refer to the Geolocation API Specification for details on using these parameters.
- Default Value:null
Exampleconst track = new Track({ view: view, // Set optional position parameters geolocationOptions: { maximumAge: 0, timeout: 15000, enableHighAccuracy: true } });
-
goToLocationEnabled
goToLocationEnabled Boolean
-
Indicates whether the widget will automatically navigate the view to the user's position when a geolocation result is found. Set to
false
to disable this behavior, leaving full control to the developer.- Default Value:true
-
goToOverride
goToOverride GoToOverride
Since: ArcGIS Maps SDK for JavaScript 4.8Track since 4.0, goToOverride added at 4.8. -
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
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); };
-
The graphic used to show the user's location on the map. Overriding this will disable the default graphic's heading indicator.
Exampleconst trackWidget = new Track({ // Assign the track widget to a view view: view, // Overwrite the default symbol used for the // graphic placed at the location of the user graphic: new Graphic ({ symbol: { // autocasts as new SimpleMarkerSymbol() type: "simple-marker", size: "12px", color: "blue", // autocasts as new SimpleLineSymbol() outline: { color: "#efefef", width: "1.5px" } } }) });
-
icon
icon String
Since: ArcGIS Maps SDK for JavaScript 4.28Track since 4.0, icon added at 4.28. -
Icon displayed in the widget's button.
- Default Value:"compass-north-circle"
- See also
-
label
label String
Since: ArcGIS Maps SDK for JavaScript 4.7Track since 4.0, label added at 4.7. -
The widget's default label.
-
rotationEnabled
rotationEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.27Track since 4.0, rotationEnabled added at 4.27. -
Indicates whether the widget will automatically rotate to the device heading based on the Geolocation APIs
GeolocationCoordinates.heading
property. The map will not rotate if the speed is0
, or if the device is unable to provide heading information.Set to
false
to disable this behavior.- Default Value:true
-
scale
scale Number
Since: ArcGIS Maps SDK for JavaScript 4.7Track since 4.0, scale added at 4.7. -
Indicates the scale to set on the view when navigating to the position of the geolocated result, after a location is returned from the track event.
By default, the view will navigate to a scale of
2500
for 3D and4514
for 2D. To override the default in 2D, set thescale
property and also set snapToZoom tofalse
. For 2D views the value should be within the effectiveMinScale and effectiveMaxScale.- Default Value:null
Exampleconst mapView = new MapView({ map: map, container: "viewDiv", // Turn off snapToZoom constraints: { snapToZoom: false } }); mapView.when(() => { // Create an instance of the Track widget let track = new Track({ view: mapView, // Set a new default scale scale: 5000 }); // Add widget to the view's UI mapView.ui.add(track, "top-left"); });
-
tracking
tracking Booleanreadonly
-
Indicates whether the widget is watching for new positions.
- Default Value:false
-
viewModel
viewModel TrackViewModelautocast
-
The viewModel for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the TrackViewModel class to access all properties and methods on the widget.
-
visible
InheritedPropertyvisible Boolean
Inherited from Widget -
Indicates whether the widget is visible.
If
false
, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of"none"
.- Default Value:true
Example// Hides the widget in the view widget.visible = false;
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
A utility method used for building the value for a widget's | Widget | ||
Destroys the widget instance. | Widget | ||
Emits an event on the instance. | Widget | ||
Indicates whether there is an event listener on the instance that matches the provided event name. | Widget | ||
Returns true if a named group of handles exist. | Accessor | ||
| Widget | ||
| Widget | ||
| Widget | ||
Registers an event handler on the instance. | Widget | ||
Adds one or more handles which are to be tied to the lifecycle of the widget. | Widget | ||
Executes after widget is ready for rendering. | Widget | ||
Removes a group of handles owned by the object. | Accessor | ||
This method is implemented by subclasses for rendering. | Widget | ||
Renders widget to the DOM immediately. | Widget | ||
Schedules widget rendering. | Widget | ||
When executed, the widget will start tracking the user's location. | Track | ||
Stops tracking the user's location when executed. | Track | ||
| Widget |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
classes
InheritedMethodclasses(classNames){String}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.7Widget since 4.2, classes added at 4.7. -
A utility method used for building the value for a widget's
class
property. This aids in simplifying css class setup.ReturnsType Description String The computed class name. Example// .tsx syntax showing how to set css classes while rendering the widget render() { const dynamicClasses = { [css.flip]: this.flip, [css.primary]: this.primary }; return ( <div class={classes(css.root, css.mixin, dynamicClasses)} /> ); }
-
Inherited from Widget
-
Destroys the widget instance.
-
emit
InheritedMethodemit(type, event){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.5Widget since 4.2, emit added at 4.5. -
Emits an event on the instance. This method should only be used when creating subclasses of this class.
ReturnsType Description Boolean true
if a listener was notified
-
hasEventListener
InheritedMethodhasEventListener(type){Boolean}
Inherited from Widget -
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
isFulfilled
InheritedMethodisFulfilled(){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, isFulfilled added at 4.19. -
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected
InheritedMethodisRejected(){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, isRejected added at 4.19. -
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved
InheritedMethodisResolved(){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, isResolved added at 4.19. -
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
on
InheritedMethodon(type, listener){Object}
Inherited from Widget -
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersReturnsType Description Object Returns an event handler with a remove()
method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
Inherited from Widget
Since: ArcGIS Maps SDK for JavaScript 4.24Widget since 4.2, own added at 4.24. Deprecated since 4.28 Use addHandles() instead. -
Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.
const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true} ); this.own(handle); // Handle gets removed when the widget is destroyed.
ParameterhandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
Inherited from Widget
-
Executes after widget is ready for rendering.
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Inherited from Widget
-
Renders widget to the DOM immediately.
-
Inherited from Widget
-
Schedules widget rendering. This method is useful for changes affecting the UI.
-
When executed, the widget will start tracking the user's location. Only start the widget on a user gesture such as a click event.
-
when
InheritedMethodwhen(callback, errback){Promise}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, when added at 4.19. -
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.ParametersReturnsType Description Promise Returns a new Promise for the result of callback
.Example// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way let bmGallery = new BasemapGallery(); bmGallery.when(function(){ // This function will execute once the promise is resolved }, function(error){ // This function will execute if the promise is rejected due to an error });
Event Overview
Name | Type | Summary | Class |
---|---|---|---|
|
{position: Object} |
Fires after the start() method is called and a position is found. |
Track |
|
{error: Error} |
Fires after the start() method is called and an error is returned. |
Track |
Event Details
-
Fires after the start() method is called and a position is found.
- Property
-
position Object
Geolocation coordinates returned from the Geolocation API.
Exampletrack.on("track", ({ position }) => { const { longitude, latitude } = position.coords; console.log("Track", `${longitude.toFixed(4)}, ${latitude.toFixed(4)}`); });