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

Hierarchy

Hierarchy

  • IgrRowType

Constructors

  • Returns IgrRowType

Accessors

  • get addRowUI(): boolean
  • Returns boolean

  • set addRowUI(v): void
  • Parameters

    • v: boolean

    Returns void

  • get cells(): IgrCellType[]
  • Optional A list or an array of cells, that belong to the row

    Returns IgrCellType[]

  • set cells(v): void
  • Parameters

    Returns void

  • get children(): IgrRowType[]
  • Optional Contains the child rows of the current row, if there are any.

    Returns IgrRowType[]

  • set children(v): void
  • Parameters

    Returns void

  • get data(): any
  • Returns any

  • set data(v): void
  • Parameters

    • v: any

    Returns void

  • get deleted(): boolean
  • Optional Indicates whether the row is marked for deletion.

    Returns boolean

  • set deleted(v): void
  • Parameters

    • v: boolean

    Returns void

  • get disabled(): boolean
  • Optional Indicates whether the current row is disabled

    Returns boolean

  • set disabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get ephemeralKey(): string
  • Returns string

  • get expanded(): boolean
  • Optional Indicates whether the current row is expanded. The value is true, if the row is expanded and false, if it is collapsed

    Returns boolean

  • set expanded(v): void
  • Parameters

    • v: boolean

    Returns void

  • get focused(): boolean
  • Optional Indicates whether the row is currently focused.

    Returns boolean

  • set focused(v): void
  • Parameters

    • v: boolean

    Returns void

  • get groupRow(): IgrGroupByRecord
  • Returns IgrGroupByRecord

  • set groupRow(v): void
  • Parameters

    Returns void

  • get hasChildren(): boolean
  • Optional Indicates whether the current row has any child rows

    Returns boolean

  • set hasChildren(v): void
  • Parameters

    • v: boolean

    Returns void

  • get inEditMode(): boolean
  • Optional Indicates whether the row is currently being edited.

    Returns boolean

  • set inEditMode(v): void
  • Parameters

    • v: boolean

    Returns void

  • get index(): number
  • The index of the row within the grid

    Returns number

  • set index(v): void
  • Parameters

    • v: number

    Returns void

  • get isGroupByRow(): boolean
  • Indicates whether the row is grouped.

    Returns boolean

  • set isGroupByRow(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isSummaryRow(): boolean
  • Returns boolean

  • set isSummaryRow(v): void
  • Parameters

    • v: boolean

    Returns void

  • get key(): any
  • Returns any

  • set key(v): void
  • Parameters

    • v: any

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get parent(): IgrRowType
  • Optional Contains the parent row of the current row, if it has one. If the parent row exist, it means that the current row is a child row

    Returns IgrRowType

  • set parent(v): void
  • Parameters

    Returns void

  • get pinned(): boolean
  • Optional Indicates whether the current row is pinned.

    Returns boolean

  • set pinned(v): void
  • Parameters

    • v: boolean

    Returns void

  • get selected(): boolean
  • Optional Indicates whether the current row is selected

    Returns boolean

  • set selected(v): void
  • Parameters

    • v: boolean

    Returns void

  • get treeRow(): IgrTreeGridRecord
  • Optional Represents the hierarchical record associated with the row (for tree grids). It is of type ITreeGridRecord, which contains the data, children, the hierarchical level, etc.

    Returns IgrTreeGridRecord

  • set treeRow(v): void
  • Parameters

    Returns void

  • get viewIndex(): number
  • Returns number

  • set viewIndex(v): void
  • Parameters

    • v: number

    Returns void

Methods

  • Optional A method to handle deleting rows

    Returns any

  • Parameters

    • name: string

    Returns any

  • Optional A method to handle pinning a row

    Returns void

  • Parameters

    • element: any

    Returns void

  • Optional A method to handle unpinning a row, that has been pinned

    Returns void

  • Optional A method to handle changing the value of elements of the row It takes the new value as an argument

    Parameters

    • value: any

    Returns void