groupsRecords

selectedCells

clearGrouping

• clearGrouping(name?: string): void

  Clears grouping for particular column, array of columns or all columns.

  Remarks

  Clears all grouping in the grid, if no parameter is passed. If a parameter is provided, clears grouping for a particular column or an array of columns.

  Example

  this.grid.clearGrouping(); //clears all grouping
  this.grid.clearGrouping("ID"); //ungroups a single column
  this.grid.clearGrouping(["ID", "Column1", "Column2"]); //ungroups multiple columns
  Copy

  Parameters

  • name: string

    Name of column or array of column names to be ungrouped.

  Returns void

deselectRowsInGroup

• deselectRowsInGroup(groupRow: IgrGroupByRecord): void

  Deselect all rows within a group.

  Example

  public groupRow: IGroupByRecord;
  this.grid.deselectRowsInGroup(this.groupRow);
  Copy

  Parameters

  • groupRow: IgrGroupByRecord

    The group record which rows would be deselected.

  Returns void

fullyExpandGroup

• fullyExpandGroup(groupRow: IgrGroupByRecord): void

  Expands the specified group and all of its parent groups.

  Example

  public groupRow: IGroupByRecord;
  this.grid.fullyExpandGroup(this.groupRow);
  Copy

  Parameters

  • groupRow: IgrGroupByRecord

    The group record to fully expand.

  Returns void

getCellByColumn

• getCellByColumn(rowIndex: number, columnField: string): IgrCellType

  Returns a CellType object that matches the conditions.

  Example

  const myCell = this.grid1.getCellByColumn(2, "UnitPrice");
  Copy

  Parameters

  • rowIndex: number

  • columnField: string

  Returns IgrCellType

getCellByKey

• getCellByKey(rowSelector: any, columnField: string): IgrCellType

  Returns a CellType object that matches the conditions.

  Remarks

  Requires that the primaryKey property is set.

  Example

  grid.getCellByKey(1, 'index');
  Copy

  Parameters

  • rowSelector: any

    match any rowID

  • columnField: string

  Returns IgrCellType

getRowByIndex

• getRowByIndex(index: number): IgrRowType

  Returns the IgxGridRow by index.

  Example

  const myRow = grid.getRowByIndex(1);
  Copy

  Parameters

  • index: number

  Returns IgrRowType

getRowByKey

• getRowByKey(key: any): IgrRowType

  Returns IgxGridRow object by the specified primary key.

  Remarks

  Requires that the primaryKey property is set.

  Example

  const myRow = this.grid1.getRowByKey("cell5");
  Copy

  Parameters

  • key: any

  Returns IgrRowType

getSelectedData

• getSelectedData(formatters?: boolean, headers?: boolean): any[]

  Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...].

  Remarks

  If formatters is enabled, the cell value will be formatted by its respective column formatter (if any). If headers is enabled, it will use the column header (if any) instead of the column field.

  Parameters

  • formatters: boolean

  • headers: boolean

  Returns any[]

groupBy

• groupBy(expression: IgrGroupingExpression[]): void

  Groups by a new IgxColumnComponent based on the provided expression, or modifies an existing one.

  Remarks

  Also allows for multiple columns to be grouped at once if an array of ISortingExpression is passed. The groupingDone event would get raised only once if this method gets called multiple times with the same arguments.

  Example

  this.grid.groupBy({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
  this.grid.groupBy([
      { fieldName: name1, dir: SortingDirection.Asc, ignoreCase: false },
      { fieldName: name2, dir: SortingDirection.Desc, ignoreCase: true },
      { fieldName: name3, dir: SortingDirection.Desc, ignoreCase: false }
  ]);
  Copy

  Parameters

  • expression: IgrGroupingExpression[]

  Returns void

isExpandedGroup

• isExpandedGroup(group: IgrGroupByRecord): boolean

  Returns if a group is expanded or not.

  Example

  public groupRow: IGroupByRecord;
  const expandedGroup = this.grid.isExpandedGroup(this.groupRow);
  Copy

  Parameters

  • group: IgrGroupByRecord

    The group record.

  Returns boolean

pinRow

• pinRow(rowID: any, index?: number): boolean

  Pin the row by its id.

  Remarks

  ID is either the primaryKey value or the data record instance.

  Example

  this.grid.pinRow(rowID);
  Copy

  Parameters

  • rowID: any

    The row id - primaryKey value or the data record instance.

  • index: number

    The index at which to insert the row in the pinned collection.

  Returns boolean

selectRowsInGroup

• selectRowsInGroup(
      groupRow: IgrGroupByRecord,
      clearPrevSelection?: boolean,
  ): void

  Select all rows within a group.

  Example

  this.grid.selectRowsInGroup(this.groupRow, true);
  Copy

  Parameters

  • groupRow: IgrGroupByRecord

  • clearPrevSelection: boolean

  Returns void

toggleAllGroupRows

• toggleAllGroupRows(): void

  Toggles the expansion state of all group rows recursively.

  Example

  this.grid.toggleAllGroupRows;
  Copy

  Returns void

toggleGroup

• toggleGroup(groupRow: IgrGroupByRecord): void

  Toggles the expansion state of a group.

  Example

  public groupRow: IGroupByRecord;
  const toggleExpGroup = this.grid.toggleGroup(this.groupRow);
  Copy

  Parameters

  • groupRow: IgrGroupByRecord

    The group record to toggle.

  Returns void

unpinRow

• unpinRow(rowID: any): boolean

  Unpin the row by its id.

  Remarks

  ID is either the primaryKey value or the data record instance.

  Example

  this.grid.unpinRow(rowID);
  Copy

  Parameters

  • rowID: any

    The row id - primaryKey value or the data record instance.

  Returns boolean

data

detailTemplate

let detailTemplate = this.grid.detailTemplate;
Copy

dropAreaMessage

dropAreaTemplate

groupByRowSelectorTemplate

groupingExpansionState

groupingExpressions

groupRowTemplate

groupsExpanded

groupStrategy

hideGroupedColumns

id

showGroupArea

totalItemCount