FeatureSet

AMD: require(["esri/rest/support/FeatureSet"], (FeatureSet) => { /* code goes here */ });
ESM: import FeatureSet from "@arcgis/core/rest/support/FeatureSet";
Class: esri/rest/support/FeatureSet
Inheritance: FeatureSet Accessor
Since: ArcGIS API for JavaScript 4.20

A collection of features returned from ArcGIS Server or used as input to methods. 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. Methods that return FeatureSet include query.

See also:

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
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The name of the layer's primary display field.

more detailsFeatureSet
Booleanmore details

Typically, a layer has a limit on the number of features (i.e., records) returned by the query operation.

more detailsFeatureSet
Graphic[]more details

The array of graphics returned from a task.

more detailsFeatureSet
Field[]more details

Information about each field.

more detailsFeatureSet
Stringmore details

The geometry type of features in the FeatureSet.

more detailsFeatureSet
Geometrymore details

The geometry used to query the features.

more detailsFeatureSet
SpatialReferencemore details

When a FeatureSet is used as input to Geoprocessor, the spatial reference is set to the map's spatial reference by default.

more detailsFeatureSet

Property Details

declaredClass Stringreadonly inherited

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

exceededTransferLimit Boolean

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.

Autocasts from Object[]

The array of graphics returned from a task.

Autocasts from Object[]

Information about each field.

geometryType String

The geometry type of features in the FeatureSet. All features's geometry must be of the same type.

Possible Values:"point"|"multipoint"|"polyline"|"polygon"|"extent"|"mesh"

queryGeometry Geometry

The geometry used to query the features. It is useful for getting the buffer geometry generated when querying features by distance or getting the query geometry projected in the outSpatialReference of the query. The query geometry is returned only for client-side queries and hosted feature services. The query's returnQueryGeometry must be set to true and the layer's capabilities.query.supportsQueryGeometry has to be true for the query to return query geometry.

See also:
spatialReference SpatialReference

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
*more details

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

more detailsFeatureSet
Objectmore details

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

more detailsFeatureSet

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.