AddressCandidate
esri/tasks/support/AddressCandidateProperty Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| address | String | Address of the candidate. more details | more details | AddressCandidate |
| attributes | Object | Name value pairs of field name and field value as defined in | more details | AddressCandidate |
| declaredClass | String | The name of the class. more details | more details | Accessor |
| extent | Extent | The minimum and maximum X and Y coordinates of a bounding box of the address candidate. more details | more details | AddressCandidate |
| location | Point | The Point object representing the location of the address. more details | more details | AddressCandidate |
| score | Number | Numeric score between | more details | AddressCandidate |
Property Details
- addressString
Address of the candidate.
- attributesObject
Name value pairs of field name and field value as defined in
outFieldsin Locator.addressToLocations().
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- extentExtent
The minimum and maximum X and Y coordinates of a bounding box of the address candidate.
- locationPoint
- scoreNumber
Numeric score between
0and100for geocode candidates. A candidate with a score of100means a perfect match, and0means no match.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| fromJSON() | * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | AddressCandidate |
| toJSON() | Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | AddressCandidate |
Method Details
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameter:json ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
Returns:Type Description * Returns a new instance of this class.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.
API Reference search results
| Name | Type | Module |
|---|