Locate

Use dark colors for code blocksCopy
import "@arcgis/map-components/components/arcgis-locate";

Locate component animates the View to the user's current location.

Demo

Properties

Property	Attribute	Type
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`geolocationOptions`	`geolocation-options`	`any`
`goToLocationDisabled`	`go-to-location-disabled`	`boolean`
`goToOverride`		`(((view: MapView \| SceneView, goToParameters: GoToParameters) => void))`
`graphic`		`Graphic`
`icon`	`icon`	`string`
`label`	`label`	`string`
`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; }
`popupDisabled`	`popup-disabled`	`boolean`
`position`	`position`	`"bottom-leading" \| "bottom-left" \| "bottom-right" \| "bottom-trailing" \| "manual" \| "top-leading" \| "top-left" \| "top-right" \| "top-trailing"`
`referenceElement`	`reference-element`	`ArcgisLinkChart \| ArcgisMap \| ArcgisScene \| string`
`scale`	`scale`	`number`
`state` readonly	`state`	`"disabled" \| "error" \| "feature-unsupported" \| "locating" \| "ready"`

autoDestroyDisabled

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 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

Property

geolocationOptions: any

An object used for setting optional position parameters.

Attribute: geolocation-options
Default value: null

goToLocationDisabled

Property

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

Property

goToOverride: (((view: MapView | SceneView, goToParameters: GoToParameters) => void))

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

graphic

Property

graphic: Graphic

The graphic used to show the user's location on the map.

icon

Property

icon: string

Attribute: icon
Default value: "gps-off"

label

Property

label: string

The component's default label.

Attribute: label

messageOverrides

Property

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

Property

popupDisabled: boolean

Indicates whether to display the Popup of the result graphic from the locate() method.

Attribute: popup-disabled
Default value: false

position

Property

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

Property

referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string

Attribute: reference-element

scale

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.

Attribute: scale
Default value: null

state

readonly

Property

state: "disabled" | "error" | "feature-unsupported" | "locating" | "ready"

The current state of the component.

Attribute: state
Default value: "disabled"

Methods

Method	Signature
`cancelLocate`	`cancelLocate(): Promise<void>`
`componentOnReady`	`componentOnReady(): Promise<void>`
`destroy`	`destroy(): Promise<void>`
`locate`	`locate(): Promise<GeolocationPosition \| null>`

cancelLocate

Method

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

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns: Promise<void>

destroy

Method

destroy(): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

locate

Method

locate(): Promise<GeolocationPosition | null>

Returns: Promise<GeolocationPosition | null>

Events

Event	Type
`arcgisError`	`LocateViewModelLocateErrorEvent`
`arcgisPropertyChange`	`{ name: "state"; }`
`arcgisReady`	`undefined`
`arcgisSuccess`	`LocateLocateEvent`

arcgisError

Event

arcgisError: LocateViewModelLocateErrorEvent

Emitted when an error occurs.

arcgisPropertyChange

Event

arcgisPropertyChange: { name: "state"; }

Emitted when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event

arcgisReady: undefined

Emitted when the component associated with a map view is is ready to be interacted with.

arcgisSuccess

Event

arcgisSuccess: LocateLocateEvent