arcgis-maps-kotlin/com.arcgismaps.mapping.reduction/AggregateField

AggregateField

Defines a field or statistical com.arcgismaps.arcade.ArcadeExpression for summarizing aggregated data from an AggregationFeatureReduction. Feature reduction uses statistical methods to aggregate geoelements into logical groups based on their location. Attribute values for each group (AggregateGeoElement) can be summarized for any numeric field using a specified AggregateStatisticType, such as the average, maximum, or sum. A common workflow is to summarize aggregated groups with the number of geoelements they represent.

Since

200.3.0

Constructors

AggregateField

constructor(name: String, statisticExpression: ArcadeExpression, statisticType: AggregateStatisticType)

Creates an AggregateField object.

constructor(name: String, statisticFieldName: String, statisticType: AggregateStatisticType)

Creates an AggregateField object.

Properties

alias

var alias: String

A display name for the field that appears in a com.arcgismaps.mapping.popup.Popup, label, and other UI elements.

name

var name: String

A name that uniquely identifies the aggregate field within the AggregationFeatureReduction.aggregateFields collection. Clusters will not draw correctly if AggregateField.name is empty or does not match the field name used by AggregationFeatureReduction.renderer. For example, an AggregateField that summarizes population values might have the alias population_sum.

statisticExpression

var statisticExpression: ArcadeExpression?

An Arcade expression that must evaluate to either a string or a number. The expression is evaluated for each geoelement represented by the AggregateGeoElement and the result of the expression is summarized using the given statistic type.

statisticFieldName

var statisticFieldName: String

An attribute name from the source dataset that contains numeric values to summarize. Alternatively, an Arcade expression (AggregateField.statisticExpression) can be used instead of an AggregateStatisticType. If present, this value always takes precedence over AggregateField.statisticExpression.

statisticType

var statisticType: AggregateStatisticType

Defines the type of statistic for summarizing values returned from AggregateField.statisticFieldName or AggregateField.statisticExpression.