OutStatistic

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

Defines the layer field and statistic used to aggregate data in that field for use in an AggregateField.

See also:
Example:
const aggregateField = new AggregateField({
  name: "avg_temperature",
  outStatistic: new OutStatistic({
    onStatisticField: "temperature",
    statisticType: "avg"
  })
});

Constructors

new OutStatistic(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

Defines the field to summarized with the given statisticType.

more detailsOutStatistic
Stringmore details

Defines the type of statistic used to aggregate data for the given onStatisticField.

more detailsOutStatistic

Property Details

declaredClass Stringreadonly inherited

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

onStatisticField String

Defines the field to summarized with the given statisticType.

Example:
// will create an aggregate field for the Population field of the layer.
outStatistic.onStatisticField = "Population";
statisticType String

Defines the type of statistic used to aggregate data for the given onStatisticField.

Possible Values

Value Description
sum The total sum of values that match a specified criteria.
avg The average of values that match a specified criteria.

Possible Values:"avg"|"sum"

Example:
// will calculate the sum of the field specified in onStatisticField for all features in the bin.
outStatistic.statisticType = "sum";

Method Overview

Name Return Type Summary Class
OutStatisticmore details

Creates a deep clone of the OutStatistic object.

more detailsOutStatistic
*more details

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

more detailsOutStatistic
Objectmore details

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

more detailsOutStatistic

Method Details

clone(){OutStatistic}

Creates a deep clone of the OutStatistic object.

Returns:
Type Description
OutStatistic A deep clone of the object that invoked this method.
Example:
// Creates a deep clone of the OutStatistic object
const outStatistic = field.outStatistics[0].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.