Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Interface IGridGroupingStrategy

Represents a grouping strategy for the grid data, extending the Sorting Strategy interface (contains a sorting method).

Hierarchy

Hierarchy (view full)

Implemented by

Methods

Methods

groupBy

  • groupBy(data, state, grid?, groupsRecords?, fullResult?): IGroupByResult

  • The method groups the provided data based on the given grouping state and returns the result. data: The array of data to be grouped. Could be of any type. state: The grouping state that defines the grouping settings and expressions. grid: (Optional) The instance of the grid where the grouping is applied. groupsRecords: (Optional) An array that holds the records for each group. fullResult: (Optional) The complete result of grouping including groups and summary data. Returns an object containing the result of the grouping operation.

    Parameters

    • data: any[]
    • state: IGroupingState
    • Optional grid: any
    • Optional groupsRecords: any[]
    • Optional fullResult: IGroupByResult

    Returns IGroupByResult

sort

  • sort(data, expressions, grid?): any[]

  • data: The array of data to be sorted. Could be of any type. expressions: An array of sorting expressions that define the sorting rules. The expression contains information like file name, whether the letter case should be taken into account, etc. grid: (Optional) The instance of the grid where the sorting is applied. Returns a new array with the data sorted according to the sorting expressions.

    Parameters

    Returns any[]