StatisticDefinition

require(["esri/tasks/support/StatisticDefinition"], function(StatisticDefinition) { /* code goes here */ });
Class: esri/tasks/support/StatisticDefinition
Inheritance: StatisticDefinition Accessor
Since: ArcGIS API for JavaScript 4.0

The StatisticDefinition class defines the type of statistics, the field used to calculate the statistics and the resulting output field name. Used to specify an array of statistic definitions for a query's outStatistics property. Requires ArcGIS Server service version 10.1 or greater.

See also:

Constructors

new StatisticDefinition(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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

Defines the field for which statistics will be calculated.

more details
more detailsStatisticDefinition
String

Specifies the output field name.

more details
more detailsStatisticDefinition
String

Defines the type of statistic.

more details
more detailsStatisticDefinition

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.

onStatisticFieldString

Defines the field for which statistics will be calculated.

outStatisticFieldNameString

Specifies the output field name. Output field names can only contain alpha-numeric characters and an underscore. If no output field name is specified, the map server assigns a field name to the returned statistic field.

statisticTypeString

Defines the type of statistic.

Known Values: count | sum | min | max | avg | stddev | var

Method Overview

NameReturn TypeSummaryClass
*

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 detailsStatisticDefinition
Object

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

more details
more detailsStatisticDefinition

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:
TypeDescription
*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.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.
Searching...

API Reference search results

NameTypeModule

There were no match results from your search criteria.