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

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

OptionalcellID

cellID?: any

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

Optionalid

id?: { columnID: number; rowID: any; rowIndex: number }

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

Type declaration

Optionalreadonly

readonly?: boolean

Optionaltitle

title?: any

An optional title to display for the cell

Optionalvalidation

validation?: IgrGridValidationState

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

OptionalvisibleColumnIndex

visibleColumnIndex?: number

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

Accessors

active

  • get active(): boolean

    Returns boolean

  • set active(value: boolean): void

    Indicates whether the cell is currently active (focused).

    Parameters

    • value: boolean

    Returns void

column

  • get column(): IgrColumn

    Returns IgrColumn

  • set column(value: IgrColumn): void

    Represents the column that the cell belongs to.

    Parameters

    Returns void

editable

  • get editable(): boolean

    Returns boolean

  • set editable(value: boolean): void

    Indicates whether the cell can be edited.

    Parameters

    • value: boolean

    Returns void

editMode

  • get editMode(): boolean

    Returns boolean

  • set editMode(value: boolean): void

    Indicates whether the cell is currently in edit mode.

    Parameters

    • value: boolean

    Returns void

editValue

  • get editValue(): any

    Returns any

  • set editValue(value: any): void

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

    Parameters

    • value: any

    Returns void

grid

row

  • get row(): IgrRowType

    Returns IgrRowType

  • set row(value: IgrRowType): void

    Represents the row that the cell belongs to

    Parameters

    Returns void

selected

  • get selected(): boolean

    Returns boolean

  • set selected(value: boolean): void

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

    Parameters

    • value: boolean

    Returns void

value

  • get value(): any

    Returns any

  • set value(value: any): void

    The current value of the cell.

    Parameters

    • value: any

    Returns void

width

  • get width(): string

    Returns string

  • set width(value: string): void

    The CSS width of the cell as a string.

    Parameters

    • value: string

    Returns void

Methods

OptionalcalculateSizeToFit

  • calculateSizeToFit(range: any): number

    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

OptionalsetEditMode

  • setEditMode(value: boolean): void

    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

update

  • update(value: any): void

    A method definition to update the value of the cell.

    Parameters

    • value: any

    Returns void