Package version:

Interface SearchAddressResultItem

Result object for a Search API response.

Hierarchy

  • SearchAddressResultItem

Properties

address: Address

The address of the result

addressRanges?: AddressRanges

Describes the address range on both sides of the street for a search result.

dataSources?: DataSource

Reference geometry id for use with the Get Search Polygon API.

detourTimeInSeconds?: number

Detour time in seconds. Only returned for calls to the Search Along Route API.

distanceInMeters?: number

Straight line distance between the result and geobias location in meters.

entityType?: string

Entity type of the search result. Only present if type == Geography.

entryPoints?: Object

Array of EntryPoints. Those describe the types of entrances available at the location.

id: string

Id property

info?: string

Information about the original data source of the Result. Used for support requests.

matchType?: string

Information on the type of match.

pointOfInterest?: PointOfInterest

Details of the returned POI including information such as the name, phone, url address, and classifications.

position: LatLon

A location represented as a latitude and longitude using short names 'lat' & 'lon'.

score: number

The value within a result set to indicate the relative matching score between results.

type: string

Result type

viewport: BoundingBox

The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.

Generated using TypeDoc