FindResult

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

The result from FindTask.

See also:

Property Overview

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

The name of the class.

more details
more detailsAccessor
String

The name of the layer's primary display field.

more details
more detailsFindResult
Graphic

The found feature.

more details
more detailsFindResult
String

The name of the field that contains the search text.

more details
more detailsFindResult
Number

Unique ID of the layer that contains the feature.

more details
more detailsFindResult
String

The layer name that contains the feature.

more details
more detailsFindResult

The value of the foundFieldName in the feature's attributes.

more details
more detailsFindResult

Property Details

declaredClassStringreadonly inherited

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

displayFieldNameString

The name of the layer's primary display field. The value of this property matches the name of one of the fields of the feature.

featureGraphic

The found feature.

foundFieldNameString

The name of the field that contains the search text.

layerIdNumber

Unique ID of the layer that contains the feature.

layerNameString

The layer name that contains the feature.

value

The value of the foundFieldName in the feature's attributes.

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

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

more details
more detailsFindResult

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.