Hierarchical grid

Properties

Section titled "Properties"

advancedFilteringExpressionsTree

Section titled "advancedFilteringExpressionsTree" 
advancedFilteringExpressionsTree: IgrFilteringExpressionsTree

childLayoutList

Section titled "childLayoutList" 
childLayoutList: IgrRowIslandComponent[]

data

Section titled "data"

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

 
data: any[]

expandChildren

Section titled "expandChildren"

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

 
expandChildren: boolean

hasChildrenKey

Section titled "hasChildrenKey"

Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator.

 
hasChildrenKey: string

id

Section titled "id"

Gets/Sets the value of the id attribute.

 
id: string

resourceStrings

Section titled "resourceStrings"

Gets/Sets the resource strings.

 
resourceStrings: IgrGridResourceStrings

rootGrid

Section titled "rootGrid" 
rootGrid: IgrGridBaseDirective

showExpandAll

Section titled "showExpandAll"

Gets/Sets whether the expand/collapse all button in the header should be rendered.

 
showExpandAll: boolean

totalItemCount

Section titled "totalItemCount"

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

 
totalItemCount: number

addRowEmptyTemplate

Section titled "addRowEmptyTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

addRowEmptyTemplate: (ctx: void) => React.ReactNode

allowAdvancedFiltering

Section titled "allowAdvancedFiltering"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

allowAdvancedFiltering: boolean

allowFiltering

Section titled "allowFiltering"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

allowFiltering: boolean

autoGenerate

Section titled "autoGenerate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

autoGenerate: boolean

autoGenerateExclude

Section titled "autoGenerateExclude"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

autoGenerateExclude: string[]

batchEditing

Section titled "batchEditing"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

batchEditing: boolean

cellMergeMode

Section titled "cellMergeMode"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

cellMergeMode: GridCellMergeMode

cellSelection

Section titled "cellSelection"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

cellSelection: GridSelectionMode

clipboardOptions

Section titled "clipboardOptions"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

clipboardOptions: IgrClipboardOptions

columnSelection

Section titled "columnSelection"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

columnSelection: GridSelectionMode

columnWidth

Section titled "columnWidth"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

columnWidth: string

dataCloneStrategy

Section titled "dataCloneStrategy"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

dataCloneStrategy: IgrDataCloneStrategy

dragGhostCustomTemplate

Section titled "dragGhostCustomTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

dragGhostCustomTemplate: (ctx: IgrGridRowDragGhostContext) => React.ReactNode

dragIndicatorIconTemplate

Section titled "dragIndicatorIconTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

dragIndicatorIconTemplate: (ctx: IgrGridEmptyTemplateContext) => React.ReactNode

emptyFilteredGridMessage

Section titled "emptyFilteredGridMessage"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

emptyFilteredGridMessage: string

emptyGridMessage

Section titled "emptyGridMessage"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

emptyGridMessage: string

emptyGridTemplate

Section titled "emptyGridTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

emptyGridTemplate: (ctx: IgrGridTemplateContext) => React.ReactNode

excelStyleHeaderIconTemplate

Section titled "excelStyleHeaderIconTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

excelStyleHeaderIconTemplate: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

expansionStates

Section titled "expansionStates"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

expansionStates: Map<any, boolean>

filteringExpressionsTree

Section titled "filteringExpressionsTree"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

filteringExpressionsTree: IgrFilteringExpressionsTree

filteringLogic

Section titled "filteringLogic"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

filteringLogic: FilteringLogic

filterMode

Section titled "filterMode"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

filterMode: FilterMode

filterStrategy

Section titled "filterStrategy"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

filterStrategy: IgrFilteringStrategy

headerCollapsedIndicatorTemplate

Section titled "headerCollapsedIndicatorTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

headerCollapsedIndicatorTemplate: (ctx: IgrGridTemplateContext) => React.ReactNode

headerExpandedIndicatorTemplate

Section titled "headerExpandedIndicatorTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

headerExpandedIndicatorTemplate: (ctx: IgrGridTemplateContext) => React.ReactNode

headSelectorTemplate

Section titled "headSelectorTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

headSelectorTemplate: (ctx: IgrHeadSelectorTemplateContext) => React.ReactNode

height

Section titled "height"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

height: string

hideRowSelectors

Section titled "hideRowSelectors"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

hideRowSelectors: boolean

isLoading

Section titled "isLoading"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

isLoading: boolean

loadingGridTemplate

Section titled "loadingGridTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

loadingGridTemplate: (ctx: IgrGridTemplateContext) => React.ReactNode

locale

Section titled "locale"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

locale: string

mergeStrategy

Section titled "mergeStrategy"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

mergeStrategy: IgrGridMergeStrategy

moving

Section titled "moving"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

moving: boolean

outlet

Section titled "outlet"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

outlet: IgrOverlayOutletDirective

pagingMode

Section titled "pagingMode"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

pagingMode: GridPagingMode

pinning

Section titled "pinning"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

pinning: IgrPinningConfig

primaryKey

Section titled "primaryKey"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

primaryKey: string

rowAddTextTemplate

Section titled "rowAddTextTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowAddTextTemplate: (ctx: IgrGridEmptyTemplateContext) => React.ReactNode

rowClasses

Section titled "rowClasses"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowClasses: any

rowCollapsedIndicatorTemplate

Section titled "rowCollapsedIndicatorTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowCollapsedIndicatorTemplate: (ctx: IgrGridRowTemplateContext) => React.ReactNode

rowDraggable

Section titled "rowDraggable"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowDraggable: boolean

rowEditable

Section titled "rowEditable"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowEditable: boolean

rowEditActionsTemplate

Section titled "rowEditActionsTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowEditActionsTemplate: (ctx: IgrGridRowEditActionsTemplateContext) => React.ReactNode

rowEditTextTemplate

Section titled "rowEditTextTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowEditTextTemplate: (ctx: IgrGridRowEditTextTemplateContext) => React.ReactNode

rowExpandedIndicatorTemplate

Section titled "rowExpandedIndicatorTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowExpandedIndicatorTemplate: (ctx: IgrGridRowTemplateContext) => React.ReactNode

rowHeight

Section titled "rowHeight"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowHeight: number

rowSelection

Section titled "rowSelection"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowSelection: GridSelectionMode

rowSelectorTemplate

Section titled "rowSelectorTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowSelectorTemplate: (ctx: IgrRowSelectorTemplateContext) => React.ReactNode

rowStyles

Section titled "rowStyles"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

rowStyles: any

selectedRows

Section titled "selectedRows"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

selectedRows: any[]

selectRowOnClick

Section titled "selectRowOnClick"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

selectRowOnClick: boolean

shouldGenerate

Section titled "shouldGenerate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

shouldGenerate: boolean

showSummaryOnCollapse

Section titled "showSummaryOnCollapse"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

showSummaryOnCollapse: boolean

snackbarDisplayTime

Section titled "snackbarDisplayTime"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

snackbarDisplayTime: number

sortAscendingHeaderIconTemplate

Section titled "sortAscendingHeaderIconTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

sortAscendingHeaderIconTemplate: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

sortDescendingHeaderIconTemplate

Section titled "sortDescendingHeaderIconTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

sortDescendingHeaderIconTemplate: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

sortHeaderIconTemplate

Section titled "sortHeaderIconTemplate"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

sortHeaderIconTemplate: (ctx: IgrGridHeaderTemplateContext) => React.ReactNode

sortingExpressions

Section titled "sortingExpressions"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

sortingExpressions: IgrSortingExpression[]

sortingOptions

Section titled "sortingOptions"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

sortingOptions: IgrSortingOptions

sortStrategy

Section titled "sortStrategy"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

sortStrategy: IgrGridSortingStrategy

summaryCalculationMode

Section titled "summaryCalculationMode"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

summaryCalculationMode: GridSummaryCalculationMode

summaryPosition

Section titled "summaryPosition"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

summaryPosition: GridSummaryPosition

summaryRowHeight

Section titled "summaryRowHeight"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

summaryRowHeight: number

totalRecords

Section titled "totalRecords"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

totalRecords: number

validationTrigger

Section titled "validationTrigger"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

validationTrigger: GridValidationTrigger

width

Section titled "width"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

width: string

Accessors

Section titled "Accessors"

foreignKey

Section titled "foreignKey"

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.

get foreignKey(): any

Returns any

selectedCells

Section titled "selectedCells"

Returns an array of the selected GridCells.

get selectedCells(): IgrCellType[]

Returns IgrCellType[]

actionStripComponents

Section titled "actionStripComponents"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

get actionStripComponents(): IgcActionStripToken[]

Returns IgcActionStripToken[]

columnList

Section titled "columnList"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

get columnList(): IgrColumnComponent[]

Returns IgrColumnComponent[]

columns

Section titled "columns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets an array of ColumnComponents.

get columns(): IgrColumnComponent[]

Example

const colums = this.grid.columns.

Returns IgrColumnComponent[]

dataRowList

Section titled "dataRowList"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

A list of currently rendered GridRowComponent's.

get dataRowList(): IgrRowDirective[]

Example

const dataList = this.grid.dataRowList;

Returns IgrRowDirective[]

dataView

Section titled "dataView"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid.

get dataView(): any[]

Example

const dataView = this.grid.dataView;

Returns any[]

defaultRowHeight

Section titled "defaultRowHeight"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets the default row height.

get defaultRowHeight(): number

Example

const rowHeigh = this.grid.defaultRowHeight;

Returns number

filteredData

Section titled "filteredData"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns an array of objects containing the filtered data.

get filteredData(): any

Example

let filteredData = this.grid.filteredData;

Returns any

filteredSortedData

Section titled "filteredSortedData"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns an array containing the filtered sorted data.

get filteredSortedData(): any[]

Example

const filteredSortedData = this.grid1.filteredSortedData;

Returns any[]

hiddenColumnsCount

Section titled "hiddenColumnsCount"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets the number of hidden columns.

get hiddenColumnsCount(): number

Example

const hiddenCol = this.grid.hiddenColumnsCount;
``

Returns number

lastSearchInfo

Section titled "lastSearchInfo"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Represents the last search information.

get lastSearchInfo(): IgrSearchInfo

Returns IgrSearchInfo

paginationComponents

Section titled "paginationComponents"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

get paginationComponents(): IgrPaginatorComponent[]

Returns IgrPaginatorComponent[]

pinnedColumns

Section titled "pinnedColumns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets an array of the pinned ColumnComponents.

get pinnedColumns(): IgrColumnComponent[]

Example

const pinnedColumns = this.grid.pinnedColumns.

Returns IgrColumnComponent[]

pinnedColumnsCount

Section titled "pinnedColumnsCount"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets the number of pinned columns.

get pinnedColumnsCount(): number

Returns number

pinnedEndColumns

Section titled "pinnedEndColumns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets an array of the pinned to the right ColumnComponents.

get pinnedEndColumns(): IgrColumnComponent[]

Example

const pinnedColumns = this.grid.pinnedEndColumns.

Returns IgrColumnComponent[]

pinnedRows

Section titled "pinnedRows"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets an array of the pinned RowComponents.

get pinnedRows(): IgrGridRowComponent[]

Example

const pinnedRow = this.grid.pinnedRows;

Returns IgrGridRowComponent[]

pinnedStartColumns

Section titled "pinnedStartColumns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets an array of the pinned to the left ColumnComponents.

get pinnedStartColumns(): IgrColumnComponent[]

Example

const pinnedColumns = this.grid.pinnedStartColumns.

Returns IgrColumnComponent[]

rowList

Section titled "rowList"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

A list of GridRowComponent.

get rowList(): IgrRowDirective[]

Example

const rowList = this.grid.rowList;

Returns IgrRowDirective[]

toolbar

Section titled "toolbar"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

get toolbar(): IgrGridToolbarComponent[]

Returns IgrGridToolbarComponent[]

unpinnedColumns

Section titled "unpinnedColumns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets an array of unpinned ColumnComponents.

get unpinnedColumns(): IgrColumnComponent[]

Example

const unpinnedColumns = this.grid.unpinnedColumns.

Returns IgrColumnComponent[]

virtualizationState

Section titled "virtualizationState"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns the state of the grid virtualization.

get virtualizationState(): IgrForOfState

Example

const gridVirtState = this.grid1.virtualizationState;

Returns IgrForOfState

visibleColumns

Section titled "visibleColumns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns an array of visible ColumnComponents.

get visibleColumns(): IgrColumnComponent[]

Example

const visibleColumns = this.grid.visibleColumns.

Returns IgrColumnComponent[]

Methods

Section titled "Methods"

getCellByColumn

Section titled "getCellByColumn"

Returns a CellType object that matches the conditions.

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

Parameters

  • rowIndex: number
  • columnField: string

Returns IgrCellType

Example

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

getCellByKey

Section titled "getCellByKey"

Returns a CellType object that matches the conditions.

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

Parameters

  • rowSelector: any

    match any rowID
  • columnField: string

Returns IgrCellType

Example

grid.getCellByKey(1, 'index');

getDefaultExpandState

Section titled "getDefaultExpandState" 
getDefaultExpandState(record: any): void

Parameters

  • record: any

Returns void

getRowByIndex

Section titled "getRowByIndex"

Returns the RowType by index.

getRowByIndex(index: number): IgrRowType

Parameters

  • index: number

Returns IgrRowType

Example

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

getRowByKey

Section titled "getRowByKey"

Returns the RowType by key.

getRowByKey(key: any): IgrRowType

Parameters

  • key: any

Returns IgrRowType

Example

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

pinRow

Section titled "pinRow"

Pin the row by its id.

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

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

Example

this.grid.pinRow(rowID);

unpinRow

Section titled "unpinRow"

Unpin the row by its id.

unpinRow(rowID: any): boolean

Parameters

  • rowID: any

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

Returns boolean

Example

this.grid.unpinRow(rowID);

addRow

Section titled "addRow"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Creates a new GridRowComponent and adds the data record to the end of the data source.

addRow(data: any): void

Parameters

  • data: any

Returns void

Example

this.grid1.addRow(record);

beginAddRowById

Section titled "beginAddRowById"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Enters add mode by spawning the UI under the specified row by rowID.

beginAddRowById(rowID: any, asChild: boolean): void

Parameters

  • rowID: any

    The rowID to spawn the add row UI for, or null to spawn it as the first record in the data view
  • asChild: boolean

    Whether the record should be added as a child. Only applicable to igxTreeGrid.

Returns void

Example

this.grid.beginAddRowById('ALFKI');
this.grid.beginAddRowById('ALFKI', true);
this.grid.beginAddRowById(null);

beginAddRowByIndex

Section titled "beginAddRowByIndex"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Enters add mode by spawning the UI at the specified index.

beginAddRowByIndex(index: number): void

Parameters

  • index: number

    The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length

Returns void

Example

this.grid.beginAddRowByIndex(0);

clearCellSelection

Section titled "clearCellSelection"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Deselect selected cells.

clearCellSelection(): void

Returns void

Example

this.grid.clearCellSelection();

clearFilter

Section titled "clearFilter"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

If name is provided, clears the filtering state of the corresponding ColumnComponent.

clearFilter(name: string): void

Parameters

  • name: string

Returns void

Example

this.grid.clearFilter();

clearSearch

Section titled "clearSearch"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Removes all the highlights in the cell.

clearSearch(): void

Returns void

Example

this.grid.clearSearch();

clearSort

Section titled "clearSort"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

If name is provided, clears the sorting state of the corresponding ColumnComponent.

clearSort(name: string): void

Parameters

  • name: string

Returns void

Example

this.grid.clearSort();

closeAdvancedFilteringDialog

Section titled "closeAdvancedFilteringDialog"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Closes the advanced filtering dialog.

closeAdvancedFilteringDialog(applyChanges: boolean): void

Parameters

  • applyChanges: boolean

    indicates whether the changes should be applied

Returns void

collapseAll

Section titled "collapseAll"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Collapses all rows.

collapseAll(): void

Returns void

Example

this.grid.collapseAll();

collapseRow

Section titled "collapseRow"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Collapses the row by its id.

collapseRow(rowID: any): void

Parameters

  • rowID: any

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

Returns void

Example

this.grid.collapseRow(rowID);

deleteRow

Section titled "deleteRow"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Removes the GridRowComponent and the corresponding data record by primary key.

deleteRow(rowSelector: any): any

Parameters

  • rowSelector: any

Returns any

Example

this.grid1.deleteRow(0);

deselectAllColumns

Section titled "deselectAllColumns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Deselects all columns

deselectAllColumns(): void

Returns void

Example

this.grid.deselectAllColumns();

deselectAllRows

Section titled "deselectAllRows"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Deselects all rows

deselectAllRows(onlyFilterData: boolean): void

Parameters

  • onlyFilterData: boolean

Returns void

Example

this.grid.deselectAllRows();

deselectColumns

Section titled "deselectColumns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Deselect specified columns by field.

deselectColumns(columns: string[] | IgrColumnComponent[]): void

Parameters

  • columns: string[] | IgrColumnComponent[]

Returns void

Example

this.grid.deselectColumns(['ID','Name']);

deselectRows

Section titled "deselectRows"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Deselect specified rows by ID.

deselectRows(rowIDs: any[]): void

Parameters

  • rowIDs: any[]

Returns void

Example

this.grid.deselectRows([1,2,5]);

disableSummaries

Section titled "disableSummaries"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Disable summaries for the specified column.

disableSummaries(rest: any[]): void

Parameters

  • rest: any[]

Returns void

Example

grid.disableSummaries('ProductName');

enableSummaries

Section titled "enableSummaries"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Enables summaries for the specified column and applies your customSummary.

enableSummaries(rest: any[]): void

Parameters

  • rest: any[]

Returns void

Example

grid.enableSummaries([{ fieldName: 'ProductName' }, { fieldName: 'ID' }]);

Enable summaries for the listed columns.

endEdit

Section titled "endEdit"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Finishes the row transactions on the current row and returns whether the grid editing was canceled.

endEdit(commit: boolean, evt: any): boolean

Parameters

  • commit: boolean
  • evt: any

Returns boolean

expandAll

Section titled "expandAll"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Expands all rows.

expandAll(): void

Returns void

Example

this.grid.expandAll();

expandRow

Section titled "expandRow"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Expands the row by its id.

expandRow(rowID: any): void

Parameters

  • rowID: any

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

Returns void

Example

this.grid.expandRow(rowID);

filter

Section titled "filter"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Filters a single ColumnComponent.

filter(name: string, value: any, conditionOrExpressionTree: IgrFilteringExpressionsTree | IgrFilteringOperation, ignoreCase: boolean): void

Parameters

Returns void

filterGlobal

Section titled "filterGlobal"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Filters all the ColumnComponent in the GridComponent with the same condition.

filterGlobal(value: any, condition: any, ignoreCase: any): void

Parameters

  • value: any
  • condition: any
  • ignoreCase: any

Returns void

findNext

Section titled "findNext"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.

findNext(text: string, caseSensitive: boolean, exactMatch: boolean): number

Parameters

  • text: string

    the string to search.
  • caseSensitive: boolean

    optionally, if the search should be case sensitive (defaults to false).
  • exactMatch: boolean

    optionally, if the text should match the entire value (defaults to false).

Returns number

Example

this.grid.findNext("financial");

findPrev

Section titled "findPrev"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.

findPrev(text: string, caseSensitive: boolean, exactMatch: boolean): number

Parameters

  • text: string

    the string to search.
  • caseSensitive: boolean

    optionally, if the search should be case sensitive (defaults to false).
  • exactMatch: boolean

    optionally, if the text should match the entire value (defaults to false).

Returns number

Example

this.grid.findPrev("financial");

getColumnByName

Section titled "getColumnByName"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns the ColumnComponent by field name.

getColumnByName(name: string): IgrColumnComponent

Parameters

  • name: string

Returns IgrColumnComponent

Example

const myCol = this.grid1.getColumnByName("ID");

getColumnByVisibleIndex

Section titled "getColumnByVisibleIndex"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective) 

getColumnByVisibleIndex(index: number): IgrColumnComponent

Parameters

  • index: number

Returns IgrColumnComponent

getHeaderGroupWidth

Section titled "getHeaderGroupWidth"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets the width to be set on GridHeaderGroupComponent.

getHeaderGroupWidth(column: IgrColumnComponent): string

Parameters

  • column: IgrColumnComponent

Returns string

getNextCell

Section titled "getNextCell"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns ICellPosition which defines the next cell, according to the current position, that match specific criteria.

getNextCell(currRowIndex: number, curVisibleColIndex: number, callback: any): IgrCellPosition

Parameters

  • currRowIndex: number
  • curVisibleColIndex: number
  • callback: any

Returns IgrCellPosition

Example

const nextEditableCellPosition = this.grid.getNextCell(0, 3, (column) => column.editable);

getPinnedEndWidth

Section titled "getPinnedEndWidth"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets calculated width of the pinned areas.

getPinnedEndWidth(takeHidden: boolean): void

Parameters

  • takeHidden: boolean

    If we should take into account the hidden columns in the pinned area.

Returns void

Example

const pinnedWidth = this.grid.getPinnedEndWidth();

getPinnedStartWidth

Section titled "getPinnedStartWidth"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Gets calculated width of the pinned areas.

getPinnedStartWidth(takeHidden: boolean): void

Parameters

  • takeHidden: boolean

    If we should take into account the hidden columns in the pinned area.

Returns void

Example

const pinnedWidth = this.grid.getPinnedStartWidth();

getPreviousCell

Section titled "getPreviousCell"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns ICellPosition which defines the previous cell, according to the current position, that match specific criteria.

getPreviousCell(currRowIndex: number, curVisibleColIndex: number, callback: any): IgrCellPosition

Parameters

  • currRowIndex: number
  • curVisibleColIndex: number
  • callback: any

Returns IgrCellPosition

Example

const previousEditableCellPosition = this.grid.getPreviousCell(0, 3, (column) => column.editable);

getRowData

Section titled "getRowData"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns the data that is contained in the row component.

getRowData(rowSelector: any): any

Parameters

  • rowSelector: any

    correspond to rowID

Returns any

Example

const data = grid.getRowData(94741);

getSelectedColumnsData

Section titled "getSelectedColumnsData"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns an array of the current columns selection in the form of [{ column.field: cell.value }, ...].

getSelectedColumnsData(formatters: boolean, headers: boolean): void

Parameters

  • formatters: boolean
  • headers: boolean

Returns void

getSelectedData

Section titled "getSelectedData"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...].

getSelectedData(formatters: boolean, headers: boolean): void

Parameters

  • formatters: boolean
  • headers: boolean

Returns void

getSelectedRanges

Section titled "getSelectedRanges"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Get the currently selected ranges in the grid.

getSelectedRanges(): IgrGridSelectionRange[]

Returns IgrGridSelectionRange[]

isRecordPinnedByIndex

Section titled "isRecordPinnedByIndex"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Returns whether the record is pinned or not.

isRecordPinnedByIndex(rowIndex: number): void

Parameters

  • rowIndex: number

    Index of the record in the filteredSortedData collection.

Returns void

markForCheck

Section titled "markForCheck"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Triggers change detection for the GridComponent. Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. May degrade performance if used when not needed, or if misused: ``

markForCheck(): void

Returns void

Example

grid.markForCheck();

moveColumn

Section titled "moveColumn"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Places a column before or after the specified target column.

moveColumn(column: IgrColumnComponent, target: IgrColumnComponent, pos: DropPosition): void

Parameters

  • column: IgrColumnComponent
  • target: IgrColumnComponent
  • pos: DropPosition

Returns void

Example

grid.moveColumn(column, target);
Section titled "navigateTo"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Navigates to a position in the grid based on provided rowindex and visibleColumnIndex.

navigateTo(rowIndex: number, visibleColIndex: number, cb: any): void

Parameters

  • rowIndex: number
  • visibleColIndex: number
  • cb: any

Returns void

Example

this.grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });

openAdvancedFilteringDialog

Section titled "openAdvancedFilteringDialog"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Opens the advanced filtering dialog.

openAdvancedFilteringDialog(overlaySettings: IgrOverlaySettings): void

Parameters

Returns void

pinColumn

Section titled "pinColumn"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Pins a column by field name.

pinColumn(columnName: string, index: number, pinningPosition: ColumnPinningPosition): boolean

Parameters

Returns boolean

Example

this.grid.pinColumn("ID");

recalculateAutoSizes

Section titled "recalculateAutoSizes"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Recalculates all widths of columns that have size set to auto.

recalculateAutoSizes(): void

Returns void

Example

this.grid1.recalculateAutoSizes();

reflow

Section titled "reflow"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Recalculates grid width/height dimensions.

reflow(): void

Returns void

Example

this.grid.reflow();

refreshSearch

Section titled "refreshSearch"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Reapplies the existing search.

refreshSearch(updateActiveInfo: boolean, endEdit: boolean): number

Parameters

  • updateActiveInfo: boolean
  • endEdit: boolean

Returns number

Example

this.grid.refreshSearch();

selectAllColumns

Section titled "selectAllColumns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Selects all columns

selectAllColumns(): void

Returns void

Example

this.grid.deselectAllColumns();

selectAllRows

Section titled "selectAllRows"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Selects all rows

selectAllRows(onlyFilterData: boolean): void

Parameters

  • onlyFilterData: boolean

Returns void

Example

this.grid.selectAllRows();
this.grid.selectAllRows(false);

selectColumns

Section titled "selectColumns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Select specified columns.

selectColumns(columns: string[] | IgrColumnComponent[], clearCurrentSelection: boolean): void

Parameters

  • columns: string[] | IgrColumnComponent[]
  • clearCurrentSelection: boolean

    if true clears the current selection

Returns void

Example

this.grid.selectColumns(['ID','Name'], true);

selectedColumns

Section titled "selectedColumns"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Get current selected columns.

selectedColumns(): IgrColumnComponent[]

Returns IgrColumnComponent[]

Example

Returns an array with selected columns

const selectedColumns = this.grid.selectedColumns();

selectRange

Section titled "selectRange"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Select range(s) of cells between certain rows and columns of the grid.

selectRange(arg: IgrGridSelectionRange[]): void

Parameters

Returns void

selectRows

Section titled "selectRows"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Select specified rows by ID.

selectRows(rowIDs: any[], clearCurrentSelection: boolean): void

Parameters

  • rowIDs: any[]
  • clearCurrentSelection: boolean

    if true clears the current selection

Returns void

Example

this.grid.selectRows([1,2,5], true);

sort

Section titled "sort"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Sort a single ColumnComponent.

sort(expression: IgrSortingExpression[]): void

Parameters

Returns void

Example

this.grid.sort({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });

toggleColumnVisibility

Section titled "toggleColumnVisibility"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Toggles the specified column's visibility.

toggleColumnVisibility(args: IgrColumnVisibilityChangedEventArgs): void

Parameters

Returns void

Example

this.grid1.toggleColumnVisibility({
      column: this.grid1.columns[0],
      newValue: true
});

toggleRow

Section titled "toggleRow"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Toggles the row by its id.

toggleRow(rowID: any): void

Parameters

  • rowID: any

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

Returns void

Example

this.grid.toggleRow(rowID);

unpinColumn

Section titled "unpinColumn"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Unpins a column by field name. Returns whether the operation is successful.

unpinColumn(columnName: string, index: number): boolean

Parameters

  • columnName: string
  • index: number

Returns boolean

Example

this.grid.pinColumn("ID");

updateCell

Section titled "updateCell"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Updates the GridRowComponent and the corresponding data record by primary key.

updateCell(value: any, rowSelector: any, column: string): void

Parameters

  • value: any

    the new value which is to be set.
  • rowSelector: any

    corresponds to rowID.
  • column: string

    corresponds to column field.

Returns void

Example

this.gridWithPK.updateCell('Updated', 1, 'ProductName');

updateRow

Section titled "updateRow"

Inherited from: EventEmitterMixin<IgcHierarchicalGridBaseDirectiveEventMap, AbstractConstructor<IgcGridBaseDirective>>(IgcGridBaseDirective)

Updates the GridRowComponent

updateRow(value: any, rowSelector: any): void

Parameters

  • value: any
  • rowSelector: any

    correspond to rowID

Returns void

Example

grid.updateRow({
      ProductID: 1, ProductName: 'Spearmint', InStock: true, UnitsInStock: 1, OrderDate: new Date('2005-03-21')
  }, 1);

Events

Section titled "Events"

onActiveNodeChange

Section titled "onActiveNodeChange" 
onActiveNodeChange(args: CustomEvent<IgrActiveNodeChangeEventArgs>): void

Parameters

Returns void

onAdvancedFilteringExpressionsTreeChange

Section titled "onAdvancedFilteringExpressionsTreeChange" 
onAdvancedFilteringExpressionsTreeChange(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

Returns void

onCellClick

Section titled "onCellClick" 
onCellClick(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

Returns void

onCellEdit

Section titled "onCellEdit" 
onCellEdit(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onCellEditDone

Section titled "onCellEditDone" 
onCellEditDone(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onCellEditEnter

Section titled "onCellEditEnter" 
onCellEditEnter(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onCellEditExit

Section titled "onCellEditExit" 
onCellEditExit(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onColumnInit

Section titled "onColumnInit" 
onColumnInit(args: CustomEvent<IgrColumnComponent>): void

Parameters

Returns void

onColumnMoving

Section titled "onColumnMoving" 
onColumnMoving(args: CustomEvent<IgrColumnMovingEventArgs>): void

Parameters

Returns void

onColumnMovingEnd

Section titled "onColumnMovingEnd" 
onColumnMovingEnd(args: CustomEvent<IgrColumnMovingEndEventArgs>): void

Parameters

Returns void

onColumnMovingStart

Section titled "onColumnMovingStart" 
onColumnMovingStart(args: CustomEvent<IgrColumnMovingStartEventArgs>): void

Parameters

Returns void

onColumnPin

Section titled "onColumnPin" 
onColumnPin(args: CustomEvent<IgrPinColumnCancellableEventArgs>): void

Parameters

Returns void

onColumnPinned

Section titled "onColumnPinned" 
onColumnPinned(args: CustomEvent<IgrPinColumnEventArgs>): void

Parameters

Returns void

onColumnResized

Section titled "onColumnResized" 
onColumnResized(args: CustomEvent<IgrColumnResizeEventArgs>): void

Parameters

Returns void

onColumnsAutogenerated

Section titled "onColumnsAutogenerated" 
onColumnsAutogenerated(args: CustomEvent<IgrColumnsAutoGeneratedEventArgs>): void

Parameters

Returns void

onColumnSelectionChanging

Section titled "onColumnSelectionChanging" 
onColumnSelectionChanging(args: CustomEvent<IgrColumnSelectionEventArgs>): void

Parameters

Returns void

onColumnVisibilityChanged

Section titled "onColumnVisibilityChanged" 
onColumnVisibilityChanged(args: CustomEvent<IgrColumnVisibilityChangedEventArgs>): void

Parameters

Returns void

onColumnVisibilityChanging

Section titled "onColumnVisibilityChanging" 
onColumnVisibilityChanging(args: CustomEvent<IgrColumnVisibilityChangingEventArgs>): void

Parameters

Returns void

onContextMenu

Section titled "onContextMenu" 
onContextMenu(args: CustomEvent<IgrGridContextMenuEventArgs>): void

Parameters

Returns void

onDataChanged

Section titled "onDataChanged" 
onDataChanged(args: CustomEvent<IgrForOfDataChangeEventArgs>): void

Parameters

Returns void

onDataChanging

Section titled "onDataChanging" 
onDataChanging(args: CustomEvent<IgrForOfDataChangeEventArgs>): void

Parameters

Returns void

onDataPreLoad

Section titled "onDataPreLoad" 
onDataPreLoad(args: CustomEvent<IgrForOfState>): void

Parameters

Returns void

onDoubleClick

Section titled "onDoubleClick" 
onDoubleClick(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

Returns void

onExpansionStatesChange

Section titled "onExpansionStatesChange" 
onExpansionStatesChange(args: CustomEvent<Map<any, boolean>>): void

Parameters

Returns void

onFiltering

Section titled "onFiltering" 
onFiltering(args: CustomEvent<IgrFilteringEventArgs>): void

Parameters

Returns void

onFilteringDone

Section titled "onFilteringDone" 
onFilteringDone(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

Returns void

onFilteringExpressionsTreeChange

Section titled "onFilteringExpressionsTreeChange" 
onFilteringExpressionsTreeChange(args: CustomEvent<IgrFilteringExpressionsTree>): void

Parameters

Returns void

onFormGroupCreated

Section titled "onFormGroupCreated" 
onFormGroupCreated(args: CustomEvent<IgrGridFormGroupCreatedEventArgs>): void

Parameters

Returns void

onGridCopy

Section titled "onGridCopy" 
onGridCopy(args: CustomEvent<IgrGridClipboardEvent>): void

Parameters

Returns void

onGridKeydown

Section titled "onGridKeydown" 
onGridKeydown(args: CustomEvent<IgrGridKeydownEventArgs>): void

Parameters

Returns void

onGridScroll

Section titled "onGridScroll" 
onGridScroll(args: CustomEvent<IgrGridScrollEventArgs>): void

Parameters

Returns void

onRangeSelected

Section titled "onRangeSelected" 
onRangeSelected(args: CustomEvent<IgrGridSelectionRange>): void

Parameters

Returns void

onRendered

Section titled "onRendered" 
onRendered(args: CustomEvent<boolean>): void

Parameters

Returns void

onRowAdd

Section titled "onRowAdd" 
onRowAdd(args: CustomEvent<IgrRowDataCancelableEventArgs>): void

Parameters

Returns void

onRowAdded

Section titled "onRowAdded" 
onRowAdded(args: CustomEvent<IgrRowDataEventArgs>): void

Parameters

Returns void

onRowClick

Section titled "onRowClick" 
onRowClick(args: CustomEvent<IgrGridRowEventArgs>): void

Parameters

Returns void

onRowDelete

Section titled "onRowDelete" 
onRowDelete(args: CustomEvent<IgrRowDataCancelableEventArgs>): void

Parameters

Returns void

onRowDeleted

Section titled "onRowDeleted" 
onRowDeleted(args: CustomEvent<IgrRowDataEventArgs>): void

Parameters

Returns void

onRowDragEnd

Section titled "onRowDragEnd" 
onRowDragEnd(args: CustomEvent<IgrRowDragEndEventArgs>): void

Parameters

Returns void

onRowDragStart

Section titled "onRowDragStart" 
onRowDragStart(args: CustomEvent<IgrRowDragStartEventArgs>): void

Parameters

Returns void

onRowEdit

Section titled "onRowEdit" 
onRowEdit(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onRowEditDone

Section titled "onRowEditDone" 
onRowEditDone(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onRowEditEnter

Section titled "onRowEditEnter" 
onRowEditEnter(args: CustomEvent<IgrGridEditEventArgs>): void

Parameters

Returns void

onRowEditExit

Section titled "onRowEditExit" 
onRowEditExit(args: CustomEvent<IgrGridEditDoneEventArgs>): void

Parameters

Returns void

onRowPinned

Section titled "onRowPinned" 
onRowPinned(args: CustomEvent<IgrPinRowEventArgs>): void

Parameters

Returns void

onRowPinning

Section titled "onRowPinning" 
onRowPinning(args: CustomEvent<IgrPinRowEventArgs>): void

Parameters

Returns void

onRowSelectionChanging

Section titled "onRowSelectionChanging" 
onRowSelectionChanging(args: CustomEvent<IgrRowSelectionEventArgs>): void

Parameters

Returns void

onRowToggle

Section titled "onRowToggle" 
onRowToggle(args: CustomEvent<IgrRowToggleEventArgs>): void

Parameters

Returns void

onSelected

Section titled "onSelected" 
onSelected(args: CustomEvent<IgrGridCellEventArgs>): void

Parameters

Returns void

onSelectedRowsChange

Section titled "onSelectedRowsChange" 
onSelectedRowsChange(args: CustomEvent<any[]>): void

Parameters

Returns void

onSorting

Section titled "onSorting" 
onSorting(args: CustomEvent<IgrSortingEventArgs>): void

Parameters

Returns void

onSortingDone

Section titled "onSortingDone" 
onSortingDone(args: CustomEvent<IgrSortingExpression[]>): void

Parameters

Returns void

onSortingExpressionsChange

Section titled "onSortingExpressionsChange" 
onSortingExpressionsChange(args: CustomEvent<IgrSortingExpression[]>): void

Parameters

Returns void

onToolbarExporting

Section titled "onToolbarExporting" 
onToolbarExporting(args: CustomEvent<IgrGridToolbarExportEventArgs>): void

Parameters

Returns void

onValidationStatusChange

Section titled "onValidationStatusChange" 
onValidationStatusChange(args: CustomEvent<IgrGridValidationStatusEventArgs>): void

Parameters

Returns void