GeocodeResult QML Type
|Import Statement:||import Esri.ArcGISRuntime|
- attributes : jsobject
- displayLocation : Point
- extent : Envelope
- inputLocation : Point
- label : string
- routeLocation : Point
- score : double
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.
Geocoding takes an address or place name, and converts it into real-world coordinates. Reverse geocoding does the opposite, and converts real-world coordinates into an address or place name. These operations are available on the LocatorTask class. Obtain this result from the LocatorTask::geocodeResults property once the LocatorTask::geocodeStatusChanged signal emits, and the LocatorTask::geocodeStatus is
Note: You cannot declare or create a component of this type in QML code.
[read-only] attributes : jsobject
Returns the attributes of the GeocodeResult (read-only).
Available attributes depend on the data stored with the locator, and can include things like place name, URL, phone number, and so on.
[read-only] displayLocation : Point
Location of the candidate suitable for display on a map (read-only).
For example, this may provide a more precise rooftop location of a house, whereas GeocodeResult.routeLocation represents the nearest street location.
[read-only] extent : Envelope
An extent suitable for zooming the map to display the candidate (read-only).
The extent can be used for setting the viewpoint of the map view to the geocode result.
[read-only] inputLocation : Point
[read-only] label : string
Returns the label of the GeocodeResult (read-only).
User-friendly text that describes this result.
[read-only] routeLocation : Point
Returns the nearest street location for the result (read-only).
For example, if searching for a park, the returned point would be near the entrance point to the park.
[read-only] score : double
A value that indicates how well the address was matched (read-only).
The score is in a range between 0 (no match) and 100 (perfect match).
See also GeocodeParameters::minScore.