GeocodeResult

A match candidate returned from a LocatorTask geocode or reverse geocode operation. GeocodeResult provides information about the candidate, such as a collection of requested attribute values, user-friendly label text, and locations suited for accurate match display or for routing input.

Since

200.1.0

Properties

Link copied to clipboard

A collection of attributes as requested by GeocodeParameters.resultAttributeNames or ReverseGeocodeParameters.resultAttributeNames. Available attributes depend on the data stored with the locator, and can include things like place name, URL, phone number, and so on.

Link copied to clipboard

Location of the candidate suitable for display on a map. For example, this may provide a more precise rooftop location of a house, whereas GeocodeResult.routeLocation represents the nearest street location.

Link copied to clipboard

An extent suitable for zooming the map to display the candidate.

Link copied to clipboard

The Point provided as input to LocatorTask.reverseGeocode(Point). Only applicable for results of reverse-geocode operations.

Link copied to clipboard

User-friendly text that describes this result.

Link copied to clipboard

The nearest street location for the result. Use this location if you want to use the candidate as a stop in a route. For example, GeocodeResult.displayLocation may provide a more precise rooftop location of a house, whereas GeocodeResult.routeLocation will provide the nearest street location.

Link copied to clipboard

A value that indicates how well the address was matched. The score is in a range between 0 (no match) and 100 (perfect match).