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

Properties

Section titled "Properties"

grid

Section titled "grid"

Returns the grid containing the cell.

 
grid: GridType

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:14

Accessors

Section titled "Accessors"

active

Section titled "active"

Indicates whether the cell is currently active (focused).

 
get active(): boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:229

Returns boolean

column

Section titled "column"

Returns the column of the cell.

let column = this.cell.column;
get column(): ColumnType

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:56

Returns ColumnType

editable

Section titled "editable"

Returns whether the cell is editable..

 
get editable(): boolean

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

Returns boolean

editMode

Section titled "editMode"

Returns if the row is currently in edit mode.

 
get editMode(): boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:169

Returns boolean

Starts/ends edit mode for the cell.

cell.editMode  = !cell.editMode;
set editMode(value: boolean): void

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:182

Parameters

  • value: boolean

Returns void

editValue

Section titled "editValue"

Gets the current edit value while a cell is in edit mode.

let editValue = this.cell.editValue;
get editValue(): any

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:68

Returns any

Sets the current edit value while a cell is in edit mode. Only for cell editing mode.

this.cell.editValue = value;
set editValue(value: any): void

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:83

Parameters

  • value: any

Returns void

id

Section titled "id"

Gets the cell id. A cell in the grid is identified by:

  • rowID - primaryKey data value or the whole rowData, if the primaryKey is omitted.
  • rowIndex - the row index
  • columnID - column index
let cellID = cell.id;
get id(): any

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:158

Returns any

row

Section titled "row"

Returns the row containing the cell.

let row = this.cell.row;
get row(): RowType

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:44

Returns RowType

selected

Section titled "selected"

Gets whether the cell is selected.

let isSelected = this.cell.selected;
get selected(): boolean

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:206

Returns boolean

Selects/deselects the cell.

this.cell.selected = true.
set selected(val: boolean): void

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:219

Parameters

  • val: boolean

Returns void

validation

Section titled "validation"

Gets the validation status and errors, if any.

let validation = this.cell.validation;
let errors = validation.errors;
get validation(): IGridValidationState

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:97

Returns IGridValidationState

value

Section titled "value"

Returns the cell value.

 
get value(): any

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:128

Returns any

Updates the cell value.

 
set value(val: any): void

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:141

Parameters

  • val: any

Returns void

width

Section titled "width"

Gets the width of the cell.

let cellWidth = this.cell.width;
get width(): string

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:119

Returns string

Methods

Section titled "Methods"

update

Section titled "update"

Updates the cell value.

cell.update(newValue);
update(val: any): void

Defined in projects/igniteui-angular/grids/core/src/grid-public-cell.ts:244

Parameters

  • val: any

Returns void