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.
Show inherited properties Hide inherited properties
Name Type Summary Class
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
String

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

more details
more detailsFindResult

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

displayFieldName String

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.

feature Graphic

The found feature.

foundFieldName String

The name of the field that contains the search text.

layerId Number

Unique ID of the layer that contains the feature.

layerName String

The layer name that contains the feature.

value String

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

Method Overview

Name Return Type Summary Class
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

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 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.

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:
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() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.