AddressCandidate | References | ArcGIS Maps SDK for JavaScript

import AddressCandidate from "@arcgis/core/rest/support/AddressCandidate.js";

Inheritance:: AddressCandidate→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.20

Represents the result of a geocode service operation as a list of address candidates. This resource provides information about candidates, including the address, location, and match score.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`AddressCandidateProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`address`	`string \| null \| undefined`
`attributes`	`Object \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`extent`	`Extent \| null \| undefined`
`location`	`Point \| null \| undefined`
`score`	`number \| null \| undefined`

address

Property

Type: string | null | undefined

Address of the candidate.

attributes

Property

Type: Object | null | undefined

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

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

extent

autocast Property

Type: Extent | null | undefined

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

location

autocast Property

Type: Point | null | undefined

The Point object representing the location of the address.

score

Property

Type: number | null | undefined

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.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.