Interface representing a row in the grid. It is essentially the blueprint to a row object. Contains definitions of properties and methods, relevant to a row

Properties

Section titled "Properties"

grid

Section titled "grid"

Inherited from: BaseRow

Represent the grid instance, the row belongs to

 
grid: GridType

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:346

index

Section titled "index"

Inherited from: BaseRow

The index of the row within the grid

 
index: number

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:347

expanded

Section titled "expanded"

Optional Indicates whether the current row is expanded. The value is true, if the row is expanded and false, if it is collapsed

 
expanded: boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:469, projects/igniteui-angular/grids/core/src/grid-public-row.ts:480

pinned

Section titled "pinned"

Optional Indicates whether the current row is pinned.

 
pinned: boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:443, projects/igniteui-angular/grids/core/src/grid-public-row.ts:454

selected

Section titled "selected"

Inherited from: BaseRow

Optional Indicates whether the current row is selected

 
selected: boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:150, projects/igniteui-angular/grids/core/src/grid-public-row.ts:161

Accessors

Section titled "Accessors"

addRowUI

Section titled "addRowUI"

Inherited from: BaseRow

Gets if this represents add row UI

let isAddRow = row.addRowUI;
get addRowUI(): boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:46

Returns boolean

cells

Section titled "cells"

Inherited from: BaseRow

Gets the rendered cells in the row component.

get cells(): CellType[]

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:195

Returns CellType[]

children

Section titled "children"

Returns the child rows.

get children(): RowType[]

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:395

Returns RowType[]

data

Section titled "data"

The data passed to the row component.

let selectedRowData = this.grid.selectedRows[0].data;
get data(): any

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:378

Returns any

deleted

Section titled "deleted"

Inherited from: BaseRow

Returns if the row is in delete state.

get deleted(): boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:173

Returns boolean

disabled

Section titled "disabled"

Gets whether the row is disabled. A disabled row represents a ghost placeholder created by row pinning.

get disabled(): boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:484

Returns boolean

hasChildren

Section titled "hasChildren"

Returns true if child rows exist. Always return false for IgxGridRow.

get hasChildren(): boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:417

Returns boolean

inEditMode

Section titled "inEditMode"

Inherited from: BaseRow

Returns if the row is currently in edit mode.

get inEditMode(): boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:86

Returns boolean

key

Section titled "key"

Inherited from: BaseRow

Gets the row key. A row in the grid is identified either by:

  • primaryKey data value,
  • the whole rowData, if the primaryKey is omitted.
let rowKey = row.key;
get key(): any

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:33

Returns any

parent

Section titled "parent"

Returns the parent row.

get parent(): RowType

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:409

Returns RowType

treeRow

Section titled "treeRow"

The ITreeGridRecord with metadata about the row in the context of the tree grid.

const rowParent = this.treeGrid.getRowByKey(1).treeRow.parent;
get treeRow(): ITreeGridRecord

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:432

Returns ITreeGridRecord

validation

Section titled "validation"

Inherited from: BaseRow

Gets the validation status and errors, if any.

let validation = row.validation;
let errors = validation.errors;
get validation(): IGridValidationState

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:58

Returns IGridValidationState

viewIndex

Section titled "viewIndex"

Returns the view index calculated per the grid page.

get viewIndex(): number

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:356

Returns number

Methods

Section titled "Methods"

delete

Section titled "delete"

Inherited from: BaseRow

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

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

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:258

Returns void

pin

Section titled "pin"

Inherited from: BaseRow

Pins the specified row. This method emits onRowPinning event.

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

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:213

Returns boolean

unpin

Section titled "unpin"

Inherited from: BaseRow

Unpins the specified row. This method emits onRowPinning event.

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

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:226

Returns boolean

update

Section titled "update"

Inherited from: BaseRow

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);
update(value: any): void

Defined in projects/igniteui-angular/grids/core/src/grid-public-row.ts:239

Parameters

  • value: any

Returns void