For the complete documentation index, see llms.txt. This page is also available as Markdown.

GetRasterAggregatesParams


The parameters for calculating statistics for a raster band, passed to the LayersController.getRasterAggregates method.

Type Parameters

Type Parameter

Properties

layerId

layerId: string


bandId

bandId: string

The ID of the band to calculate statistics for, read from the bands on a raster layer's source.


aggregation

aggregation: { methods: T[]; percentiles: number[]; }

Which statistics to calculate for the band.

Name
Type
Description

methods

T[]

The statistics to calculate for the band.

percentiles?

number[]

Percentile ranks between 0 and 100 to calculate, such as [10, 50, 90].


boundary?

optional boundary: GeometryFilter

The spatial boundary for the pixels to include. Omit this to cover the whole raster.


filters?

optional filters: Filters

Filters on band values for the pixels to include, such as ["band:1", "gt", 100].

Last updated

Was this helpful?