Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcCellType

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

Optional cellID

cellID?: any

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

Optional id

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

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

Type declaration

  • columnID: number
  • rowID: any
  • rowIndex: number

Optional readonly

readonly?: boolean

Optional title

title?: any

An optional title to display for the cell

Optional validation

validation?: IgcGridValidationState

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

Optional visibleColumnIndex

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): void

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

    Parameters

    • value: boolean

    Returns void

column

  • get column(): IgcColumnComponent

  • Returns IgcColumnComponent

  • set column(value): void

  • Represents the column that the cell belongs to.

    Parameters

    Returns void

editMode

  • get editMode(): boolean

  • Returns boolean

  • set editMode(value): void

  • Indicates whether the cell is currently in edit mode.

    Parameters

    • value: boolean

    Returns void

editValue

  • get editValue(): any

  • Returns any

  • set editValue(value): void

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

    Parameters

    • value: any

    Returns void

editable

  • get editable(): boolean

  • Returns boolean

  • set editable(value): void

  • Indicates whether the cell can be edited.

    Parameters

    • value: boolean

    Returns void

grid

  • get grid(): IgcGridBaseDirective

  • Returns IgcGridBaseDirective

  • set grid(value): void

  • Represents the grid instance containing the cell

    Parameters

    Returns void

row

  • get row(): IgcRowType

  • Returns IgcRowType

  • set row(value): void

  • Represents the row that the cell belongs to

    Parameters

    Returns void

selected

  • get selected(): boolean

  • Returns boolean

  • set selected(value): 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): void

  • The current value of the cell.

    Parameters

    • value: any

    Returns void

width

  • get width(): string

  • Returns string

  • set width(value): void

  • The CSS width of the cell as a string.

    Parameters

    • value: string

    Returns void

Methods

Optional calculateSizeToFit

  • calculateSizeToFit(range): 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

Optional setEditMode

  • setEditMode(value): 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): void

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

    Parameters

    • value: any

    Returns void