Use dark colors for code blocks Copy
1
import "@arcgis/map-components/components/arcgis-locate";No specific import is needed for this component.
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 autoDestroyDisabledProperty
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
geolocationOptions: PositionOptions
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))
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.
Property
popupDisabled: boolean
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
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
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" | "locating" | "ready"
The current state of the component.
No slots to display.
Events arcgisErrorEvent
arcgisError: CustomEvent<{ error: GeolocationPositionError; }> 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.
arcgisSuccessEvent
arcgisSuccess: CustomEvent<{ position: GeolocationPosition; }> 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.
Methods cancelLocateMethod
cancelLocate(): Promise<void>
This function provides the ability to interrupt and cancel the process of programmatically obtaining the location of the user's device.
Method
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 arcgisLocate = document.querySelector("arcgis-locate");
document.body.append(arcgisLocate);
await arcgisLocate.componentOnReady();
console.log("arcgis-locate is ready to go!");Method
destroy(): Promise<void>
Permanently destroy the component.
Method
locate(): Promise<GeolocationPosition | null>
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