SearchAddressResultItem interface

Package:

@azure/maps-search

Result object for a Search API response.

Properties

address	The address of the result
addressRanges	Describes the address range on both sides of the street for a search result.
dataSources	Reference geometry id for use with the Get Search Polygon API.
detourTimeInSeconds	Detour time in seconds. Only returned for calls to the Search Along Route API.
distanceInMeters	Straight line distance between the result and geobias location in meters.
entityType	Entity type of the search result. Only present if type == Geography.
entryPoints	Array of EntryPoints. Those describe the types of entrances available at the location.
id	Id property
info	Information about the original data source of the Result. Used for support requests.
matchType	Information on the type of match.
pointOfInterest	Details of the returned POI including information such as the name, phone, url address, and classifications.
position	A location represented as a latitude and longitude using short names 'lat' & 'lon'.
score	The value within a result set to indicate the relative matching score between results.
type	Result type
viewport	The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.

Property Details

address

The address of the result

address: Address

Property Value

Address

addressRanges

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

addressRanges?: AddressRanges

Property Value

AddressRanges

dataSources

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

dataSources?: DataSource

Property Value

DataSource

detourTimeInSeconds

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

detourTimeInSeconds?: number

Property Value

number

distanceInMeters

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

distanceInMeters?: number

Property Value

number

entityType

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

entityType?: string

Property Value

string

entryPoints

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

entryPoints?: EntryPoint[]

Property Value

EntryPoint[]

id

Id property

id: string

Property Value

string

info

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

info?: string

Property Value

string

matchType

Information on the type of match.

matchType?: string

Property Value

string

pointOfInterest

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

pointOfInterest?: PointOfInterest

Property Value

PointOfInterest

position

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

position: LatLon

Property Value

LatLon

score

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

score: number

Property Value

number

type

Result type

type: string

Property Value

string

viewport

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

viewport: BoundingBox

Property Value

BoundingBox