Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-track";No specific import is needed for this component.
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
Property
autoDestroyDisabled: boolean
If 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.
Property
error: any
Error that caused the last track-error event to fire.
Property
geolocationOptions: any
An object used for setting optional position parameters.
goToLocationDisabled: boolean
Indicates whether to navigate the view to the position and scale of the geolocated result.
Property
goToOverride: (((view: MapView | SceneView, goToParameters: GoToParameters) => void))
This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
Property
The graphic used to show the user's location on the map.
Property
icon: string
Property
label: string
The component's default label.
Property
messageOverrides: Record<string, unknown>
Replace localized message strings with your own strings.
Note: Individual message keys may change between releases.
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Property
positionFilterFunction: Function
A function that is used as an expression to evaluate geolocation points, and returns a boolean value.
Property
By 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.
Property
rotationDisabled: boolean
Indicates whether the component will automatically rotate to the device heading based on the Geolocation APIs GeolocationCoordinates.heading property.
Property
scale: number
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.
state: "disabled" | "error" | "feature-unsupported" | "ready" | "tracking" | "waiting"
The current state of the component.
readonlyProperty
tracking: boolean
Indicates whether new positions are being watched.
No slots to display.
Events arcgisCompleteEvent
arcgisComplete: TrackViewModelTrackEvent bubbles
Events triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisErrorEvent
arcgisError: TrackViewModelTrackErrorEvent bubbles
Events triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisPropertyChangeEvent
arcgisPropertyChange: CustomEvent<{ name: "state"; }>
Emitted when the value of a property is changed. Use this to listen to changes to properties.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReadyEvent
arcgisReady: CustomEvent<void>
Emitted when the component associated with a map or scene view is is ready to be interacted with.
bubblesEvents triggered on this element will be propagated to their outermost elements.
composedThe event is composable and will propagate across the shadow DOM into the standard DOM.
cancelableThe event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods componentOnReadyMethod
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
ExampleUse dark colors for code blocks Copy
1
2
3
4
const arcgisTrack = document.querySelector("arcgis-track");
document.body.append(arcgisTrack);
await arcgisTrack.componentOnReady();
console.log("arcgis-track is ready to go!");Method
destroy(): Promise<void>
Permanently destroy the component.
Method
start(): Promise<void>
Start tracking the user's location. Only start the component on a user gesture such as a click event.
Method
stop(): Promise<void>
Stop tracking the user's location.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4