Class XtStoreGroupBy<T>

constructor

• new XtStoreGroupBy<T>(
      of: keyof T,
      display?: { [key: string]: XtStoreGroupByAggregate<T> },
      show?: XtGroupByShow,
  ): XtStoreGroupBy<T>

  Type Parameters

  • T

  Parameters

  • of: keyof T

    The field to group by

  • Optionaldisplay: { [key: string]: XtStoreGroupByAggregate<T> }

    Optional map of aggregate definitions

  • Optionalshow: XtGroupByShow

    Optional directive for which group value to display

  Returns XtStoreGroupBy<T>

display

of

Optionalshow

atLeastOneGroupIsRequested

• atLeastOneGroupIsRequested(): boolean

  Checks whether at least one aggregate group has been configured.

  Returns boolean

  True if any display aggregates are defined

getRequiredListOfFields

• getRequiredListOfFields(): Set<keyof T>

  Returns the set of field keys required by all defined aggregates.

  Returns Set<keyof T>

  A set of field names