Hierarchy

Hierarchy (view full)

Constructors

Accessors

  • get addRowUI(): any
  • Returns any

  • get cellHeight(): number
  • Returns number

  • get cells(): IgcCellType[]
  • Gets the rendered cells in the row component.

    // get the cells of the third selected row
    let selectedRowCells = this.grid.selectedRows[2].cells;

    Returns IgcCellType[]

  • get data(): any
  • Returns any

  • set data(value): void
  • The data passed to the row component.

    // get the row data for the first selected row
    let selectedRowData = this.grid.selectedRows[0].data;

    Parameters

    • value: any

    Returns void

  • get dataRowIndex(): number
  • Returns number

  • get disabled(): boolean
  • Returns boolean

  • set disabled(value): void
  • Sets whether this specific row has disabled functionality for editing and row selection. Default value is false.

    this.grid.selectedRows[0].pinned = true;
    

    Parameters

    • value: boolean

    Returns void

  • get expanded(): boolean
  • Returns boolean

  • set expanded(value): void
  • Gets the expanded state of the row.

    let isExpanded = row.expanded;
    

    Parameters

    • value: boolean

    Returns void

  • get inEditMode(): boolean
  • Returns boolean

  • get index(): number
  • Returns number

  • set index(value): void
  • The index of the row.

    // get the index of the second selected row
    let selectedRowIndex = this.grid.selectedRows[1].index;

    Parameters

    • value: number

    Returns void

  • get key(): any
  • Gets the ID of the row. A row in the grid is identified either by:

    • primaryKey data value,
    • the whole data, if the primaryKey is omitted.
    let rowID = this.grid.selectedRows[2].key;
    

    Returns any

  • get mrlRightPinnedOffset(): string
  • Returns string

  • get pinned(): boolean
  • Returns boolean

  • set pinned(value): void
  • Sets whether the row is pinned. Default value is false.

    this.grid.selectedRows[0].pinned = true;
    

    Parameters

    • value: boolean

    Returns void

  • get rowHeight(): number
  • Returns number

Methods

  • Spawns the add row UI for the specific row.

    Example

    const row = this.grid1.getRowByIndex(1);
    row.beginAddRow();

    Returns void

  • Removes the specified row from the grid's data source. This method emits rowDeleted event.

    // delete the third selected row from the grid
    this.grid.selectedRows[2].delete();

    Returns void

  • Parameters

    • col: any
    • row: any

    Returns void

  • Parameters

    • pinnedCols: any
    • row: any

    Returns void

  • Parameters

    • visibleColumnIndex: any

    Returns void

  • Pins the specified row. This method emits rowPinning``rowPinned event.

    // pin the selected row from the grid
    this.grid.selectedRows[0].pin();

    Returns void

  • Unpins the specified row. This method emits rowPinning``rowPinned event.

    // unpin the selected row from the grid
    this.grid.selectedRows[0].unpin();

    Returns void

  • Updates the specified row object and the data source record with the passed value.

    // update the second selected row's value
    let newValue = "Apple";
    this.grid.selectedRows[1].update(newValue);

    Parameters

    • value: any

    Returns void