Skip to main content

DomainAggregateSpec<TColumn, TGroup, TAlias>

Defined in: js-api/src/domains.ts:345

Spec for domain table aggregate.

Type Parameters

Type ParameterDefault type
TColumn extends stringstring
TGroup extends stringstring
TAlias extends stringstring

Properties

PropertyTypeDescriptionDefined in
expand?string[]Master-FK expands ('<fk_column>'); groupBy/measures may then use '<fk>.<col>' (§13.2).js-api/src/domains.ts:356
filter?DomainFilter<TColumn>Filter applied before aggregation (smart string, condition, or condition tree).js-api/src/domains.ts:351
groupBy?DomainColumnRef<TColumn> & TGroup[]Column names to group by; omit for a single-row grand total.js-api/src/domains.ts:348
limit?number-js-api/src/domains.ts:354
measuresDomainAggregateMeasure<TColumn, TAlias>[]-js-api/src/domains.ts:349
sort?stringComma-separated output names (group columns or measure aliases); ! prefix for descending.js-api/src/domains.ts:353