GroupDescriptor

Premium

The group descriptor used by the groupBy method.

ts

const groupDescriptor: GroupDescriptor[] = [
  {
    field: 'UnitsInStock',
    dir: 'asc',
    aggregates: [
      { field: 'UnitsInStock', aggregate: 'sum' },
      { field: 'UnitPrice', aggregate: 'average' },
    ],
  },
];

Name	Type	Default	Description
aggregates?	AggregateDescriptor[]		The aggregates which are calculated during grouping.
compare?	(a: any, b: any) => number		A custom function that defines the sort order of the group.
dir?	"desc" | "asc"		The sort order of the group.
field	string		The data item field by which the data will be grouped.