Class: AddressCandidateE-mail This Topic Printable Version Give Us Feedback

Description

Represents an address and its location. AddressCandidate has no constructor.

Class hierarchy

esri.tasks.AddressCandidate

Properties

Property Type Description
address Object Address 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.
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. A candidate with a score of 100 means a perfect match, and 0 means no match.
Properties Detail

<Object> address

Address 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> attributes

Name value pairs of field name and field value as defined in outFields in Locator.addressToLocations.

<Point> location

X- and y-coordinate of the candidate.

<Number> score

Numeric score between 0 and 100 for geocode candidates. A candidate with a score of 100 means a perfect match, and 0 means no match.
Code snippets:
 dojo.forEach(addressCandidates, function(candidate) {
  if (candidate.score > score && candidate.attributes.Loc_name === "US_RoofTop") {
    stop = candidate;
    score = candidate.score;
  }
 });