Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GeocodeResult

Represents the data returned from the GeoStream server as the result of a forward geocoding operation. A forward geocode finds the location for a given address string. The result of a successful search. Contains a list of candidate matches, as well as the search status.

Hierarchy

  • GeocodeResult

Implements

Index

Constructors

constructor

  • Initializes a GeocodeResult object, which holds the information returned as part of a geocoding operation.

    Parameters

    Returns GeocodeResult

Properties

addressRanges

addressRanges: AddressRange[]

Gets the known street-number ranges for the result of this geocode. If this result is not a street, or if a specific street-number was provided as part of the search, null will be returned. If there is no known number data for this street, an empty array will be returned.

boundingBox

boundingBox: BoundingBox

A bounding box containing the resulting location.

components

components: string[]

An array of the different components that make up the geocoding result string, for example city, country.

confidence

confidence: number

The Geocoder's confidence in the result. The confidence is a decimal number between 0 and 1, with 1 representing the highest confidence.

confidenceScores

confidenceScores: ConfidenceScore

A set of confidence scores for the components of the location found via the forward geocoding operation. The scores are between 0.0 and 1.0 inclusive, with 1.0 indicating a perfect match between the location found and the actual location. The values are relative to other results returned from the same search.

country

country: string

The name of the country.

formattedAddress

formattedAddress: string

The address of the result location, excluding the country.

intersection

intersection: LatLon

A LatLon representing the point where the location connects with the street network.

location

location: LatLon

A LatLon representing the location of the result.

matchType

matchType: MatchType

The primary search method type that was used to find this result location.

matches

matches: GeocodeMatch[]

The candidate matches for the search, in descending order of confidence.

maxNumber

maxNumber: number

The maximum value of the range of street numbers between which this result location lies.

minNumber

minNumber: number

The minimum value of the range of street numbers between which this result location lies.

number

number: number

The street number of the location result.

status

The status of the search.

Static ASSEMBLY_NAME

ASSEMBLY_NAME: string = GEOBASE_ASSEMBLY_NAME

Static CLASS_NAME

CLASS_NAME: string = "Telogis.GeoBase.GeocodeAddress"

Methods

toAddressData

toJson

  • toJson(): Object
  • Returns Object

toString

  • toString(): string
  • Formats the geocoding result for display.

    Returns string

Generated using TypeDoc