import "@arcgis/map-components/components/arcgis-track";The Track component is a button that when activated continuously animates the Map or Scene to the user's location as the user moves. The view rotates based on device heading, and the default heading symbol will display when speed is greater than zero and the browser provides heading information.
This component uses the browser's Geolocation API which 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.
Known limitations
- The heading symbol is not currently supported within a Scene component.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
error | any | |
geolocation-options | any | |
go-to-location-disabled | boolean | |
| (((view: MapView | SceneView, goToParameters: GoToParameters) => void)) | |
| ||
icon | string | |
label | string | |
| Record<string, unknown> | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
| Function | |
reference-element | ||
rotation-disabled | boolean | |
scale | number | |
statereadonly | state | "disabled" | "error" | "feature-unsupported" | "ready" | "tracking" | "waiting" |
trackingreadonly | | boolean |
autoDestroyDisabled
autoDestroyDisabled: booleanIf true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.
- Attribute
- auto-destroy-disabled
- Default value
- false
error
error: anyError that caused the last track-error event to fire.
- Attribute
- error
- Default value
- null
geolocationOptions
geolocationOptions: anyAn object used for setting optional position parameters.
- Attribute
- geolocation-options
- Default value
- null
goToLocationDisabled
goToLocationDisabled: booleanIndicates whether to navigate the view to the position and scale of the geolocated result.
- Attribute
- go-to-location-disabled
- Default value
- false
goToOverride
goToOverride: (((view: MapView | SceneView, goToParameters: GoToParameters) => void))This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
messageOverrides
messageOverrides: Record<string, unknown>Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"- Attribute
- position
- Default value
- "top-left"
positionFilterFunction
positionFilterFunction: FunctionA function that is used as an expression to evaluate geolocation points, and returns a boolean value.
- Default value
- null
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
- Attribute
- reference-element
rotationDisabled
rotationDisabled: booleanIndicates whether the component will automatically rotate to the device heading based on
the Geolocation APIs GeolocationCoordinates.heading
property.
- Attribute
- rotation-disabled
- Default value
- false
scale
scale: numberIndicates 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.
- Attribute
- scale
- Default value
- null
state
state: "disabled" | "error" | "feature-unsupported" | "ready" | "tracking" | "waiting"The current state of the component.
- Attribute
- state
- Default value
- "disabled"
tracking
tracking: booleanIndicates whether new positions are being watched.
- Default value
- false
Slots
Events
| Event | Type |
|---|---|
TrackViewModelTrackEvent | |
TrackViewModelTrackErrorEvent | |
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> |
arcgisComplete
arcgisComplete: TrackViewModelTrackEventEvents triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisError
arcgisError: TrackViewModelTrackErrorEventEvents triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
start(): Promise<void> | |
stop(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisTrack = document.querySelector("arcgis-track");
document.body.append(arcgisTrack);
await arcgisTrack.componentOnReady();
console.log("arcgis-track is ready to go!");- Returns
- Promise<void>