Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: AddressCandidate
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/AddressCandidate"], function(AddressCandidate) { /* code goes here */ });
Description
(Added at v1.0)
Represents an address and its location. AddressCandidate has no constructor.Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| address | Object | Address of the candidate. |
| attributes | Object | Name value pairs of field name and field value as defined in outFields in Locator.addressToLocations. |
| location | Point | X- and y-coordinate of the candidate. |
| score | Number | Numeric score between 0 and 100 for geocode candidates. |
Property Details
<Object
ObjectAddress of the candidate. It contains one property for each of the address fields defined by a geocode service. Each address field describes some part of the address information for the candidate.
<Object
ObjectName value pairs of field name and field value as defined in outFields in Locator.addressToLocations.
<Point
PointX- and y-coordinate of the candidate.
<Number
NumberNumeric score between 0 and 100 for geocode candidates. A candidate with a score of 100 means a perfect match, and 0 means no match.
Sample:
require([
"dojo/_base/array", ...
], function(array, ... ) {
array.forEach(addressCandidates, function(candidate) {
if (candidate.score > score && candidate.attributes.Loc_name === "US_RoofTop") {
stop = candidate;
score = candidate.score;
}
});
...
});