Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrHierarchicalGrid

Hierarchical grid

Callable

  • IgrHierarchicalGrid(): ReactNode

    Returns ReactNode

Accessors

Events

Methods

Properties

Accessors

foreignKey

foreignKey: any

Gets the unique identifier of the parent row. It may be a string or number if primaryKey of the parent grid is set or an object reference of the parent record otherwise.

const foreignKey = this.grid.foreignKey;

selectedCells

selectedCells: IgrCellType[]

Returns an array of the selected IgxGridCells.

Events

onActiveNodeChange

onActiveNodeChange: (args: CustomEvent<IgrActiveNodeChangeEventArgsDetail>) => void

Type declaration

onAdvancedFilteringExpressionsTreeChange

onAdvancedFilteringExpressionsTreeChange: (args: CustomEvent<IgrFilteringExpressionsTree>) => void

Type declaration

onCellClick

onCellClick: (args: CustomEvent<IgrGridCellEventArgsDetail>) => void

Type declaration

onCellEdit

onCellEdit: (args: CustomEvent<IgrGridEditEventArgsDetail>) => void

Type declaration

onCellEditDone

onCellEditDone: (args: CustomEvent<IgrGridEditDoneEventArgsDetail>) => void

Type declaration

onCellEditEnter

onCellEditEnter: (args: CustomEvent<IgrGridEditEventArgsDetail>) => void

Type declaration

onCellEditExit

onCellEditExit: (args: CustomEvent<IgrGridEditDoneEventArgsDetail>) => void

Type declaration

onColumnInit

onColumnInit: (args: CustomEvent<IgrColumn>) => void

Type declaration

onColumnMoving

onColumnMoving: (args: CustomEvent<IgrColumnMovingEventArgsDetail>) => void

Type declaration

onColumnMovingEnd

onColumnMovingEnd: (args: CustomEvent<IgrColumnMovingEndEventArgsDetail>) => void

Type declaration

onColumnMovingStart

onColumnMovingStart: (args: CustomEvent<IgrColumnMovingStartEventArgsDetail>) => void

Type declaration

onColumnPin

onColumnPin: (args: CustomEvent<IgrPinColumnCancellableEventArgsDetail>) => void

Type declaration

onColumnPinned

onColumnPinned: (args: CustomEvent<IgrPinColumnEventArgsDetail>) => void

Type declaration

onColumnResized

onColumnResized: (args: CustomEvent<IgrColumnResizeEventArgsDetail>) => void

Type declaration

onColumnsAutogenerated

onColumnsAutogenerated: (args: CustomEvent<IgcColumnsAutoGeneratedEventArgs>) => void

Type declaration

onColumnSelectionChanging

onColumnSelectionChanging: (args: CustomEvent<IgrColumnSelectionEventArgsDetail>) => void

Type declaration

onColumnVisibilityChanged

onColumnVisibilityChanged: (args: CustomEvent<IgrColumnVisibilityChangedEventArgsDetail>) => void

Type declaration

onColumnVisibilityChanging

onColumnVisibilityChanging: (args: CustomEvent<IgrColumnVisibilityChangingEventArgsDetail>) => void

Type declaration

onContextMenu

onContextMenu: (args: CustomEvent<IgrGridContextMenuEventArgsDetail>) => void

Type declaration

onDataChanged

onDataChanged: (args: CustomEvent<IgrForOfDataChangeEventArgsDetail>) => void

Type declaration

onDataChanging

onDataChanging: (args: CustomEvent<IgrForOfDataChangeEventArgsDetail>) => void

Type declaration

onDataPreLoad

onDataPreLoad: (args: CustomEvent<IgrForOfState>) => void

Type declaration

onDoubleClick

onDoubleClick: (args: CustomEvent<IgrGridCellEventArgsDetail>) => void

Type declaration

onExpansionStatesChange

onExpansionStatesChange: (args: CustomEvent<Map<any, boolean>>) => void

Type declaration

onFiltering

onFiltering: (args: CustomEvent<IgrFilteringEventArgsDetail>) => void

Type declaration

onFilteringDone

onFilteringDone: (args: CustomEvent<IgrFilteringExpressionsTree>) => void

Type declaration

onFilteringExpressionsTreeChange

onFilteringExpressionsTreeChange: (args: CustomEvent<IgrFilteringExpressionsTree>) => void

Type declaration

onFormGroupCreated

onFormGroupCreated: (args: CustomEvent<IgrGridFormGroupCreatedEventArgsDetail>) => void

Type declaration

onGridCopy

onGridCopy: (args: CustomEvent<IgrGridClipboardEvent>) => void

Type declaration

onGridKeydown

onGridKeydown: (args: CustomEvent<IgrGridKeydownEventArgsDetail>) => void

Type declaration

onGridScroll

onGridScroll: (args: CustomEvent<IgrGridScrollEventArgsDetail>) => void

Type declaration

onRangeSelected

onRangeSelected: (args: CustomEvent<IgrGridSelectionRange>) => void

Type declaration

onRendered

onRendered: (args: CustomEvent<boolean>) => void

Type declaration

onRowAdd

onRowAdd: (args: CustomEvent<IgrRowDataCancelableEventArgsDetail>) => void

Type declaration

onRowAdded

onRowAdded: (args: CustomEvent<IgrRowDataEventArgsDetail>) => void

Type declaration

onRowClick

onRowClick: (args: CustomEvent<IgrGridRowEventArgsDetail>) => void

Type declaration

onRowDelete

onRowDelete: (args: CustomEvent<IgrRowDataCancelableEventArgsDetail>) => void

Type declaration

onRowDeleted

onRowDeleted: (args: CustomEvent<IgrRowDataEventArgsDetail>) => void

Type declaration

onRowDragEnd

onRowDragEnd: (args: CustomEvent<IgrRowDragEndEventArgsDetail>) => void

Type declaration

onRowDragStart

onRowDragStart: (args: CustomEvent<IgrRowDragStartEventArgsDetail>) => void

Type declaration

onRowEdit

onRowEdit: (args: CustomEvent<IgrGridEditEventArgsDetail>) => void

Type declaration

onRowEditDone

onRowEditDone: (args: CustomEvent<IgrGridEditDoneEventArgsDetail>) => void

Type declaration

onRowEditEnter

onRowEditEnter: (args: CustomEvent<IgrGridEditEventArgsDetail>) => void

Type declaration

onRowEditExit

onRowEditExit: (args: CustomEvent<IgrGridEditDoneEventArgsDetail>) => void

Type declaration

onRowPinned

onRowPinned: (args: CustomEvent<IgrPinRowEventArgsDetail>) => void

Type declaration

onRowPinning

onRowPinning: (args: CustomEvent<IgrPinRowEventArgsDetail>) => void

Type declaration

onRowSelectionChanging

onRowSelectionChanging: (args: CustomEvent<IgrRowSelectionEventArgsDetail>) => void

Type declaration

onRowToggle

onRowToggle: (args: CustomEvent<IgrRowToggleEventArgsDetail>) => void

Type declaration

onSelected

onSelected: (args: CustomEvent<IgrGridCellEventArgsDetail>) => void

Type declaration

onSelectedRowsChange

onSelectedRowsChange: (args: CustomEvent<any[]>) => void

Type declaration

onSorting

onSorting: (args: CustomEvent<IgrSortingEventArgsDetail>) => void

Type declaration

onSortingDone

onSortingDone: (args: CustomEvent<IgrSortingExpression[]>) => void

Type declaration

onSortingExpressionsChange

onSortingExpressionsChange: (args: CustomEvent<IgrSortingExpression[]>) => void

Type declaration

onToolbarExporting

onToolbarExporting: (args: CustomEvent<IgrGridToolbarExportEventArgsDetail>) => void

Type declaration

onValidationStatusChange

onValidationStatusChange: (args: CustomEvent<IgrGridValidationStatusEventArgsDetail>) => void

Type declaration

Methods

getCellByColumn

  • getCellByColumn(rowIndex: number, columnField: string): IgrCellType

    Returns a CellType object that matches the conditions.

    Example

    const myCell = this.grid1.getCellByColumn(2, "UnitPrice");

    Parameters

    • rowIndex: number
    • columnField: string

    Returns IgrCellType

getCellByKey

  • getCellByKey(rowSelector: any, columnField: string): IgrCellType

    Returns a CellType object that matches the conditions.

    Remarks

    Requires that the primaryKey property is set.

    Example

    grid.getCellByKey(1, 'index');

    Parameters

    • rowSelector: any

      match any rowID

    • columnField: string

    Returns IgrCellType

getDefaultExpandState

  • getDefaultExpandState(record: any): void

    Parameters

    • record: any

    Returns void

getRowByIndex

  • getRowByIndex(index: number): IgrRowType

    Returns the RowType by index.

    Example

    const myRow = this.grid1.getRowByIndex(1);

    Parameters

    • index: number

    Returns IgrRowType

getRowByKey

  • getRowByKey(key: any): IgrRowType

    Returns the RowType by key.

    Example

    const myRow = this.grid1.getRowByKey(1);

    Parameters

    • key: any

    Returns IgrRowType

pinRow

  • pinRow(rowID: any, index?: number): boolean

    Pin the row by its id.

    Remarks

    ID is either the primaryKey value or the data record instance.

    Example

    this.grid.pinRow(rowID);

    Parameters

    • rowID: any

      The row id - primaryKey value or the data record instance.

    • index: number

      The index at which to insert the row in the pinned collection.

    Returns boolean

unpinRow

  • unpinRow(rowID: any): boolean

    Unpin the row by its id.

    Remarks

    ID is either the primaryKey value or the data record instance.

    Example

    this.grid.unpinRow(rowID);

    Parameters

    • rowID: any

      The row id - primaryKey value or the data record instance.

    Returns boolean

Properties

advancedFilteringExpressionsTree

advancedFilteringExpressionsTree: IgrFilteringExpressionsTree

childLayoutList

childLayoutList: IgrRowIsland[]

data

data: any[]

Gets/Sets the array of data that populates the component.

<igx-hierarchical-grid [data]="Data" [autoGenerate]="true"></igx-hierarchical-grid>

expandChildren

expandChildren: boolean

Sets if all immediate children of the IgxHierarchicalGridComponent should be expanded/collapsed. Default value is false.

<igx-hierarchical-grid [id]="'igx-grid-1'" [data]="Data" [autoGenerate]="true" [expandChildren]="true"></igx-hierarchical-grid>

id

id: string

Gets/Sets the value of the id attribute.

totalItemCount

totalItemCount: number

Gets/Sets the total number of records in the data source.