Row island

Constructors

Section titled "Constructors"

IgcRowIslandComponent 

new IgcRowIslandComponent(args: any[]): IgcRowIslandComponent

Returns IgcRowIslandComponent

Properties

Section titled "Properties"

tagName

Section titled "tagName"

The tagName read-only property of the Element interface returns the tag name of the element on which it's called.

MDN Reference

 
tagName: string

Accessors

Section titled "Accessors"

actionStripComponents

Section titled "actionStripComponents" 
get actionStripComponents(): IgcActionStripToken[]

Returns IgcActionStripToken[]

addRowEmptyTemplate

Section titled "addRowEmptyTemplate" 
get addRowEmptyTemplate(): IgcRenderFunction<void>

Returns IgcRenderFunction<void>

Gets/Sets a custom template for adding row UI when grid is empty.

 
set addRowEmptyTemplate(value: IgcRenderFunction<void>): void

Parameters

Returns void

advancedFilteringExpressionsTree

Section titled "advancedFilteringExpressionsTree" 
get advancedFilteringExpressionsTree(): IgcFilteringExpressionsTree

Returns IgcFilteringExpressionsTree

Gets/Sets the advanced filtering state.

 
set advancedFilteringExpressionsTree(value: IgcFilteringExpressionsTree): void

Parameters

Returns void

allowAdvancedFiltering

Section titled "allowAdvancedFiltering" 
get allowAdvancedFiltering(): boolean

Returns boolean

Gets/Sets a value indicating whether the advanced filtering is enabled.

 
set allowAdvancedFiltering(value: boolean): void

Parameters

  • value: boolean

Returns void

allowFiltering

Section titled "allowFiltering" 
get allowFiltering(): boolean

Returns boolean

Gets/Sets if the filtering is enabled.

 
set allowFiltering(value: boolean): void

Parameters

  • value: boolean

Returns void

autoGenerate

Section titled "autoGenerate" 
get autoGenerate(): boolean

Returns boolean

Gets/Sets whether to auto-generate the columns.

 
set autoGenerate(value: boolean): void

Parameters

  • value: boolean

Returns void

autoGenerateExclude

Section titled "autoGenerateExclude" 
get autoGenerateExclude(): string[]

Returns string[]

Gets/Sets a list of property keys to be excluded from the generated column collection

 
set autoGenerateExclude(value: string[]): void

Parameters

  • value: string[]

Returns void

batchEditing

Section titled "batchEditing" 
get batchEditing(): boolean

Returns boolean

Gets/Sets whether the grid has batch editing enabled. When batch editing is enabled, changes are not made directly to the underlying data. Instead, they are stored as transactions, which can later be committed w/ the commit method.

 
set batchEditing(value: boolean): void

Parameters

  • value: boolean

Returns void

cellMergeMode

Section titled "cellMergeMode" 
get cellMergeMode(): GridCellMergeMode

Returns GridCellMergeMode

Gets/Sets cell merge mode.

 
set cellMergeMode(value: GridCellMergeMode): void

Parameters

Returns void

cellSelection

Section titled "cellSelection" 
get cellSelection(): GridSelectionMode

Returns GridSelectionMode

Gets/Sets cell selection mode.

 
set cellSelection(value: GridSelectionMode): void

Parameters

Returns void

childDataKey

Section titled "childDataKey" 
get childDataKey(): string

Returns string

Sets the key of the row island by which child data would be taken from the row data if such is provided.

 
set childDataKey(value: string): void

Parameters

  • value: string

Returns void

childLayoutList

Section titled "childLayoutList" 
get childLayoutList(): IgcRowIslandComponent[]

Returns IgcRowIslandComponent[]

clipboardOptions

Section titled "clipboardOptions" 
get clipboardOptions(): IgcClipboardOptions

Returns IgcClipboardOptions

Controls the copy behavior of the grid.

 
set clipboardOptions(value: IgcClipboardOptions): void

Parameters

Returns void

columnList

Section titled "columnList" 
get columnList(): IgcColumnComponent[]

Returns IgcColumnComponent[]

columns

Section titled "columns"

Gets an array of columns.

 
get columns(): IgcColumnComponent[]

Returns IgcColumnComponent[]

columnSelection

Section titled "columnSelection" 
get columnSelection(): GridSelectionMode

Returns GridSelectionMode

Gets/Sets column selection mode

 
set columnSelection(value: GridSelectionMode): void

Parameters

Returns void

columnWidth

Section titled "columnWidth" 
get columnWidth(): string

Returns string

Gets/Sets the default width of the columns.

 
set columnWidth(value: string): void

Parameters

  • value: string

Returns void

dataCloneStrategy

Section titled "dataCloneStrategy" 
get dataCloneStrategy(): IgcDataCloneStrategy

Returns IgcDataCloneStrategy

Gets/Sets the data clone strategy of the grid when in edit mode.

 
set dataCloneStrategy(value: IgcDataCloneStrategy): void

Parameters

Returns void

dataRowList

Section titled "dataRowList"

A list of currently rendered grid row's.

 
get dataRowList(): IgcRowDirective[]

Returns IgcRowDirective[]

defaultRowHeight

Section titled "defaultRowHeight"

Gets the default row height.

 
get defaultRowHeight(): number

Returns number

dragGhostCustomTemplate

Section titled "dragGhostCustomTemplate"

Gets the custom template, if any, used for row drag ghost.

 
set dragGhostCustomTemplate(value: IgcRenderFunction<IgcGridRowDragGhostContext>): void

Parameters

Returns void

dragIndicatorIconTemplate

Section titled "dragIndicatorIconTemplate"

The custom template, if any, that should be used when rendering the row drag indicator icon

 
set dragIndicatorIconTemplate(value: IgcRenderFunction<IgcGridEmptyTemplateContext>): void

Parameters

Returns void

emptyFilteredGridMessage

Section titled "emptyFilteredGridMessage" 
get emptyFilteredGridMessage(): string

Returns string

Gets/Sets the message displayed when there are no records and the grid is filtered.

 
set emptyFilteredGridMessage(value: string): void

Parameters

  • value: string

Returns void

emptyGridMessage

Section titled "emptyGridMessage" 
get emptyGridMessage(): string

Returns string

Get/Sets the message displayed when there are no records.

 
set emptyGridMessage(value: string): void

Parameters

  • value: string

Returns void

emptyGridTemplate

Section titled "emptyGridTemplate"

Gets/Sets a custom template when empty.

 
set emptyGridTemplate(value: IgcRenderFunction<IgcGridTemplateContext>): void

Parameters

Returns void

excelStyleHeaderIconTemplate

Section titled "excelStyleHeaderIconTemplate"

Gets the excel style header icon.

 
set excelStyleHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>): void

Parameters

Returns void

expandChildren

Section titled "expandChildren" 
get expandChildren(): boolean

Returns boolean

Sets if all immediate children of the grids for this row island should be expanded/collapsed.

 
set expandChildren(value: boolean): void

Parameters

  • value: boolean

Returns void

expansionStates

Section titled "expansionStates" 
get expansionStates(): Map<any, boolean>

Returns Map<any, boolean>

Gets/Sets a list of key-value pairs [row ID, expansion state].

 
set expansionStates(value: Map<any, boolean>): void

Parameters

  • value: Map<any, boolean>

Returns void

filteringExpressionsTree

Section titled "filteringExpressionsTree" 
get filteringExpressionsTree(): IgcFilteringExpressionsTree

Returns IgcFilteringExpressionsTree

Gets/Sets the filtering state.

 
set filteringExpressionsTree(value: IgcFilteringExpressionsTree): void

Parameters

Returns void

filteringLogic

Section titled "filteringLogic" 
get filteringLogic(): FilteringLogic

Returns FilteringLogic

Gets/Sets the filtering logic of the grid.

 
set filteringLogic(value: FilteringLogic): void

Parameters

Returns void

filterMode

Section titled "filterMode" 
get filterMode(): FilterMode

Returns FilterMode

Gets/Sets the filter mode.

 
set filterMode(value: FilterMode): void

Parameters

Returns void

filterStrategy

Section titled "filterStrategy" 
get filterStrategy(): IgcFilteringStrategy

Returns IgcFilteringStrategy

Gets/Sets the filtering strategy of the grid.

 
set filterStrategy(value: IgcFilteringStrategy): void

Parameters

Returns void

hasChildrenKey

Section titled "hasChildrenKey" 
get hasChildrenKey(): string

Returns string

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

 
set hasChildrenKey(value: string): void

Parameters

  • value: string

Returns void

headerCollapsedIndicatorTemplate

Section titled "headerCollapsedIndicatorTemplate" 
get headerCollapsedIndicatorTemplate(): IgcRenderFunction<IgcGridTemplateContext>

Returns IgcRenderFunction<IgcGridTemplateContext>

Gets the row collapse indicator template.

 
set headerCollapsedIndicatorTemplate(value: IgcRenderFunction<IgcGridTemplateContext>): void

Parameters

Returns void

headerExpandedIndicatorTemplate

Section titled "headerExpandedIndicatorTemplate" 
get headerExpandedIndicatorTemplate(): IgcRenderFunction<IgcGridTemplateContext>

Returns IgcRenderFunction<IgcGridTemplateContext>

Gets the header expand indicator template.

 
set headerExpandedIndicatorTemplate(value: IgcRenderFunction<IgcGridTemplateContext>): void

Parameters

Returns void

headSelectorTemplate

Section titled "headSelectorTemplate"

Gets the header row selector template.

 
set headSelectorTemplate(value: IgcRenderFunction<IgcHeadSelectorTemplateContext>): void

Parameters

Returns void

height

Section titled "height" 
get height(): string

Returns string

Gets/Sets the height.

 
set height(value: string): void

Parameters

  • value: string

Returns void

hideRowSelectors

Section titled "hideRowSelectors" 
get hideRowSelectors(): boolean

Returns boolean

Gets/Sets if the row selectors are hidden.

 
set hideRowSelectors(value: boolean): void

Parameters

  • value: boolean

Returns void

isLoading

Section titled "isLoading" 
get isLoading(): boolean

Returns boolean

Gets/Sets whether the grid is going to show a loading indicator.

 
set isLoading(value: boolean): void

Parameters

  • value: boolean

Returns void

loadingGridTemplate

Section titled "loadingGridTemplate"

Gets/Sets a custom template when loading.

 
set loadingGridTemplate(value: IgcRenderFunction<IgcGridTemplateContext>): void

Parameters

Returns void

locale

Section titled "locale" 
get locale(): string

Returns string

Gets/Sets the locale.

 
set locale(value: string): void

Parameters

  • value: string

Returns void

mergeStrategy

Section titled "mergeStrategy" 
get mergeStrategy(): IgcGridMergeStrategy

Returns IgcGridMergeStrategy

Gets/Sets the merge strategy of the grid.

 
set mergeStrategy(value: IgcGridMergeStrategy): void

Parameters

Returns void

moving

Section titled "moving" 
get moving(): boolean

Returns boolean

Controls whether columns moving is enabled in the grid.

 
set moving(value: boolean): void

Parameters

  • value: boolean

Returns void

paginationComponents

Section titled "paginationComponents" 
get paginationComponents(): IgcPaginatorComponent[]

Returns IgcPaginatorComponent[]

paginatorTemplate

Section titled "paginatorTemplate"

Sets/Gets the paginator template for each child grid created from this row island.

 
set paginatorTemplate(value: IgcRenderFunction<IgcGridPaginatorTemplateContext>): void

Parameters

Returns void

pagingMode

Section titled "pagingMode" 
get pagingMode(): GridPagingMode

Returns GridPagingMode 

set pagingMode(value: GridPagingMode): void

Parameters

Returns void

pinnedRows

Section titled "pinnedRows"

Gets an array of the pinned rows.

 
get pinnedRows(): IgcGridRowComponent[]

Returns IgcGridRowComponent[]

pinning

Section titled "pinning" 
get pinning(): IgcPinningConfig

Returns IgcPinningConfig

Gets/Sets the initial pinning configuration.

 
set pinning(value: IgcPinningConfig): void

Parameters

Returns void

primaryKey

Section titled "primaryKey" 
get primaryKey(): string

Returns string

Gets/Sets the primary key.

 
set primaryKey(value: string): void

Parameters

  • value: string

Returns void

resourceStrings

Section titled "resourceStrings" 
get resourceStrings(): IgcGridResourceStrings

Returns IgcGridResourceStrings

Gets/Sets the resource strings.

 
set resourceStrings(value: IgcGridResourceStrings): void

Parameters

Returns void

rowAddTextTemplate

Section titled "rowAddTextTemplate"

Gets the row add text template.

 
set rowAddTextTemplate(value: IgcRenderFunction<IgcGridEmptyTemplateContext>): void

Parameters

Returns void

rowClasses

Section titled "rowClasses" 
get rowClasses(): any

Returns any

Sets a conditional class selector to the grid's row element. Accepts an object literal, containing key-value pairs, where the key is the name of the CSS class and the value is either a callback function that returns a boolean, or boolean, like so:

 
set rowClasses(value: any): void

Parameters

  • value: any

Returns void

rowCollapsedIndicatorTemplate

Section titled "rowCollapsedIndicatorTemplate"

Gets the row collapse indicator template.

 
set rowCollapsedIndicatorTemplate(value: IgcRenderFunction<IgcGridRowTemplateContext>): void

Parameters

Returns void

rowDraggable

Section titled "rowDraggable" 
get rowDraggable(): boolean

Returns boolean

Gets/Sets whether rows can be moved.

 
set rowDraggable(value: boolean): void

Parameters

  • value: boolean

Returns void

rowEditable

Section titled "rowEditable" 
get rowEditable(): boolean

Returns boolean

Gets/Sets whether the rows are editable.

 
set rowEditable(value: boolean): void

Parameters

  • value: boolean

Returns void

rowEditActionsTemplate

Section titled "rowEditActionsTemplate"

Gets the row edit actions template.

 
set rowEditActionsTemplate(value: IgcRenderFunction<IgcGridRowEditActionsTemplateContext>): void

Parameters

Returns void

rowEditTextTemplate

Section titled "rowEditTextTemplate"

Gets the row edit text template.

 
set rowEditTextTemplate(value: IgcRenderFunction<IgcGridRowEditTextTemplateContext>): void

Parameters

Returns void

rowExpandedIndicatorTemplate

Section titled "rowExpandedIndicatorTemplate"

Gets the row expand indicator template.

 
set rowExpandedIndicatorTemplate(value: IgcRenderFunction<IgcGridRowTemplateContext>): void

Parameters

Returns void

rowHeight

Section titled "rowHeight" 
get rowHeight(): number

Returns number

Gets/Sets the row height.

 
set rowHeight(value: number): void

Parameters

  • value: number

Returns void

rowList

Section titled "rowList"

A list of grid row.

 
get rowList(): IgcRowDirective[]

Returns IgcRowDirective[]

rowSelection

Section titled "rowSelection" 
get rowSelection(): GridSelectionMode

Returns GridSelectionMode

Gets/Sets row selection mode

 
set rowSelection(value: GridSelectionMode): void

Parameters

Returns void

rowSelectorTemplate

Section titled "rowSelectorTemplate"

Gets the row selector template.

 
set rowSelectorTemplate(value: IgcRenderFunction<IgcRowSelectorTemplateContext>): void

Parameters

Returns void

rowStyles

Section titled "rowStyles" 
get rowStyles(): any

Returns any

Sets conditional style properties on the grid row element. It accepts an object literal where the keys are the style properties and the value is an expression to be evaluated.

 
set rowStyles(value: any): void

Parameters

  • value: any

Returns void

selectedRows

Section titled "selectedRows" 
get selectedRows(): any[]

Returns any[]

Gets/Sets the current selection state.

 
set selectedRows(value: any[]): void

Parameters

  • value: any[]

Returns void

selectRowOnClick

Section titled "selectRowOnClick" 
get selectRowOnClick(): boolean

Returns boolean

Gets/Sets whether clicking over a row should select/deselect it

 
set selectRowOnClick(value: boolean): void

Parameters

  • value: boolean

Returns void

shouldGenerate

Section titled "shouldGenerate" 
get shouldGenerate(): boolean

Returns boolean

Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid

 
set shouldGenerate(value: boolean): void

Parameters

  • value: boolean

Returns void

showExpandAll

Section titled "showExpandAll" 
get showExpandAll(): boolean

Returns boolean

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

 
set showExpandAll(value: boolean): void

Parameters

  • value: boolean

Returns void

showSummaryOnCollapse

Section titled "showSummaryOnCollapse" 
get showSummaryOnCollapse(): boolean

Returns boolean

Controls whether the summary row is visible when groupBy/parent row is collapsed.

 
set showSummaryOnCollapse(value: boolean): void

Parameters

  • value: boolean

Returns void

snackbarDisplayTime

Section titled "snackbarDisplayTime" 
get snackbarDisplayTime(): number

Returns number

Gets/Sets the display time for the row adding snackbar notification.

 
set snackbarDisplayTime(value: number): void

Parameters

  • value: number

Returns void

sortAscendingHeaderIconTemplate

Section titled "sortAscendingHeaderIconTemplate"

The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order.

 
set sortAscendingHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>): void

Parameters

Returns void

sortDescendingHeaderIconTemplate

Section titled "sortDescendingHeaderIconTemplate"

The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order.

 
set sortDescendingHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>): void

Parameters

Returns void

sortHeaderIconTemplate

Section titled "sortHeaderIconTemplate"

Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted.

 
set sortHeaderIconTemplate(value: IgcRenderFunction<IgcGridHeaderTemplateContext>): void

Parameters

Returns void

sortingExpressions

Section titled "sortingExpressions" 
get sortingExpressions(): IgcSortingExpression[]

Returns IgcSortingExpression[]

Gets/Sets the sorting state.

 
set sortingExpressions(value: IgcSortingExpression[]): void

Parameters

Returns void

sortingOptions

Section titled "sortingOptions" 
get sortingOptions(): IgcSortingOptions

Returns IgcSortingOptions

Gets/Sets the sorting options - single or multiple sorting. Accepts an ISortingOptions object with any of the mode properties.

 
set sortingOptions(value: IgcSortingOptions): void

Parameters

Returns void

sortStrategy

Section titled "sortStrategy" 
get sortStrategy(): IgcGridSortingStrategy

Returns IgcGridSortingStrategy

Gets/Sets the sorting strategy of the grid.

 
set sortStrategy(value: IgcGridSortingStrategy): void

Parameters

Returns void

summaryCalculationMode

Section titled "summaryCalculationMode" 
get summaryCalculationMode(): GridSummaryCalculationMode

Returns GridSummaryCalculationMode

Gets/Sets the summary calculation mode.

 
set summaryCalculationMode(value: GridSummaryCalculationMode): void

Parameters

Returns void

summaryPosition

Section titled "summaryPosition" 
get summaryPosition(): GridSummaryPosition

Returns GridSummaryPosition

Gets/Sets the summary position.

 
set summaryPosition(value: GridSummaryPosition): void

Parameters

Returns void

summaryRowHeight

Section titled "summaryRowHeight" 
get summaryRowHeight(): number

Returns number

Get/Set summary row height

 
set summaryRowHeight(value: number): void

Parameters

  • value: number

Returns void

toolbar

Section titled "toolbar"

toolbarTemplate

Section titled "toolbarTemplate"

Sets/Gets the toolbar template for each child grid created from this row island.

 
set toolbarTemplate(value: IgcRenderFunction<IgcGridToolbarTemplateContext>): void

Parameters

Returns void

totalRecords

Section titled "totalRecords" 
get totalRecords(): number

Returns number

Returns the total number of records.

 
set totalRecords(value: number): void

Parameters

  • value: number

Returns void

transactions

Section titled "transactions"

Get transactions service for the grid.

 
get transactions(): TransactionService

Returns TransactionService

validationTrigger

Section titled "validationTrigger" 
get validationTrigger(): GridValidationTrigger

Returns GridValidationTrigger

Gets/Sets the trigger for validators used when editing the grid.

 
set validationTrigger(value: GridValidationTrigger): void

Parameters

Returns void

width

Section titled "width" 
get width(): string

Returns string

Gets/Sets the width of the grid.

 
set width(value: string): void

Parameters

  • value: string

Returns void

Methods

Section titled "Methods"

addEventListener

Section titled "addEventListener"

Inherited from: EventEmitterMixin<IgcRowIslandComponentEventMap, Constructor<LitElement>>(LitElement) 

addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): void

Parameters

  • type: K
  • listener: object
  • options: boolean | AddEventListenerOptions

Returns void

addRow

Section titled "addRow"

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

 
addRow(data: any): void

Parameters

  • data: any

Returns void

beginAddRowById

Section titled "beginAddRowById"

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

beginAddRowByIndex

Section titled "beginAddRowByIndex"

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

clearCellSelection

Section titled "clearCellSelection"

Deselect selected cells.

 
clearCellSelection(): void

Returns void

clearFilter

Section titled "clearFilter"

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

 
clearFilter(name: string): void

Parameters

  • name: string

Returns void

clearSearch

Section titled "clearSearch"

Removes all the highlights in the cell.

 
clearSearch(): void

Returns void

clearSort

Section titled "clearSort"

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

 
clearSort(name: string): void

Parameters

  • name: string

Returns void

closeAdvancedFilteringDialog

Section titled "closeAdvancedFilteringDialog"

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"

Collapses all rows.

 
collapseAll(): void

Returns void

collapseRow

Section titled "collapseRow"

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

deleteRow

Section titled "deleteRow"

Removes the grid row and the corresponding data record by primary key.

 
deleteRow(rowSelector: any): any

Parameters

  • rowSelector: any

Returns any

deselectAllColumns

Section titled "deselectAllColumns"

Deselects all columns

 
deselectAllColumns(): void

Returns void

deselectAllRows

Section titled "deselectAllRows"

Deselects all rows

 
deselectAllRows(onlyFilterData: boolean): void

Parameters

  • onlyFilterData: boolean

Returns void

deselectColumns

Section titled "deselectColumns"

Deselect specified columns by field.

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

Parameters

Returns void

deselectRows

Section titled "deselectRows"

Deselect specified rows by ID.

 
deselectRows(rowIDs: any[]): void

Parameters

  • rowIDs: any[]

Returns void

disableSummaries

Section titled "disableSummaries"

Disable summaries for the specified column.

 
disableSummaries(rest: any[]): void

Parameters

  • rest: any[]

Returns void

enableSummaries

Section titled "enableSummaries"

Enables summaries for the specified column and applies your customSummary.

 
enableSummaries(rest: any[]): void

Parameters

  • rest: any[]

Returns void

endEdit

Section titled "endEdit"

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"

Expands all rows.

 
expandAll(): void

Returns void

expandRow

Section titled "expandRow"

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

filter

Section titled "filter"

Filters a single column.

 
filter(name: string, value: any, conditionOrExpressionTree: IgcFilteringExpressionsTree | IgcFilteringOperation, ignoreCase: boolean): void

Parameters

Returns void

filterGlobal

Section titled "filterGlobal"

Filters all the column in the grid 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"

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

findPrev

Section titled "findPrev"

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

getColumnByName

Section titled "getColumnByName"

Returns the column by field name.

 
getColumnByName(name: string): IgcColumnComponent

Parameters

  • name: string

Returns IgcColumnComponent

getColumnByVisibleIndex

Section titled "getColumnByVisibleIndex" 
getColumnByVisibleIndex(index: number): IgcColumnComponent

Parameters

  • index: number

Returns IgcColumnComponent

getHeaderGroupWidth

Section titled "getHeaderGroupWidth"

Gets the width to be set on grid header group.

 
getHeaderGroupWidth(column: IgcColumnComponent): string

Parameters

Returns string

getNextCell

Section titled "getNextCell"

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

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

Parameters

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

Returns IgcCellPosition

getPinnedEndWidth

Section titled "getPinnedEndWidth"

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

getPinnedStartWidth

Section titled "getPinnedStartWidth"

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

getPreviousCell

Section titled "getPreviousCell"

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

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

Parameters

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

Returns IgcCellPosition

getRowData

Section titled "getRowData"

Returns the data that is contained in the row component.

 
getRowData(rowSelector: any): any

Parameters

  • rowSelector: any

    correspond to rowID

Returns any

getSelectedColumnsData

Section titled "getSelectedColumnsData"

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"

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"

Get the currently selected ranges in the grid.

 
getSelectedRanges(): IgcGridSelectionRange[]

Returns IgcGridSelectionRange[]

isRecordPinnedByIndex

Section titled "isRecordPinnedByIndex"

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"

Triggers change detection for the grid. 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

moveColumn

Section titled "moveColumn"

Places a column before or after the specified target column.

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

Parameters

Returns void

Section titled "navigateTo"

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

openAdvancedFilteringDialog

Section titled "openAdvancedFilteringDialog"

Opens the advanced filtering dialog.

 
openAdvancedFilteringDialog(overlaySettings: IgcOverlaySettings): void

Parameters

Returns void

pinColumn

Section titled "pinColumn"

Pins a column by field name.

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

Parameters

Returns boolean

pinRow

Section titled "pinRow"

Pin the row by its id.

 
pinRow(rowID: any, index: number, row: IgcRowType): 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.
  • row: IgcRowType

Returns boolean

recalculateAutoSizes

Section titled "recalculateAutoSizes"

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

 
recalculateAutoSizes(): void

Returns void

refreshSearch

Section titled "refreshSearch"

Reapplies the existing search.

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

Parameters

  • updateActiveInfo: boolean
  • endEdit: boolean

Returns number

removeEventListener

Section titled "removeEventListener"

Inherited from: EventEmitterMixin<IgcRowIslandComponentEventMap, Constructor<LitElement>>(LitElement) 

removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): void

Parameters

  • type: K
  • listener: object
  • options: boolean | EventListenerOptions

Returns void

selectAllColumns

Section titled "selectAllColumns"

Selects all columns

 
selectAllColumns(): void

Returns void

selectAllRows

Section titled "selectAllRows"

Selects all rows

 
selectAllRows(onlyFilterData: boolean): void

Parameters

  • onlyFilterData: boolean

Returns void

selectColumns

Section titled "selectColumns"

Select specified columns.

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

Parameters

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

    if true clears the current selection

Returns void

selectedColumns

Section titled "selectedColumns"

Get current selected columns.

 
selectedColumns(): IgcColumnComponent[]

Returns IgcColumnComponent[]

selectRange

Section titled "selectRange"

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

 
selectRange(arg: IgcGridSelectionRange[]): void

Parameters

Returns void

selectRows

Section titled "selectRows"

Select specified rows by ID.

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

Parameters

  • rowIDs: any[]
  • clearCurrentSelection: boolean

    if true clears the current selection

Returns void

sort

Section titled "sort"

Sort a single column.

 
sort(expression: IgcSortingExpression[]): void

Parameters

Returns void

toggleColumnVisibility

Section titled "toggleColumnVisibility"

Toggles the specified column's visibility.

 
toggleColumnVisibility(args: IgcColumnVisibilityChangedEventArgs): void

Parameters

Returns void

toggleRow

Section titled "toggleRow"

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

unpinColumn

Section titled "unpinColumn"

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

unpinRow

Section titled "unpinRow"

Unpin the row by its id.

 
unpinRow(rowID: any, row: IgcRowType): boolean

Parameters

  • rowID: any

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

Returns boolean

updateCell

Section titled "updateCell"

Updates the grid row 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

updateRow

Section titled "updateRow"

Updates the grid row

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

Parameters

  • value: any
  • rowSelector: any

    correspond to rowID

Returns void

register

Section titled "register" 
register(): void

Returns void

Events

Section titled "Events"

activeNodeChange

Section titled "activeNodeChange"

Emitted when the active node is changed.

 
activeNodeChange: CustomEvent<IgcActiveNodeChangeEventArgs>

advancedFilteringExpressionsTreeChange

Section titled "advancedFilteringExpressionsTreeChange"

Emitted after advanced filtering is performed.

 
advancedFilteringExpressionsTreeChange: CustomEvent<IgcFilteringExpressionsTree>

cellClick

Section titled "cellClick"

Emitted when a cell is clicked.

 
cellClick: CustomEvent<IgcGridCellEventArgs>

cellEdit

Section titled "cellEdit"

Emitted when cell has been edited.

 
cellEdit: CustomEvent<IgcGridEditEventArgs>

cellEditDone

Section titled "cellEditDone"

Emitted after cell has been edited and editing has been committed.

 
cellEditDone: CustomEvent<IgcGridEditDoneEventArgs>

cellEditEnter

Section titled "cellEditEnter"

Emitted when cell enters edit mode.

 
cellEditEnter: CustomEvent<IgcGridEditEventArgs>

cellEditExit

Section titled "cellEditExit"

Emitted when cell exits edit mode.

 
cellEditExit: CustomEvent<IgcGridEditDoneEventArgs>

columnInit

Section titled "columnInit"

Emitted when a column is initialized.

 
columnInit: CustomEvent<IgcColumnComponent>

columnMoving

Section titled "columnMoving"

Emitted during the column moving operation.

 
columnMoving: CustomEvent<IgcColumnMovingEventArgs>

columnMovingEnd

Section titled "columnMovingEnd"

Emitted when column moving ends.

 
columnMovingEnd: CustomEvent<IgcColumnMovingEndEventArgs>

columnMovingStart

Section titled "columnMovingStart"

Emitted when column moving starts.

 
columnMovingStart: CustomEvent<IgcColumnMovingStartEventArgs>

columnPin

Section titled "columnPin"

Emitted before column is pinned.

 
columnPin: CustomEvent<IgcPinColumnCancellableEventArgs>

columnPinned

Section titled "columnPinned"

Emitted after column is pinned.

 
columnPinned: CustomEvent<IgcPinColumnEventArgs>

columnResized

Section titled "columnResized"

Emitted after column is resized.

 
columnResized: CustomEvent<IgcColumnResizeEventArgs>

columnsAutogenerated

Section titled "columnsAutogenerated" 
columnsAutogenerated: CustomEvent<IgcColumnsAutoGeneratedEventArgs>

columnSelectionChanging

Section titled "columnSelectionChanging"

Emitted when column is selected.

 
columnSelectionChanging: CustomEvent<IgcColumnSelectionEventArgs>

columnVisibilityChanged

Section titled "columnVisibilityChanged"

Emitted after column visibility is changed.

 
columnVisibilityChanged: CustomEvent<IgcColumnVisibilityChangedEventArgs>

columnVisibilityChanging

Section titled "columnVisibilityChanging"

Emitted before column visibility is changed.

 
columnVisibilityChanging: CustomEvent<IgcColumnVisibilityChangingEventArgs>

contextMenu

Section titled "contextMenu"

Emitted when a cell or row is right clicked.

 
contextMenu: CustomEvent<IgcGridContextMenuEventArgs>

dataChanged

Section titled "dataChanged"

Emitted after the grid's data view is changed because of a data operation, rebinding, etc.

 
dataChanged: CustomEvent<IgcForOfDataChangeEventArgs>

dataChanging

Section titled "dataChanging"

Emitted before the grid's data view is changed because of a data operation, rebinding, etc.

 
dataChanging: CustomEvent<IgcForOfDataChangeEventArgs>

dataPreLoad

Section titled "dataPreLoad"

Emitted when a new chunk of data is loaded from virtualization.

 
dataPreLoad: CustomEvent<IgcForOfState>

doubleClick

Section titled "doubleClick"

Emitted when a cell is double clicked.

 
doubleClick: CustomEvent<IgcGridCellEventArgs>

expansionStatesChange

Section titled "expansionStatesChange"

Emitted when the rows are expanded or collapsed.

 
expansionStatesChange: CustomEvent<Map<any, boolean>>

filtering

Section titled "filtering"

Emitted before filtering expressions are applied.

 
filtering: CustomEvent<IgcFilteringEventArgs>

filteringDone

Section titled "filteringDone"

Emitted after filtering is performed through the UI.

 
filteringDone: CustomEvent<IgcFilteringExpressionsTree>

filteringExpressionsTreeChange

Section titled "filteringExpressionsTreeChange"

Emitted after filtering is performed.

 
filteringExpressionsTreeChange: CustomEvent<IgcFilteringExpressionsTree>

formGroupCreated

Section titled "formGroupCreated"

Emitted when formGroup is created on edit of row/cell.

 
formGroupCreated: CustomEvent<IgcGridFormGroupCreatedEventArgs>

gridCopy

Section titled "gridCopy"

Emitted when a copy operation is executed.

 
gridCopy: CustomEvent<IgcGridClipboardEvent>

gridCreated

Section titled "gridCreated"

Event emitted when a grid is being created based on this row island.

 
gridCreated: CustomEvent<IgcGridCreatedEventArgs>

gridInitialized

Section titled "gridInitialized"

Emitted after a grid is being initialized for this row island. The emitting is done in ngAfterViewInit.

 
gridInitialized: CustomEvent<IgcGridCreatedEventArgs>

gridKeydown

Section titled "gridKeydown"

Emitted when keydown is triggered over element inside grid's body.

 
gridKeydown: CustomEvent<IgcGridKeydownEventArgs>

gridScroll

Section titled "gridScroll"

Emitted when grid is scrolled horizontally/vertically.

 
gridScroll: CustomEvent<IgcGridScrollEventArgs>

rangeSelected

Section titled "rangeSelected"

Emitted when making a range selection.

 
rangeSelected: CustomEvent<IgcGridSelectionRange>

rendered

Section titled "rendered"

Emitted after the ngAfterViewInit hook. At this point the grid exists in the DOM

 
rendered: CustomEvent<boolean>

rowAdd

Section titled "rowAdd"

Emmited just before the newly added row is commited.

 
rowAdd: CustomEvent<IgcRowDataCancelableEventArgs>

rowAdded

Section titled "rowAdded"

Emitted when a row is added.

 
rowAdded: CustomEvent<IgcRowDataEventArgs>

rowClick

Section titled "rowClick"

Emitted when a row is clicked.

 
rowClick: CustomEvent<IgcGridRowEventArgs>

rowDelete

Section titled "rowDelete"

Emmited when deleting a row.

 
rowDelete: CustomEvent<IgcRowDataCancelableEventArgs>

rowDeleted

Section titled "rowDeleted"

Emitted when a row is deleted.

 
rowDeleted: CustomEvent<IgcRowDataEventArgs>

rowDragEnd

Section titled "rowDragEnd"

Emitted when dropping a row.

 
rowDragEnd: CustomEvent<IgcRowDragEndEventArgs>

rowDragStart

Section titled "rowDragStart"

Emitted when start dragging a row.

 
rowDragStart: CustomEvent<IgcRowDragStartEventArgs>

rowEdit

Section titled "rowEdit"

Emitted when exiting edit mode for a row.

 
rowEdit: CustomEvent<IgcGridEditEventArgs>

rowEditDone

Section titled "rowEditDone"

Emitted after exiting edit mode for a row and editing has been committed.

 
rowEditDone: CustomEvent<IgcGridEditDoneEventArgs>

rowEditEnter

Section titled "rowEditEnter"

Emitted when a row enters edit mode.

 
rowEditEnter: CustomEvent<IgcGridEditEventArgs>

rowEditExit

Section titled "rowEditExit"

Emitted when row editing is canceled.

 
rowEditExit: CustomEvent<IgcGridEditDoneEventArgs>

rowPinned

Section titled "rowPinned"

Emitted when the pinned state of a row is changed.

 
rowPinned: CustomEvent<IgcPinRowEventArgs>

rowPinning

Section titled "rowPinning"

Emitted when the pinned state of a row is changed.

 
rowPinning: CustomEvent<IgcPinRowEventArgs>

rowSelectionChanging

Section titled "rowSelectionChanging"

Emitted when grid row is selected.

 
rowSelectionChanging: CustomEvent<IgcRowSelectionEventArgs>

rowToggle

Section titled "rowToggle"

Emitted when the expanded state of a row gets changed.

 
rowToggle: CustomEvent<IgcRowToggleEventArgs>

selected

Section titled "selected"

Emitted when a cell is selected.

 
selected: CustomEvent<IgcGridCellEventArgs>

selectedRowsChange

Section titled "selectedRowsChange"

Emitted when the rows are selected or deselected.

 
selectedRowsChange: CustomEvent<any[]>

sorting

Section titled "sorting"

Emitted before sorting expressions are applied.

 
sorting: CustomEvent<IgcSortingEventArgs>

sortingDone

Section titled "sortingDone"

Emitted after sorting is completed.

 
sortingDone: CustomEvent<IgcSortingExpression[]>

sortingExpressionsChange

Section titled "sortingExpressionsChange"

Emitted before sorting is performed.

 
sortingExpressionsChange: CustomEvent<IgcSortingExpression[]>

toolbarExporting

Section titled "toolbarExporting"

Emitted when an export process is initiated by the user.

 
toolbarExporting: CustomEvent<IgcGridToolbarExportEventArgs>

validationStatusChange

Section titled "validationStatusChange"

Emitted when grid's validation status changes.

 
validationStatusChange: CustomEvent<IgcGridValidationStatusEventArgs>