AggregateField

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

Defines the aggregate fields used in a layer visualized with binning. An aggregate field aggregates the data from a layer's field using a statistic such as the average or sum.

See also:
Example:
featureReduction.fields = [{
  name: "SUM_population",
  outStatistic: {
    onStatisticField: "population",
    statisticType: "sum"
  }
}, {
  name: "AVG_age",
  outStatistic: {
    onStatisticField: "age",
    statisticType: "avg"
  }
}];

Constructors

new AggregateField(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 aggregate field.

more detailsAggregateField
OutStatisticmore details

Defines the statistic method for aggregating data in a layer's field within the bin.

more detailsAggregateField

Property Details

declaredClass Stringreadonly inherited

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

name String

The name of the aggregate field. This should describe the layer field and aggregation method used. For example, if creating a field that contains the total population for a set of features with a population field, then you could name this field total_population or popuplation_sum.

Example:
// names the aggregate field that will display the sum of the population
// for all points representing cities in the bin
aggregateField.name = "SUM_population";
outStatistic OutStatisticautocast

Defines the statistic method for aggregating data in a layer's field within the bin. For example if binning a point layer representing cities and the layer has a field for population, you can create a field that stores the sum of the population for all points within the bin.

Example:
// will calculate the sum of the population field for all features
// included in the bin
aggregateField.outStatistic = {
  onStatisticField: "population",
  statisticType: "sum"
};

Method Overview

Name Return Type Summary Class
AggregateFieldmore details

Creates a deep clone of the AggregateField object.

more detailsAggregateField
*more details

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

more detailsAggregateField
Objectmore details

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

more detailsAggregateField

Method Details

clone(){AggregateField}

Creates a deep clone of the AggregateField object.

Returns:
Type Description
AggregateField A deep clone of the object that invoked this method.
Example:
// Creates a deep clone of the AggregateField object
const sumPopulationField = layer.featureReduction.fields.find( field => field.name === "SUM_population" ).clone();
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.