Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrCellType

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

Hierarchy

Hierarchy

  • IgrCellType

Constructors

Accessors

Methods

Constructors

constructor

  • Returns IgrCellType

Accessors

active

  • get active(): boolean

  • Indicates whether the cell is currently active (focused).

    Returns boolean

  • set active(v): void

  • Parameters

    • v: boolean

    Returns void

cellID

  • get cellID(): any

  • Optional; The cellID is the unique key, used to identify the cell

    Returns any

  • set cellID(v): void

  • Parameters

    • v: any

    Returns void

column

editMode

  • get editMode(): boolean

  • Indicates whether the cell is currently in edit mode.

    Returns boolean

  • set editMode(v): void

  • Parameters

    • v: boolean

    Returns void

editValue

  • get editValue(): any

  • The value to display when the cell is in edit mode.

    Returns any

  • set editValue(v): void

  • Parameters

    • v: any

    Returns void

editable

  • get editable(): boolean

  • Indicates whether the cell can be edited.

    Returns boolean

  • set editable(v): void

  • Parameters

    • v: boolean

    Returns void

grid

id

  • get id(): IgrGridCellIdentifier

  • Optional; An object identifying the cell. It contains rowID, columnID, and rowIndex of the cell.

    Returns IgrGridCellIdentifier

  • set id(v): void

  • Parameters

    Returns void

nativeElement

  • get nativeElement(): HTMLElement

  • Returns HTMLElement

readonly

  • get readonly(): boolean

  • Returns boolean

  • set readonly(v): void

  • Parameters

    • v: boolean

    Returns void

row

  • get row(): IgrRowType

  • Represents the row that the cell belongs to

    Returns IgrRowType

  • set row(v): void

  • Parameters

    Returns void

selected

  • get selected(): boolean

  • Indicates whether the cell is currently selected. It is false, if the sell is not selected, and true, if it is.

    Returns boolean

  • set selected(v): void

  • Parameters

    • v: boolean

    Returns void

title

  • get title(): any

  • An optional title to display for the cell

    Returns any

  • set title(v): void

  • Parameters

    • v: any

    Returns void

validation

  • get validation(): IgrGridValidationState

  • Optional; An object representing the validation state of the cell. Whether it's valid or invalid, and if it has errors

    Returns IgrGridValidationState

  • set validation(v): void

  • Parameters

    Returns void

value

  • get value(): any

  • The current value of the cell.

    Returns any

  • set value(v): void

  • Parameters

    • v: any

    Returns void

visibleColumnIndex

  • get visibleColumnIndex(): number

  • The index of the column that the cell belongs to. It counts only the visible (not hidden) columns

    Returns number

  • set visibleColumnIndex(v): void

  • Parameters

    • v: number

    Returns void

width

  • get width(): string

  • The CSS width of the cell as a string.

    Returns string

  • set width(v): void

  • Parameters

    • v: string

    Returns void

Methods

calculateSizeToFit

  • Optional; A method definition to calculate the size of the cell to fit the content The method can be used to calculate the size of the cell with the longest content and resize all cells to that size

    Parameters

    • range: any

    Returns number

findByName

  • Parameters

    • name: string

    Returns any

setEditMode

  • A method definition to start or end the edit mode of the cell. It takes a boolean value as an argument

    Parameters

    • value: boolean

    Returns void

setNativeElement

  • Parameters

    • element: any

    Returns void

update

  • A method definition to update the value of the cell.

    Parameters

    • value: any

    Returns void