GetLayerCalculationParams


The parameters for calculating a single aggregate value for a layer, passed to the LayersController.getAggregates method.

Type Parameters

Type Parameter

T extends AggregationMethod | "count"

Properties

layerId

layerId: string

The ID of the layer to calculate an aggregate value for.


aggregation

aggregation: MultiAggregationConfig<T>

Specifies how to aggregate values within each category or bin. When omitted, features are counted. When specified, the chosen calculation (avg, sum, etc.) is performed on the specified attribute.


filters?

optional filters: Filters

Attribute filters for the features to include when calculating the aggregate value.


boundary?

optional boundary: GeometryFilter

The spatial boundary for the features to include when calculating the aggregate value.

Last updated

Was this helpful?