Interface SemanticAggregateQuery<TRecord, TProtocol, TSpatiality, TGroupBy, TMetrics>`Experimental`

interface SemanticAggregateQuery<
    TRecord,
    TProtocol extends SourceProtocol,
    TSpatiality extends SourceSpatiality,
    TGroupBy extends readonly GroupableFieldName<TRecord>[] = readonly [],
    TMetrics extends
        readonly [AggregateMetric<TRecord>, ...AggregateMetric<TRecord>[]] = readonly [
        AggregateMetric<TRecord>,
        ...AggregateMetric<TRecord>[],
    ],
> {
    filter?: QueryFilter<TRecord, TProtocol, TSpatiality>;
    groupBy: TGroupBy;
    kind: "aggregate";
    metrics: TMetrics;
    outputCrs?: OutputCrsFor<TSpatiality>;
    page?: SemanticPageRequest;
    sort?: readonly SemanticSort<TRecord>[];
}

Type Parameters

TRecord
TProtocol extends SourceProtocol
TSpatiality extends SourceSpatiality
TGroupBy extends readonly GroupableFieldName<TRecord>[] = readonly []
TMetrics extends readonly [AggregateMetric<TRecord>, ...AggregateMetric<TRecord>[]] = readonly [AggregateMetric<TRecord>, ...AggregateMetric<TRecord>[]]

Hierarchy

SemanticQueryBase<TRecord, TProtocol, TSpatiality>
- SemanticAggregateQuery

Index

Properties

filter? groupBy kind metrics outputCrs? page? sort?

Properties

`Optional` `Readonly` `Experimental`filter

filter?: QueryFilter<TRecord, TProtocol, TSpatiality>

`Readonly` `Experimental`groupBy

groupBy: TGroupBy

`Readonly` `Experimental`kind

kind: "aggregate"

`Readonly` `Experimental`metrics

metrics: TMetrics

`Optional` `Readonly` `Experimental`outputCrs

outputCrs?: OutputCrsFor<TSpatiality>

`Optional` `Readonly` `Experimental`page

page?: SemanticPageRequest

`Optional` `Readonly` `Experimental`sort

sort?: readonly SemanticSort<TRecord>[]