@deephaven/jsapi-types
    Preparing search index...

    Interface AggByOptions

    Options to control a call to TableOperations.aggBy().

    interface AggByOptions {
        aggregations: readonly AggregationUnion[];
        groupByColumns?: readonly (string | Column)[];
        initialGroups?: TableReference;
        preserveEmpty?: boolean;
    }
    Index
    aggregations: readonly AggregationUnion[]

    The aggregations to apply

    groupByColumns?: readonly (string | Column)[]

    The columns to group by. Must be specified if AggByOptions.initialGroups is non-null. If empty or unspecified, the result is a single group containing all rows in the table.

    initialGroups?: TableReference

    An optional table whose distinct combinations of values for the AggByOptions.groupByColumns should be used to create an initial set of aggregation groups. All other columns are ignored.

    The aggregation uses only the initial state of this table and ignores later updates.

    preserveEmpty?: boolean

    Whether to keep result rows for groups that are initially empty or become empty as a result of updates. Each aggregation operator defines its own values for empty groups. Defaults to false if unspecified.