Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Interface RowType

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

Implemented by

Properties

Properties

Optional addRowUI

addRowUI?: boolean

Optional beginAddRow

beginAddRow?: (() => void)

Optional A method to handle adding a new row

Type declaration

    • (): void

    • Returns void

Optional cells

cells?: QueryList<CellType> | CellType[]

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

Optional children

children?: RowType[]

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

Optional data

data?: any

Optional delete

delete?: (() => any)

Optional A method to handle deleting rows

Type declaration

    • (): any

    • Returns any

Optional deleted

deleted?: boolean

Optional Indicades 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 Indicades whether the row is currently focused.

grid

grid: GridType

Represent the grid instance, the row belongs to

Optional groupRow

groupRow?: IGroupByRecord

Optional hasChildren

hasChildren?: boolean

Optional Indicades whether the current row has any child rows

Optional inEditMode

inEditMode?: boolean

Optional Indicades whether the row is currently being edited.

index

index: number

The index of the row within the grid

Optional isGroupByRow

isGroupByRow?: boolean

Indicates whether the row is grouped.

Optional isSummaryRow

isSummaryRow?: boolean

Optional key

key?: any

Optional nativeElement

nativeElement?: HTMLElement

Represents the native HTML element of the row itself

Optional onClick

onClick?: ((event) => void)

Optional A method to handle click event on the row It takes a MouseEvent as an argument

Type declaration

    • (event): void

    • Parameters

      • event: MouseEvent

      Returns void

Optional onRowSelectorClick

onRowSelectorClick?: ((event) => void)

Type declaration

    • (event): void

    • Parameters

      • event: MouseEvent

      Returns void

Optional parent

parent?: RowType

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 pin

pin?: (() => void)

Optional A method to handle pinning a row

Type declaration

    • (): void

    • Returns void

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 summaries

summaries?: Map<string, IgxSummaryResult[]>

Optional A map of column field names to the summary results for the row.

Optional treeRow

treeRow?: ITreeGridRecord

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 unpin

unpin?: (() => void)

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

Type declaration

    • (): void

    • 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

Type declaration

    • (value): void

    • Parameters

      • value: any

      Returns void

Optional Readonly validation

validation?: IGridValidationState

viewIndex

viewIndex: number

Optional virtDirRow

virtDirRow?: IgxGridForOfDirective<ColumnType, ColumnType[]>

Optional Virtualization state of data record added from cache