FeatureSet

require(["esri/tasks/support/FeatureSet"], function(FeatureSet) { /* code goes here */ });

Class: esri/tasks/support/FeatureSet

Inheritance: FeatureSet Accessor

Since: ArcGIS API for JavaScript 4.0

A collection of features returned from ArcGIS Server or used as input to tasks. Each feature in the FeatureSet may contain geometry, attributes, and symbology. If the FeatureSet does not contain geometry, and only contains attributes, the FeatureSet can be treated as a table where each feature is a row object. Tasks that return FeatureSet include QueryTask.

See also:

QueryTask

Constructors

new FeatureSet(properties)

Parameter:

properties Object

optional

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

Property Overview

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

Show inherited properties Hide inherited properties

Type	Summary	Class
String	The name of the class. more details	more details	Accessor
String	The name of the layer's primary display field. more details	more details	FeatureSet
Boolean	Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation. more details	more details	FeatureSet
Graphic[]	The array of graphics returned from a task. more details	more details	FeatureSet
Field[]	Information about each field. more details	more details	FeatureSet
String	The geometry type of the FeatureSet. more details	more details	FeatureSet
SpatialReference	When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. more details	more details	FeatureSet

Property Details

declaredClassStringreadonly inherited Since: ArcGIS API for JavaScript 4.7

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. This is only applicable when the FeatureSet is returned from a task. It is ignored when the FeatureSet is used as input to a geoprocessing task.

exceededTransferLimitBoolean

Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation. If maxRecordCount is configured for a layer, exceededTransferLimit will be true if a query matches more than the maxRecordCount features. It will be false otherwise. Supported by ArcGIS Server version 10.1 and later.

featuresGraphic[]

The array of graphics returned from a task.

fieldsField[] Since: ArcGIS API for JavaScript 4.1

Information about each field.

geometryTypeString

The geometry type of the FeatureSet.

spatialReferenceSpatialReference

When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default. This value can be changed. When a FeatureSet is returned from a task, the value is the result as returned from the server.

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 a product in the ArcGIS platform. more details	more details	FeatureSet
	Object	Converts an instance of this class to its ArcGIS portal JSON representation. more details	more details	FeatureSet

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:

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() topic in the Guide for more information.