SuggestionCandidate | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: SuggestionCandidate→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

Describes the object representing the result of the suggestLocations() method.

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SuggestionCandidateProperties`

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
`declaredClass` readonly inherited	`string`	Accessor
`isCollection`	`boolean \| null`
`magicKey`	`string \| null`
`text`	`string \| null`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

isCollection

Property

Type: boolean | null

Indicates if the result is a Collection.

magicKey

Property

Type: string | null

ID used in combination with the text property to uniquely identify a suggestion.

text

Property

Type: string | null

The string name of the suggested location to geocode.

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.