import "@arcgis/map-components/components/arcgis-locate";
Locate component animates the View to the user's current location.
Demo
Properties
Property | Attribute | Type |
---|---|---|
auto-destroy-disabled | boolean | |
geolocation-options | any | |
go-to-location-disabled | boolean | |
| (((view: MapView | SceneView, goToParameters: GoToParameters) => void)) | |
| ||
icon | string | |
label | string | |
| {
componentLabel?: string | undefined;
title?: string | undefined;
currentLocation?: string | undefined;
timestamp?: string | undefined;
latitude?: string | undefined;
longitude?: string | undefined;
accuracy?: string | undefined;
altitude?: string | undefined;
altitudeAccuracy?: string | undefined;
heading?: string | undefined;
speed?: string | undefined;
permissionError?: string | undefined;
timeoutError?: string | undefined;
positionUnavailable?: string | undefined;
cancel?: string | undefined;
} | |
popup-disabled | boolean | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ArcgisLinkChart | ArcgisMap | ArcgisScene | string | |
scale | number | |
state readonly | state | "disabled" | "error" | "feature-unsupported" | "locating" | "ready" |
autoDestroyDisabled
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 temporary 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
geolocationOptions
geolocationOptions: any
An object used for setting optional position parameters.
- Attribute
- geolocation-options
- Default value
- null
goToLocationDisabled
goToLocationDisabled: boolean
Indicates 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: {
componentLabel?: string | undefined;
title?: string | undefined;
currentLocation?: string | undefined;
timestamp?: string | undefined;
latitude?: string | undefined;
longitude?: string | undefined;
accuracy?: string | undefined;
altitude?: string | undefined;
altitudeAccuracy?: string | undefined;
heading?: string | undefined;
speed?: string | undefined;
permissionError?: string | undefined;
timeoutError?: string | undefined;
positionUnavailable?: string | undefined;
cancel?: string | undefined;
}
Replace localized message strings with your own strings.
popupDisabled
popupDisabled: boolean
Indicates whether to display the Popup of the result graphic from the locate() method.
- Attribute
- popup-disabled
- Default value
- false
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: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
scale
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.
- Attribute
- scale
- Default value
- null
state
state: "disabled" | "error" | "feature-unsupported" | "locating" | "ready"
The current state of the component.
- Attribute
- state
- Default value
- "disabled"
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.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
LocateViewModelLocateErrorEvent | |
{ name: "state"; } | |
undefined | |
LocateLocateEvent |