import "@arcgis/map-components/components/arcgis-locate";The Locate component animates the Map or Scene to the user's current location.
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.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
| PositionOptions | |
go-to-location-disabled | boolean | |
| (((view: MapView | SceneView, goToParameters: GoToParameters) => void)) | |
| ||
icon | string | |
label | string | |
| Record<string, unknown> | |
popup-disabled | boolean | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
scale | number | |
state | "disabled" | "error" | "feature-unsupported" | "locating" | "ready" |
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
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))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"
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
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" | "locating" | "ready"The current state of the component.
- Attribute
- state
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ error: GeolocationPositionError; }> | |
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> | |
CustomEvent<{ position: GeolocationPosition; }> |
arcgisError
arcgisError: CustomEvent<{ error: GeolocationPositionError; }>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.
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.
arcgisSuccess
arcgisSuccess: CustomEvent<{ position: GeolocationPosition; }>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 |
|---|---|
cancelLocate(): Promise<void> | |
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
locate(): Promise<GeolocationPosition | null> |
cancelLocate
cancelLocate(): Promise<void>This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device.
- Returns
- Promise<void>
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisLocate = document.querySelector("arcgis-locate");
document.body.append(arcgisLocate);
await arcgisLocate.componentOnReady();
console.log("arcgis-locate is ready to go!");- Returns
- Promise<void>