Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeocodeMatch

An individual match for a search.

Hierarchy

  • GeocodeMatch

Index

Constructors

constructor

Properties

boundingBox

boundingBox: BoundingBox

The bounding box for the match. Only present on region or postcode results.

country

country: Country

The country of the match.

formattedAddress

formattedAddress: string

A one-line address string formatted according to the local address format, not including the country name.

intersection

intersection: LatLon

The point where the match intersects with the street network. For non-street matches, this is the same as location.

location

location: LatLon

The display location of the match.

matchQuality

matchQuality: number

The quality of the match, as a value between 0-1 inclusive, where 1 is a match which perfectly matches the query, and 0 is a match which doesn't match the query at all.

Match quality only indicates how closely the match matches the query -- it doesn't indicate that the match is the desired one for the query. Match quality is relative to other matches from the same search, so the match quality for matches from different searches cannot be meaningfully compared.

matchType

matchType: GeocodeMatchType

postcode

postcode: string

The postcode the match lies in.

regions

regions: Region[]

An array containing the regions the match lies in, in ascending order of size.

streetName

streetName: string

The name of the street the match lies on.

streetNumber

streetNumber: string

The street number of the match.

units

units: AddressUnit[]

A list of unit information, or an empty array if none is available.

Methods

toJson

  • toJson(): Object
  • Returns Object

Generated using TypeDoc