Interface ForwardGeocodeInput

Input for forwardGeocode.

Hierarchy

  • ForwardGeocodeInput

Properties

query: string

Address, place name, or other free-form text to resolve into coordinates.

maxResults?: number

Maximum number of matches to return. Optional; defaults to 1 and is clamped to the inclusive range [1, 10].

locale?: string

Optional BCP-47 language tag (e.g. "pt-BR", "en-US") used to localise the returned address fields. When omitted, the device's current locale is used.

Generated using TypeDoc