import AttributeBinsFeatureSet from "@arcgis/core/rest/support/AttributeBinsFeatureSet.js";const AttributeBinsFeatureSet = await $arcgis.import("@arcgis/core/rest/support/AttributeBinsFeatureSet.js");- Inheritance:
- AttributeBinsFeatureSet→
FeatureSet→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.32
The AttributeBinsFeatureSet is a collection of AttributeBinsGraphic returned from the queryAttributeBins() method based on a given AttributeBinsQuery.
It returns an array of results divided into bins based on a numeric or date field. Each feature in the AttributeBinsFeatureSet may contain geometry,
attributes, and symbology. Additionally, the feature also can contain AttributeBinsGraphic.stackedAttributes which can be used to create a stacked
chart for visualizing aggregated data by category.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
displayFieldName inherited | ||
exceededTransferLimit inherited | ||
| | ||
fields inherited | Field[] | |
geometryType inherited | ||
queryGeometry inherited | ||
spatialReference inherited |
displayFieldName
- Type
- 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
- Type
- 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.
- Default value
- false
features
- Type
- AttributeBinsGraphic[]
The array of attribute bin graphics returned from a queryAttributeBins() operation.
geometryType
- Type
- GeometryType
The geometry type of features in the FeatureSet. All features's geometry must be of the same type.
queryGeometry
- Type
- GeometryWithoutMeshUnion | null | undefined
The Query.geometry used to query the features. It is useful for getting
the buffer geometry generated when querying features by Query.distance
or getting the query geometry projected in the Query.outSpatialReference of the query.
The query geometry is returned only for client-side queries
and hosted feature services.
The query's Query.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
- Type
- SpatialReference | null | undefined
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.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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 | 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.
clone
- Signature
-
clone (): this
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
- Returns
- this
A deep clone of the class instance that invoked this method.
toJSON
- Signature
-
toJSON (): any
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.