selectedCells

addRow

• addRow(data: any, parentRowID?: any): void

  Creates a new IgxTreeGridRowComponent with the given data. If a parentRowID is not specified, the newly created row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches the specified parentRowID. If the parentRowID does not exist, an error would be thrown.

  const record = {
      ID: this.grid.data[this.grid1.data.length - 1].ID + 1,
      Name: this.newRecord
  };
  this.grid.addRow(record, 1); // Adds a new child row to the row with ID=1.
  Copy

  Memberof

  IgxTreeGridComponent

  Parameters

  • data: any

  • parentRowID: any

  Returns void

beginAddRowByIndex

• beginAddRowByIndex(index: number, asChild?: boolean): void

  Enters add mode by spawning the UI with the context of the specified row by index.

  Remarks

  Accepted values for index are integers from 0 to this.grid.dataView.length

  Example

  this.grid.beginAddRowByIndex(10);
  this.grid.beginAddRowByIndex(10, true);
  this.grid.beginAddRowByIndex(null);
  Copy

  Parameters

  • index: number

    The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length

  • asChild: boolean

    Whether the record should be added as a child. Only applicable to igxTreeGrid.

  Returns void

collapseAll

• collapseAll(): void

  Collapses all rows.

  this.grid.collapseAll();
  Copy

  Memberof

  IgxTreeGridComponent

  Returns void

expandAll

• expandAll(): void

  Expands all rows.

  this.grid.expandAll();
  Copy

  Memberof

  IgxTreeGridComponent

  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

getDefaultExpandState

• getDefaultExpandState(record: IgrTreeGridRecord): void

  Parameters

  • record: IgrTreeGridRecord

  Returns void

getRowByIndex

• getRowByIndex(index: number): IgrRowType

  Returns the IgxTreeGridRow by index.

  Example

  const myRow = treeGrid.getRowByIndex(1);
  Copy

  Parameters

  • index: number

  Returns IgrRowType

getRowByKey

• getRowByKey(key: any): IgrRowType

  Returns the RowType object by the specified primary key.

  Example

  const myRow = this.treeGrid.getRowByIndex(1);
  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[]

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

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

cascadeOnDelete

<igx-tree-grid [data]="employeeData" [primaryKey]="'employeeID'" [foreignKey]="'parentID'" cascadeOnDelete="false">
</igx-tree-grid>
Copy

childDataKey

<igx-tree-grid #grid [data]="employeeData" [childDataKey]="'employees'" [autoGenerate]="true"></igx-tree-grid>
Copy

data

<igx-tree-grid [data]="Data" [autoGenerate]="true"></igx-tree-grid>
Copy

expansionDepth

<igx-tree-grid #grid [data]="employeeData" [childDataKey]="'employees'" expansionDepth="1" [autoGenerate]="true"></igx-tree-grid>
Copy

foreignKey

<igx-tree-grid #grid [data]="employeeData" [primaryKey]="'employeeID'" [foreignKey]="'parentID'" [autoGenerate]="true">
</igx-tree-grid>
Copy

hasChildrenKey

<igx-tree-grid #grid [data]="employeeData" [primaryKey]="'employeeID'" [foreignKey]="'parentID'"
               [loadChildrenOnDemand]="loadChildren"
               [hasChildrenKey]="'hasEmployees'">
</igx-tree-grid>
Copy

id

<igx-tree-grid [id]="'igx-tree-grid-1'"></igx-tree-grid>
Copy

loadChildrenOnDemand

<igx-tree-grid [data]="employeeData" [primaryKey]="'employeeID'" [foreignKey]="'parentID'" [loadChildrenOnDemand]="loadChildren">
</igx-tree-grid>
Copy

public loadChildren = (parentID: any, done: (children: any[]) => void) => {
    this.dataService.getData(parentID, children => done(children));
}
Copy

processedRootRecords

// gets the processed root record with index=2
const states = this.grid.processedRootRecords[2];
Copy

rootRecords

// gets the root record with index=2
const states = this.grid.rootRecords[2];
Copy

rowLoadingIndicatorTemplate

<ng-template #rowLoadingTemplate>
    <igx-icon>loop</igx-icon>
</ng-template>

<igx-tree-grid #grid [data]="employeeData" [primaryKey]="'ID'" [foreignKey]="'parentID'"
               [loadChildrenOnDemand]="loadChildren"
               [rowLoadingIndicatorTemplate]="rowLoadingTemplate">
</igx-tree-grid>
Copy