IgxTreeGridRow | Infragistics API Docs

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

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

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

Accessors

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

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

Returns CellType[]

children

Returns the child rows.

get children(): RowType[]

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

Returns RowType[]

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

Returns any

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

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

Returns boolean

expanded

Gets whether the row is expanded.

let esExpanded = row.expanded;

get expanded(): boolean

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

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

Parameters

val: boolean

Returns void

hasChildren

Returns true if child rows exist. Always return false for grid row.

get hasChildren(): boolean

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

Returns boolean

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

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

parent

Returns the parent row.

get parent(): RowType

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

Returns RowType

pinned

Gets whether the row is pinned.

let isPinned = row.pinned;

get pinned(): boolean

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

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

Parameters

val: boolean

Returns void

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

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

Returns ITreeGridRecord

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

Returns the view index calculated per the grid page.

get viewIndex(): number

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

Returns number

Methods

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

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

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

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