Class θIgxTreeGridRowComponent

Hierarchy

IgxRowDirective
- θIgxTreeGridRowComponent

Implements

DoCheck

Constructors

constructor

new θIgxTreeGridRowComponent(grid: GridType, selectionService: IgxGridSelectionService, element: ElementRef<HTMLElement>, cdr: ChangeDetectorRef): θIgxTreeGridRowComponent
Inherited from IgxRowDirective.constructor
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:376
Parameters
- grid: GridType
- selectionService: IgxGridSelectionService
- element: ElementRef<HTMLElement>
- cdr: ChangeDetectorRef
Returns θIgxTreeGridRowComponent

Properties

cdr

cdr: ChangeDetectorRef

disabled

disabled: boolean = false

Sets whether this specific row has disabled functionality for editing and row selection. Default value is false.

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

element

element: ElementRef<HTMLElement>

grid

grid: GridType

index

index: number

The index of the row.

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

selectionService

selectionService: IgxGridSelectionService

Accessors

addRowUI

get addRowUI(): any
Inherited from IgxRowDirective.addRowUI
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:136
Returns any

cellHeight

get cellHeight(): number
Inherited from IgxRowDirective.cellHeight
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:152
Returns number

cells

get cells(): QueryList<CellType>
Inherited from IgxRowDirective.cells
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:189
Gets the rendered cells in the row component.
```
// get the cells of the third selected row
let selectedRowCells = this.grid.selectedRows[2].cells;
```
Returns QueryList<CellType>

data

get data(): any
Inherited from IgxRowDirective.data
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:51
The data passed to the row component.
```
// get the row data for the first selected row
let selectedRowData = this.grid.selectedRows[0].data;
```
Returns any
set data(v: any): void
Inherited from IgxRowDirective.data
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:64
Parameters
- v: any
Returns void

dataRowIndex

get dataRowIndex(): number
Inherited from IgxRowDirective.dataRowIndex
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:200
Returns number

expanded

get expanded(): boolean
Overrides IgxRowDirective.expanded
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-row.component.ts:94
Returns a value indicating whether the row component is expanded.
```
const row = this.grid.getRowByKey(1) as IgxTreeGridRowComponent;
const expanded = row.expanded;
```
Returns boolean
set expanded(value: boolean): void
Overrides IgxRowDirective.expanded
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-row.component.ts:107
Sets a value indicating whether the row component is expanded.
```
const row = this.grid.getRowByKey(1) as IgxTreeGridRowComponent;
row.expanded = true;
```
Parameters
- value: boolean
Returns void

inEditMode

get inEditMode(): boolean
Inherited from IgxRowDirective.inEditMode
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:316
Returns boolean

key

get key(): any
Inherited from IgxRowDirective.key
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:335
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

nativeElement

get nativeElement(): HTMLElement
Inherited from IgxRowDirective.nativeElement
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:352
The native DOM element representing the row. Could be null in certain environments.
```
// get the nativeElement of the second selected row
let selectedRowNativeElement = this.grid.selectedRows[1].nativeElement;
```
Returns HTMLElement

pinned

get pinned(): boolean
Overrides IgxRowDirective.pinned
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-row.component.ts:63
Gets whether the row is pinned.
```
let isPinned = row.pinned;
```
Returns boolean
set pinned(value: boolean): void
Overrides IgxRowDirective.pinned
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-row.component.ts:49
Sets whether the row is pinned. Default value is false.
```
this.grid.selectedRows[0].pinned = true;
```
Parameters
- value: boolean
Returns void

rowHeight

get rowHeight(): number
Inherited from IgxRowDirective.rowHeight
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:142
Returns number

selected

set selected(value: boolean): void
Inherited from IgxRowDirective.selected
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:214
Parameters
- value: boolean
Returns void

treeRow

get treeRow(): ITreeGridRecord
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-row.component.ts:30
The ITreeGridRecord passed to the row component.
```
const row = this.grid.getRowByKey(1) as IgxTreeGridRowComponent;
const treeRow = row.treeRow;
```
Returns ITreeGridRecord
set treeRow(value: ITreeGridRecord): void
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-row.component.ts:35
Parameters
- value: ITreeGridRecord
Returns void

virtDirRow

get virtDirRow(): IgxGridForOfDirective<any>
Inherited from IgxRowDirective.virtDirRow
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:168
Returns IgxGridForOfDirective<any>

Methods

beginAddChild

beginAddChild(): void
- Defined in projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-row.component.ts:157
Spawns the add child row UI for the specific row.

Example
```
const row = this.grid.getRowByKey(1) as IgxTreeGridRowComponent;
row.beginAddChild();
```
Returns void

beginAddRow

beginAddRow(): void
Inherited from IgxRowDirective.beginAddRow
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:556
Spawns the add row UI for the specific row.

Example
```
const row = this.grid1.getRowByIndex(1);
row.beginAddRow();
```
Returns void

delete

delete(): void
Inherited from IgxRowDirective.delete
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:489
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

isCellActive

isCellActive(visibleColumnIndex: any): boolean
Inherited from IgxRowDirective.isCellActive
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:493
Parameters
- visibleColumnIndex: any
Returns boolean

pin(): boolean
Inherited from IgxRowDirective.pin
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:507
Pins the specified row. This method emits rowPinning``rowPinned event.
```
// pin the selected row from the grid
this.grid.selectedRows[0].pin();
```
Returns boolean

unpin

unpin(): boolean
Inherited from IgxRowDirective.unpin
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:520
Unpins the specified row. This method emits rowPinning``rowPinned event.
```
// unpin the selected row from the grid
this.grid.selectedRows[0].unpin();
```
Returns boolean

update

update(value: any): void
Inherited from IgxRowDirective.update
- Defined in projects/igniteui-angular/src/lib/grids/row.directive.ts:470
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

Class θIgxTreeGridRowComponent

Hierarchy

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

grid: GridType

selectionService: IgxGridSelectionService

element: ElementRef<HTMLElement>

cdr: ChangeDetectorRef

Returns θIgxTreeGridRowComponent

Properties

cdr

disabled

element

grid

index

selectionService

Accessors

addRowUI

Returns any

cellHeight

Returns number

cells

Returns QueryList<CellType>

data

Returns any

Parameters

v: any

Returns void

dataRowIndex

Returns number

expanded

Returns boolean

Parameters

value: boolean

Returns void

inEditMode

Returns boolean

key

Returns any

nativeElement

Returns HTMLElement

pinned

Returns boolean

Parameters

value: boolean

Returns void

rowHeight

Returns number

selected

Parameters

value: boolean

Returns void

treeRow

Returns ITreeGridRecord

Parameters

value: ITreeGridRecord

Returns void

virtDirRow

Returns IgxGridForOfDirective<any>

Methods

beginAddChild

Example

Returns void

beginAddRow

Example

Returns void

delete

Returns void

isCellActive

Parameters

visibleColumnIndex: any

Returns boolean

pin