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:491

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:492

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:45

Returns boolean

cells

Section titled "cells"

Gets the rendered cells in the row component.

 
get cells(): CellType[]

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

Returns CellType[]

data

Section titled "data"

Inherited from: BaseRow

The data record that populates the row.

let rowData = row.data;
get data(): any

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

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:167

Returns boolean

disabled

Section titled "disabled"

Inherited from: BaseRow

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:182

Returns boolean

expanded

Section titled "expanded"

Inherited from: BaseRow

Gets the row expanded/collapsed state.

const isExpanded = row.expanded;
get expanded(): boolean

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

Returns boolean

Expands/collapses the row.

row.expanded = true;
set expanded(val: boolean): void

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

Parameters

  • val: boolean

Returns void

hasChildren

Section titled "hasChildren"

Returns true if row islands exist.

 
get hasChildren(): boolean

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

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:80

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:32

Returns any

pinned

Section titled "pinned"

Inherited from: BaseRow

Gets whether the row is pinned. Default value is false.

const isPinned = row.pinned;
get pinned(): boolean

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

Returns boolean

Sets whether the row is pinned. Default value is false.

row.pinned = !row.pinned;
set pinned(val: boolean): void

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

Parameters

  • val: boolean

Returns void

selected

Section titled "selected"

Inherited from: BaseRow

Gets whether the row is selected. Default value is false.

row.selected = true;
get selected(): boolean

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

Returns boolean

Sets whether the row is selected. Default value is false.

row.selected = !row.selected;
set selected(val: boolean): void

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

Parameters

  • val: boolean

Returns void

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:57

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:508

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:252

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:207

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:220

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:233

Parameters

  • value: any

Returns void