AddressCandidate

Class: esri/tasks/support/AddressCandidate
Inheritance: AddressCandidate Accessor
Since: ArcGIS API for JavaScript 4.0

Represents an address and its location.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

Address of the candidate.

more details
more detailsAddressCandidate
Object

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

more details
more detailsAddressCandidate
String

The name of the class.

more details
more detailsAccessor
Extent

The minimum and maximum X and Y coordinates of a bounding box of the address candidate.

more details
more detailsAddressCandidate
Point

The Point object representing the location of the address.

more details
more detailsAddressCandidate
Number

Numeric score between 0 and 100 for geocode candidates.

more details
more detailsAddressCandidate

Property Details

addressString

Address of the candidate.

attributesObject

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

declaredClassStringreadonly inherited

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

The Point object representing the location of the address.

scoreNumber

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.

Method Overview

NameReturn TypeSummaryClass
*

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 detailsAddressCandidate
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsAddressCandidate

Method Details

fromJSON(json){*}static

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 json parameter 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 Object

A 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.