Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcRowType

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

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional addRowUI

addRowUI?: boolean

Optional cells

cells?: IgcCellType[]

Optional A list or an array of cells, that belong to the row

Optional children

children?: IgcRowType[]

Optional Contains the child rows of the current row, if there are any.

Optional data

data?: any

Optional deleted

deleted?: boolean

Optional Indicates whether the row is marked for deletion.

Optional disabled

disabled?: boolean

Optional Indicates whether the current row is disabled

Optional expanded

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

Optional focused

focused?: boolean

Optional Indicates whether the row is currently focused.

Optional groupRow

groupRow?: IgcGroupByRecord

Optional hasChildren

hasChildren?: boolean

Optional Indicates whether the current row has any child rows

Optional inEditMode

inEditMode?: boolean

Optional Indicates whether the row is currently being edited.

Optional isGroupByRow

isGroupByRow?: boolean

Indicates whether the row is grouped.

Optional isSummaryRow

isSummaryRow?: boolean

Optional key

key?: any

Optional parent

parent?: IgcRowType

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

Optional pinned

pinned?: boolean

Optional Indicates whether the current row is pinned.

Optional selected

selected?: boolean

Optional Indicates whether the current row is selected

Optional treeRow

treeRow?: IgcTreeGridRecord

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.

Optional validation

validation?: IgcGridValidationState

Accessors

grid

  • get grid(): IgcGridBaseDirective

  • Returns IgcGridBaseDirective

  • set grid(value): void

  • Represent the grid instance, the row belongs to

    Parameters

    Returns void

index

  • get index(): number

  • Returns number

  • set index(value): void

  • The index of the row within the grid

    Parameters

    • value: number

    Returns void

viewIndex

  • get viewIndex(): number

  • Returns number

  • set viewIndex(value): void

  • Parameters

    • value: number

    Returns void

Methods

Optional delete

  • delete(): any

  • Optional A method to handle deleting rows

    Returns any

Optional pin

  • pin(): void

  • Optional A method to handle pinning a row

    Returns void

Optional unpin

  • unpin(): void

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

    Returns void

Optional update

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