Track

import Track from "@arcgis/core/widgets/Track.js";

Inheritance:: Track→Widget→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

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:

track-button

The default heading symbol will display when speed is greater than zero and the browser provides heading information:

heading-indicator

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

The heading symbol is not currently supported in 3D SceneViews.
The Track widget does not work concurrently with the Locate widget. Only one of the widgets can be used at a time.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`TrackProperties`

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

Example

// typical usage
let track = new Track({
  view: view
});

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`container` inherited	`HTMLElement \| null \| undefined`	Widget
`declaredClass` readonly inherited	`string`	Accessor
`destroyed` readonly inherited	`boolean`	Widget
`geolocationOptions`	`PositionOptions \| null \| undefined`
`goToLocationEnabled`	`boolean`
`goToOverride`	`GoToOverride \| null \| undefined`
`graphic`	`Graphic`
`icon`	`Icon["icon"]`
`id` inherited	`string`	Widget
`label`	`string`
`rotationEnabled`	`boolean`
`scale`	`number \| null \| undefined`
`tracking` readonly	`boolean`
`view`	`MapViewOrSceneView \| null \| undefined`
`viewModel`	`TrackViewModel`
`visible` inherited	`boolean`	Widget

container

autocast inherited Property

Type: HTMLElement | null | undefined

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

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

destroyed

readonlyinherited Property

Type: boolean

Inherited from: Widget

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

geolocationOptions

Property

Type: PositionOptions | null | undefined

An object used for setting optional position parameters. Refer to the Geolocation API Specification for details on using these parameters.

Example

const track = new Track({
  view: view,
  // Set optional position parameters
  geolocationOptions: {
    maximumAge: 0,
    timeout: 15000,
    enableHighAccuracy: true
  }
});

goToLocationEnabled

Property

Type: 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

Property

Type: GoToOverride | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.8

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

See also

Example

// The following snippet uses Search 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);
};

graphic

autocast Property

Type: Graphic

The graphic used to show the user's location on the map. Overriding this will disable the default graphic's heading indicator.

Example

const 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

autocast Property

Type: Icon["icon"]

Since: ArcGIS Maps SDK for JavaScript 4.28

Icon displayed in the widget's button.

See also

Default value: "compass-north-circle"

id

inherited Property

Type: string

Inherited from: Widget

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.

label

autocast Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 4.7

The widget's default label.

rotationEnabled

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 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 is 0, or if the device is unable to provide heading information.

Set to false to disable this behavior.

Default value: true

scale

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 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 and 4514 for 2D. To override the default in 2D, set the scale property and also set snapToZoom to false. For 2D views the value should be within the effectiveMinScale and effectiveMaxScale.

Example

const 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

readonly Property

Type: boolean

Indicates whether the widget is watching for new positions.

Default value: false

view

Property

Type: MapViewOrSceneView | null | undefined

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

viewModel

autocast Property

Type: TrackViewModel

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

inherited Property

Type: 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 DefaultUI, 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;

Methods

Method	Signature	Class
`classes` inherited	`classes(...classNames: ((string \| null \| undefined) \| ((string[] \| Record<string, boolean>) \| null \| undefined) \| false \| null \| undefined)[]): string`	Widget
`destroy` inherited	`destroy(): void`	Widget
`emit` inherited	`emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean`	EventedMixin
`hasEventListener` inherited	`hasEventListener<Type extends EventNames<this>>(type: Type): boolean`	EventedMixin
`isFulfilled` inherited	`isFulfilled(): boolean`	EsriPromiseMixin
`isRejected` inherited	`isRejected(): boolean`	EsriPromiseMixin
`isResolved` inherited	`isResolved(): boolean`	EsriPromiseMixin
`on` inherited	`on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle`	EventedMixin
`postInitialize` inherited	`postInitialize(): void`	Widget
`render` inherited	`render(): any \| null`	Widget
`renderNow` inherited	`renderNow(): void`	Widget
`scheduleRender` inherited	`scheduleRender(): void`	Widget
`start`	`start(): void`
`stop`	`stop(): void`
`when` inherited	`when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> \| null \| undefined, onRejected?: OnRejectedCallback<TResult2> \| null \| undefined): Promise<TResult1 \| TResult2>`	EsriPromiseMixin

classes

inherited Method

Signature: classes (...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string

Inherited from: Widget

Since: ArcGIS Maps SDK for JavaScript 4.7

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Parameters

Parameter	Type	Description	Required
classNames	`((string \| null \| undefined) \| ((string[] \| Record<string, boolean>) \| null \| undefined) \| false \| null \| undefined)[]`	The class names.

Returns: 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)} />
  );
}

destroy

inherited Method

Signature: destroy (): void

Inherited from: Widget

Destroys the widget instance.

Returns: void

emit

inherited Method

Signature: emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Since: ArcGIS Maps SDK for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

Parameter	Type	Description	Required
type	`Type`	The name of the event.
event	`this["@eventTypes"][Type]`	The event payload.

Returns: boolean
true if a listener was notified

hasEventListener

inherited Method

Signature: hasEventListener <Type extends EventNames<this>>(type: Type): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

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

Parameters

Parameter	Type	Description	Required
type	`Type`	The name of the event.

Returns: boolean
Returns true if the class supports the input event.

isFulfilled

inherited Method

Signature: isFulfilled (): boolean

Inherited from: EsriPromiseMixin

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.

Returns: boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected

inherited Method

Signature: isRejected (): boolean

Inherited from: EsriPromiseMixin

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been rejected.

isResolved

inherited Method

Signature: isResolved (): boolean

Inherited from: EsriPromiseMixin

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been resolved.

on

inherited Method

Signature: on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

Parameter	Type	Description	Required
type	`Type`	An event or an array of events to listen for.
listener	`EventedCallback<this["@eventTypes"][Type]>`	The function to call when the event fires.

Returns

ResourceHandle

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.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

postInitialize

inherited Method

Signature: postInitialize (): void

Inherited from: Widget

Executes after widget is ready for rendering.

Returns: void

render

inherited Method

Signature: render (): any | null

Inherited from: Widget

This method is implemented by subclasses for rendering.

Returns: any | null
The rendered virtual node.

renderNow

inherited Method

Signature: renderNow (): void

Inherited from: Widget

Renders widget to the DOM immediately.

Returns: void

scheduleRender

inherited Method

Signature: scheduleRender (): void

Inherited from: Widget

Schedules widget rendering. This method is useful for changes affecting the UI.

Returns: void

start

Method

Signature: start (): void

When executed, the widget will start tracking the user's location. Only start the widget on a user gesture such as a click event.

Returns: void

stop

Method

Signature: stop (): void

Stops tracking the user's location when executed.

Returns: void

when

inherited Method

Signature: when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>

Type parameters: <TResult1 = this, TResult2 = never>

Inherited from: EsriPromiseMixin

Since: ArcGIS Maps SDK for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function. The onFulfilled executes when the instance of the class loads. The onRejected executes if the instance of the class fails to load.

Parameters

Parameter	Type	Description	Required
onFulfilled	`OnFulfilledCallback<this, TResult1> \| null \| undefined`	The function to call when the promise resolves.
onRejected	`OnRejectedCallback \| null \| undefined`	The function to execute when the promise fails.

Returns: Promise<TResult1 | TResult2>
Returns a new promise for the result of onFulfilled that may be used to chain additional functions.

Example

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.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
});

Events

Name	Type
`track` inherited	CustomEvent<TrackViewModelTrackEvent>
`track-error` inherited	CustomEvent<TrackViewModelTrackErrorEvent>

inherited Event

track: CustomEvent<TrackViewModelTrackEvent>

Inherited from: TrackViewModelEvents

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

Example

track.on("track", ({ position }) => {
  const { longitude, latitude } = position.coords;
  console.log("Track", `${longitude.toFixed(4)}, ${latitude.toFixed(4)}`);
});

track-error

inherited Event

track-error: CustomEvent<TrackViewModelTrackErrorEvent>

Inherited from: TrackViewModelEvents

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

Constructors

Parameters

Example

Properties

Examples

Example

Example

Example

Example

Example

Methods

Parameters

Example

Parameters

Parameters

Parameters

Example

Parameters

Example

Events

Example

Type definitions