Class LocatorCompat

constructor

• new LocatorCompat(options?: string | LocatorCompatOptions): LocatorCompat

  Parameters

  • options: string | LocatorCompatOptions = {}

  Returns LocatorCompat

ReadonlyapiKey

ReadonlycapabilityPolicy

ReadonlyeventBus

ReadonlyextentPaddingDegrees

loaded

loadStatus

ReadonlymaxLocations

provider

ReadonlyrequestOptions

Readonlyurl

supportsSuggest

• get supportsSuggest(): boolean

  true when the configured provider declares the suggest capability.

  Returns boolean

addressesToLocations

• addressesToLocations(
      params?: AddressesToLocationsParamsCompat,
  ): Promise<LocatorAddressCandidateCompat[]>

  Client-side batch geocode. ArcGIS addressesToLocations posts one batch to a locator; the provider contract has no batch endpoint, so each address is geocoded individually and the best candidate is returned with ResultID carried through from OBJECTID.

  Parameters

  • params: AddressesToLocationsParamsCompat = {}

  Returns Promise<LocatorAddressCandidateCompat[]>

addressToLocations

• addressToLocations(
      params?: AddressToLocationsParamsCompat,
  ): Promise<LocatorAddressCandidateCompat[]>

  Forward-geocode a single address into ArcGIS-shaped candidates.

  Parameters

  • params: AddressToLocationsParamsCompat = {}

  Returns Promise<LocatorAddressCandidateCompat[]>

destroy

• destroy(): void

  Returns void

load

• load(): Promise<LocatorCompat>

  Returns Promise<LocatorCompat>

locationToAddress

• locationToAddress(
      params?: LocationToAddressParamsCompat,
  ): Promise<LocatorAddressCandidateCompat>

  Reverse-geocode a point. Mirrors ArcGIS by rejecting when the provider finds no address rather than resolving to null.

  Parameters

  • params: LocationToAddressParamsCompat = {}

  Returns Promise<LocatorAddressCandidateCompat>

suggestLocations

• suggestLocations(
      params?: SuggestLocationsParamsCompat,
  ): Promise<LocatorSuggestionCompat[]>

  Typeahead suggestions. Providers without the suggest capability throw HonuaCapabilityNotSupportedError under "strict" and resolve to [] under "degraded" — the miss is never faked with a forward geocode.

  Parameters

  • params: SuggestLocationsParamsCompat = {}

  Returns Promise<LocatorSuggestionCompat[]>

toSearchSource

• toSearchSource(
      options?: Omit<LocatorSearchSourceCompatOptions, "locator">,
  ): LocatorSearchSourceCompat

  Project this locator as a SearchCompat source — the honua-maplibre replacement for the ArcGIS LocatorSearchSource Search backend.

  Parameters

  • options: Omit<LocatorSearchSourceCompatOptions, "locator"> = {}

  Returns LocatorSearchSourceCompat

watch

• watch(
      propertyName: string,
      listener: (value: unknown) => void,
  ): LocatorHandleCompat

  Parameters

  • propertyName: string
  • listener: (value: unknown) => void

  Returns LocatorHandleCompat

when

• when(callback?: (locator: LocatorCompat) => void): Promise<LocatorCompat>

  Parameters

  • Optionalcallback: (locator: LocatorCompat) => void

  Returns Promise<LocatorCompat>