Class AggByOptions

java.lang.Object
io.deephaven.web.client.api.agg.AggByOptions

@TsInterface @JsType(namespace="dh.agg") public class AggByOptions extends Object
Options to control a call to JsTableOperations.aggBy(AggByOptions).
  • Field Details

    • aggregations

      public elemental2.core.ReadonlyArray<AggregationUnion> aggregations
      The aggregations to apply
    • preserveEmpty

      public @JsNullable Boolean preserveEmpty
      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.
    • initialGroups

      public @JsNullable JsTableReference initialGroups
      An optional table whose distinct combinations of values for the 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.

    • groupByColumns

      public @JsNullable elemental2.core.ReadonlyArray<Column.ColumnOrName> groupByColumns
      The columns to group by. Must be specified if initialGroups is non-null. If empty or unspecified, the result is a single group containing all rows in the table.
  • Constructor Details

    • AggByOptions

      public AggByOptions()