Interface GeocodingPlace

A single geocoded place returned by forwardGeocode or reverseGeocode.

Every field other than latitude and longitude is optional, because the underlying native geocoder may not populate them depending on the input and the locale.

Hierarchy

  • GeocodingPlace

Properties

latitude longitude name? street? subLocality? locality? subAdministrativeArea? administrativeArea? postalCode? country? countryCode? formattedAddress?

Properties

latitude

latitude: number

Latitude in decimal degrees.

longitude

longitude: number

Longitude in decimal degrees.

Optional name

name?: string

Short, human-readable name for the place (e.g. "Googleplex").

Optional street

street?: string

Street/thoroughfare (e.g. "Amphitheatre Pkwy").

Optional subLocality

subLocality?: string

Sub-locality such as a neighbourhood or district.

Optional locality

locality?: string

Locality, typically a city or town.

Optional subAdministrativeArea

subAdministrativeArea?: string

Sub-administrative area, typically a county.

Optional administrativeArea

administrativeArea?: string

Administrative area, typically a state or province.

Optional postalCode

postalCode?: string

Postal/ZIP code.

Optional country

country?: string

Country name (localised when locale is provided).

Optional countryCode

countryCode?: string

ISO 3166-1 alpha-2 country code (e.g. "US", "BR").

Optional formattedAddress

formattedAddress?: string

Best-effort, human-readable, localised single-line address. Field order is locale-aware (each platform's native formatter picks the right order for the locale). Not machine-parseable — use the structured fields above for that.

changelog

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc