Interface FlatGridType

An interface describing a Flat Grid type

Hierarchy

GridType
- FlatGridType

Properties

Accessors

Methods

Properties

`Optional` _baseFontSize

_baseFontSize?: number

_filteredSortedUnpinnedData

_filteredSortedUnpinnedData: any[]

_filteredUnpinnedData

_filteredUnpinnedData: any[]

_totalRecords

_totalRecords: number

activeNodeChange

activeNodeChange: EventEmitter<IActiveNodeChangeEventArgs>

advancedFilteringExpressionsTree

advancedFilteringExpressionsTree: IFilteringExpressionsTree

advancedFilteringExpressionsTreeChange

advancedFilteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree>

allowAdvancedFiltering

allowAdvancedFiltering: boolean

allowFiltering

allowFiltering: boolean

batchEditing

batchEditing: boolean

`Optional` batchEditingChange

batchEditingChange?: EventEmitter<boolean>

calcHeight

calcHeight: number

calcWidth

calcWidth: number

`Optional` cascadeOnDelete

cascadeOnDelete?: boolean

`Readonly` cdr

cdr: ChangeDetectorRef

cellClick

cellClick: EventEmitter<IGridCellEventArgs>

cellEdit

cellEdit: EventEmitter<IGridEditEventArgs>

cellEditDone

cellEditDone: EventEmitter<IGridEditDoneEventArgs>

cellEditEnter

cellEditEnter: EventEmitter<IGridEditEventArgs>

cellEditExit

cellEditExit: EventEmitter<IGridEditDoneEventArgs>

cellSelection

cellSelection: GridSelectionMode

`Optional` childDataKey

childDataKey?: any

`Optional` childLayoutKeys

childLayoutKeys?: any[]

`Optional` childLayoutList

childLayoutList?: QueryList<any>

`Optional` childRow

childRow?: any

columnInDrag

columnInDrag: any

columnList

columnList: QueryList<ColumnType>

columnMoving

columnMoving: EventEmitter<IColumnMovingEventArgs>

columnMovingEnd

columnMovingEnd: EventEmitter<IColumnMovingEndEventArgs>

columnMovingStart

columnMovingStart: EventEmitter<IColumnMovingStartEventArgs>

columnPin

columnPin: EventEmitter<IPinColumnCancellableEventArgs>

columnPinned

columnPinned: EventEmitter<IPinColumnEventArgs>

columnResized

columnResized: EventEmitter<IColumnResizeEventArgs>

columnSelection

columnSelection: GridSelectionMode

columnSelectionChanging

columnSelectionChanging: EventEmitter<IColumnSelectionEventArgs>

columnVisibilityChanged

columnVisibilityChanged: EventEmitter<IColumnVisibilityChangedEventArgs>

columnVisibilityChanging

columnVisibilityChanging: EventEmitter<IColumnVisibilityChangingEventArgs>

columnWidthSetByUser

columnWidthSetByUser: boolean

columns

columns: ColumnType[]

contextMenu

contextMenu: EventEmitter<IGridCellEventArgs>

currencyPositionLeft

currencyPositionLeft: boolean

data

data: any[]

dataCloneStrategy

dataCloneStrategy: IDataCloneStrategy

dataRowList

dataRowList: any

dataView

dataView: any[]

dataWithAddedInTransactionRows

dataWithAddedInTransactionRows: any[]

defaultHeaderGroupMinWidth

defaultHeaderGroupMinWidth: any

defaultRowHeight

defaultRowHeight: number

defaultSummaryHeight

defaultSummaryHeight: number

densityChanged

densityChanged: EventEmitter<IDensityChangedEventArgs>

disableTransitions

disableTransitions: boolean

displayDensity

displayDensity: DisplayDensity

doubleClick

doubleClick: EventEmitter<IGridCellEventArgs>

dragIndicatorIconBase

dragIndicatorIconBase: any

dragIndicatorIconTemplate

dragIndicatorIconTemplate: any

excelStyleHeaderIconTemplate

excelStyleHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>

`Optional` expansionDepth

expansionDepth?: number

expansionStates

expansionStates: Map<any, boolean>

filterMode

filterMode: FilterMode

filterStrategy

filterStrategy: IFilteringStrategy

filteredSortedData

filteredSortedData: any[]

filtering

filtering: EventEmitter<IFilteringEventArgs>

filteringDone

filteringDone: EventEmitter<IFilteringExpressionsTree>

filteringExpressionsTree

filteringExpressionsTree: IFilteringExpressionsTree

filteringExpressionsTreeChange

filteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree>

filteringLogic

filteringLogic: FilteringLogic

filteringPipeTrigger

filteringPipeTrigger: number

firstEditableColumnIndex

firstEditableColumnIndex: number

`Optional` flatData

flatData?: any[]

`Optional` foreignKey

foreignKey?: any

formGroupCreated

formGroupCreated: EventEmitter<IGridFormGroupCreatedEventArgs>

getHeaderCellWidth

getHeaderCellWidth: ((element: HTMLElement) => ISizeInfo)

Type declaration

- (element: HTMLElement): ISizeInfo
- Parameters
  - element: HTMLElement
  Returns ISizeInfo

`Readonly` gridAPI

gridAPI: GridServiceType

gridKeydown

gridKeydown: EventEmitter<IGridKeydownEventArgs>

`Optional` groupByRowSelectorTemplate

groupByRowSelectorTemplate?: TemplateRef<IgxGroupByRowSelectorTemplateContext>

`Optional` groupRowTemplate

groupRowTemplate?: TemplateRef<IgxGroupByRowTemplateContext>

`Optional` groupStrategy

groupStrategy?: IGridGroupingStrategy

groupingExpansionState

groupingExpansionState: IGroupByExpandState[]

groupingExpressions

groupingExpressions: IGroupingExpression[]

groupingExpressionsChange

groupingExpressionsChange: EventEmitter<IGroupingExpression[]>

`Optional` groupingFlatResult

groupingFlatResult?: any[]

`Optional` groupingMetadata

groupingMetadata?: any[]

`Optional` groupingResult

groupingResult?: any[]

`Optional` groupsExpanded

groupsExpanded?: boolean

`Optional` `Readonly` groupsRecords

groupsRecords?: IGroupByRecord[]

`Optional` hasChildrenKey

hasChildrenKey?: any

hasDetails

hasDetails: boolean

`Optional` hasExpandableChildren

hasExpandableChildren?: boolean

hasPinnedRecords

hasPinnedRecords: boolean

hasVisibleColumns

hasVisibleColumns: boolean

headSelectorBaseAriaLabel

headSelectorBaseAriaLabel: string

headSelectorTemplate

headSelectorTemplate: TemplateRef<IgxHeadSelectorTemplateContext>

headerCollapsedIndicatorTemplate

headerCollapsedIndicatorTemplate: TemplateRef<IgxGridTemplateContext>

headerExpandedIndicatorTemplate

headerExpandedIndicatorTemplate: TemplateRef<IgxGridTemplateContext>

headerFeaturesWidth

headerFeaturesWidth: number

hiddenColumnsCount

hiddenColumnsCount: number

`Optional` highlightedRowID

highlightedRowID?: any

`Optional` iconTemplate

iconTemplate?: TemplateRef<any>

id

id: string

isCellSelectable

isCellSelectable: boolean

isLoading

isLoading: boolean

isMultiRowSelectionEnabled

isMultiRowSelectionEnabled: boolean

isPinningToStart

isPinningToStart: boolean

isRowPinningToTop

isRowPinningToTop: boolean

isRowSelectable

isRowSelectable: boolean

`Optional` lastChildGrid

lastChildGrid?: GridType

lastEditableColumnIndex

lastEditableColumnIndex: number

lastSearchInfo

lastSearchInfo: ISearchInfo

`Optional` loadChildrenOnDemand

loadChildrenOnDemand?: ((parentID: any, done: ((children: any[]) => void)) => void)

Type declaration

- (parentID: any, done: ((children: any[]) => void)): void
- Parameters
  - parentID: any
  - done: ((children: any[]) => void)
    - - (children: any[]): void
      - Parameters
        
        children: any[]
        
        Returns void
  Returns void

`Optional` loadingRows

loadingRows?: Set<any>

locale

locale: string

localeChange

localeChange: EventEmitter<boolean>

maxLevelHeaderDepth

maxLevelHeaderDepth: number

moving

moving: boolean

multiRowLayoutRowSize

multiRowLayoutRowSize: number

nativeElement

nativeElement: HTMLElement

navigation

navigation: any

outerWidth

outerWidth: number

outlet

outlet: any

pagingMode

pagingMode: GridPagingMode

`Optional` parent

parent?: GridType

parentVirtDir

parentVirtDir: any

pinnedColumns

pinnedColumns: ColumnType[]

pinnedColumnsCount

pinnedColumnsCount: number

pinnedRecords

pinnedRecords: any[]

pinnedRecordsCount

pinnedRecordsCount: number

pinnedRows

pinnedRows: any[]

pinning

pinning: IPinningConfig

pipeTrigger

pipeTrigger: number

primaryKey

primaryKey: any

`Optional` processedExpandedFlatData

processedExpandedFlatData?: any[]

`Optional` processedRecords

processedRecords?: Map<any, ITreeGridRecord>

`Optional` processedRootRecords

processedRootRecords?: ITreeGridRecord[]

rangeSelected

rangeSelected: EventEmitter<GridSelectionRange>

`Optional` records

records?: Map<any, ITreeGridRecord>

rendered$

rendered$: Observable<boolean>

renderedRowHeight

renderedRowHeight: number

resizeNotify

resizeNotify: Subject<void>

resourceStrings

resourceStrings: IGridResourceStrings

`Optional` rootGrid

rootGrid?: GridType

`Optional` rootRecords

rootRecords?: ITreeGridRecord[]

rootSummariesEnabled

rootSummariesEnabled: boolean

rowAdd

rowAdd: EventEmitter<IGridEditEventArgs>

rowAdded

rowAdded: EventEmitter<IRowDataEventArgs>

rowAddedNotifier

rowAddedNotifier: Subject<IRowDataEventArgs>

rowCollapsedIndicatorTemplate

rowCollapsedIndicatorTemplate: TemplateRef<IgxGridRowTemplateContext>

rowDeleted

rowDeleted: EventEmitter<IRowDataEventArgs>

rowDeletedNotifier

rowDeletedNotifier: Subject<IRowDataEventArgs>

rowDragEnd

rowDragEnd: EventEmitter<IRowDragEndEventArgs>

rowDragStart

rowDragStart: EventEmitter<IRowDragStartEventArgs>

rowDraggable

rowDraggable: boolean

rowDragging

rowDragging: boolean

rowEdit

rowEdit: EventEmitter<IGridEditEventArgs>

rowEditDone

rowEditDone: EventEmitter<IGridEditDoneEventArgs>

rowEditEnter

rowEditEnter: EventEmitter<IGridEditEventArgs>

rowEditExit

rowEditExit: EventEmitter<IGridEditDoneEventArgs>

rowEditTabs

rowEditTabs: any

rowEditable

rowEditable: boolean

rowEditingOverlay

rowEditingOverlay: IgxToggleDirective

rowExpandedIndicatorTemplate

rowExpandedIndicatorTemplate: TemplateRef<IgxGridRowTemplateContext>

rowHeight

rowHeight: number

rowList

rowList: any

`Optional` rowLoadingIndicatorTemplate

rowLoadingIndicatorTemplate?: TemplateRef<any>

rowSelection

rowSelection: GridSelectionMode

rowSelectionChanging

rowSelectionChanging: EventEmitter<IRowSelectionEventArgs>

rowSelectorTemplate

rowSelectorTemplate: TemplateRef<IgxRowSelectorTemplateContext>

rowToggle

rowToggle: EventEmitter<IRowToggleEventArgs>

scrollSize

scrollSize: number

selectRowOnClick

selectRowOnClick: boolean

selected

selected: EventEmitter<IGridCellEventArgs>

`Optional` selectedCells

selectedCells?: CellType[]

selectedRows

selectedRows: any[]

`Optional` showExpandAll

showExpandAll?: boolean

showRowSelectors

showRowSelectors: boolean

sortAscendingHeaderIconTemplate

sortAscendingHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>

sortDescendingHeaderIconTemplate

sortDescendingHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>

sortHeaderIconTemplate

sortHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>

sortStrategy

sortStrategy: IGridSortingStrategy

sortingExpressions

sortingExpressions: ISortingExpression<any>[]

sortingExpressionsChange

sortingExpressionsChange: EventEmitter<ISortingExpression<any>[]>

sortingOptions

sortingOptions: ISortingOptions

summariesMargin

summariesMargin: number

summariesRowList

summariesRowList: any

summaryCalculationMode

summaryCalculationMode: GridSummaryCalculationMode

summaryPipeTrigger

summaryPipeTrigger: number

summaryPosition

summaryPosition: GridSummaryPosition

summaryRowHeight

summaryRowHeight: number

tbody

tbody: any

toolbarExporting

toolbarExporting: EventEmitter<IGridToolbarExportEventArgs>

totalRowsCountAfterFilter

totalRowsCountAfterFilter: number

`Readonly` transactions

transactions: TransactionService<Transaction, State>

`Optional` treeGroupArea

treeGroupArea?: any

uniqueColumnValuesStrategy

uniqueColumnValuesStrategy: ((column: ColumnType, tree: FilteringExpressionsTree, done: ((values: any[]) => void)) => void)

Type declaration

- (column: ColumnType, tree: FilteringExpressionsTree, done: ((values: any[]) => void)): void
- Parameters
  - column: ColumnType
  - tree: FilteringExpressionsTree
  - done: ((values: any[]) => void)
    - - (values: any[]): void
      - Parameters
        
        values: any[]
        
        Returns void
  Returns void

unpinnedColumns

unpinnedColumns: ColumnType[]

unpinnedRecords

unpinnedRecords: any[]

`Optional` updateOnRender

updateOnRender?: boolean

`Readonly` validation

validation: IgxGridValidationService

validationStatusChange

validationStatusChange: EventEmitter<IGridValidationStatusEventArgs>

validationTrigger

validationTrigger: GridValidationTrigger

verticalScrollContainer

verticalScrollContainer: any

virtualizationState

virtualizationState: IForOfState

visibleColumns

visibleColumns: ColumnType[]

Accessors

filteredData

get filteredData(): any[]
Inherited from GridType.filteredData
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:51
Returns any[]

Methods

clearCellSelection

clearCellSelection(): void
Inherited from GridType.clearCellSelection
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:660
Returns void

clearGrouping

clearGrouping(field: string): void
Overrides GridType.clearGrouping
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:700
Parameters
- field: string
Returns void

clearSort

clearSort(name?: string): void
Inherited from GridType.clearSort
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:638
Parameters
- Optional name: string
Returns void

closeRowEditingOverlay

closeRowEditingOverlay(): void
Inherited from GridType.closeRowEditingOverlay
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:679
Returns void

collapseRow

collapseRow(id: any): void
Inherited from GridType.collapseRow
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:674
Parameters
- id: any
Returns void

columnToVisibleIndex

columnToVisibleIndex(key: string | number): number
Inherited from GridType.columnToVisibleIndex
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:655
Parameters
- key: string | number
Returns number

`Optional` createColumnsList

createColumnsList(cols: ColumnType[]): void
Inherited from GridType.createColumnsList
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:684
Parameters
- cols: ColumnType[]
Returns void

createFilterDropdown

createFilterDropdown(column: ColumnType, options: OverlaySettings): any
Inherited from GridType.createFilterDropdown
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:667
Parameters
- column: ColumnType
- options: OverlaySettings
Returns any

`Optional` createRow

createRow(index: number, data?: any): RowType
Inherited from GridType.createRow
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:670
Parameters
- index: number
- Optional data: any
Returns RowType

deleteRow

deleteRow(id: any): any
Inherited from GridType.deleteRow
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:671
Parameters
- id: any
Returns any

deleteRowById

deleteRowById(id: any): any
Inherited from GridType.deleteRowById
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:672
Parameters
- id: any
Returns any

deselectAllColumns

deselectAllColumns(): void
Inherited from GridType.deselectAllColumns
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:615
Returns void

deselectAllRows

deselectAllRows(onlyFilterData?: boolean): void
Inherited from GridType.deselectAllRows
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:665
Parameters
- Optional onlyFilterData: boolean
Returns void

deselectColumns

deselectColumns(columns: string[] | ColumnType[]): void
Inherited from GridType.deselectColumns
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:616
Parameters
- columns: string[] | ColumnType[]
Returns void

deselectRows

deselectRows(rowIDs: any[]): void
Inherited from GridType.deselectRows
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:663
Parameters
- rowIDs: any[]
Returns void

`Optional` generateRowPath

generateRowPath(rowId: any): any[]
Inherited from GridType.generateRowPath
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:687
Parameters
- rowId: any
Returns any[]

`Optional` getChildGrids

getChildGrids(inDepth?: boolean): any[]
Inherited from GridType.getChildGrids
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:653
Parameters
- Optional inDepth: boolean
Returns any[]

getColumnByName

getColumnByName(name: string): any
Inherited from GridType.getColumnByName
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:630
Parameters
- name: string
Returns any

getColumnByVisibleIndex

getColumnByVisibleIndex(index: number): ColumnType
Inherited from GridType.getColumnByVisibleIndex
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:631
Parameters
- index: number
Returns ColumnType

getDefaultExpandState

getDefaultExpandState(record: any): boolean
Inherited from GridType.getDefaultExpandState
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:620
Parameters
- record: any
Returns boolean

getDragGhostCustomTemplate

getDragGhostCustomTemplate(): TemplateRef<any>
Inherited from GridType.getDragGhostCustomTemplate
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:626
Returns TemplateRef<any>

getEmptyRecordObjectFor

getEmptyRecordObjectFor(inRow: RowType): any
Inherited from GridType.getEmptyRecordObjectFor
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:642
Parameters
- inRow: RowType
Returns any

getHeaderGroupWidth

getHeaderGroupWidth(column: ColumnType): string
Inherited from GridType.getHeaderGroupWidth
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:632
Parameters
- column: ColumnType
Returns string

getInitialPinnedIndex

getInitialPinnedIndex(rec: any): number
Inherited from GridType.getInitialPinnedIndex
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:645
Parameters
- rec: any
Returns number

getNextCell

getNextCell(currRowIndex: number, curVisibleColIndex: number, callback: ((c: ColumnType) => boolean)): ICellPosition
Inherited from GridType.getNextCell
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:659
Parameters
- currRowIndex: number
- curVisibleColIndex: number
- callback: ((c: ColumnType) => boolean)
  - - (c: ColumnType): boolean
    - Parameters
      - c: ColumnType
      Returns boolean
Returns ICellPosition

getPossibleColumnWidth

getPossibleColumnWidth(): string
Inherited from GridType.getPossibleColumnWidth
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:622
Returns string

getPreviousCell

getPreviousCell(currRowIndex: number, curVisibleColIndex: number, callback: ((c: ColumnType) => boolean)): ICellPosition
Inherited from GridType.getPreviousCell
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:658
Parameters
- currRowIndex: number
- curVisibleColIndex: number
- callback: ((c: ColumnType) => boolean)
  - - (c: ColumnType): boolean
    - Parameters
      - c: ColumnType
      Returns boolean
Returns ICellPosition

getUnpinnedIndexById

getUnpinnedIndexById(id: any): number
Inherited from GridType.getUnpinnedIndexById
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:641
Parameters
- id: any
Returns number

getVisibleContentHeight

getVisibleContentHeight(): number
Inherited from GridType.getVisibleContentHeight
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:625
Returns number

groupBy

groupBy(expression: IGroupingExpression | IGroupingExpression[]): void
Overrides GridType.groupBy
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:701
Parameters
- expression: IGroupingExpression | IGroupingExpression[]
Returns void

hasVerticalScroll

hasVerticalScroll(): boolean
Inherited from GridType.hasVerticalScroll
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:624
Returns boolean

`Optional` isChildGridRecord

isChildGridRecord(rec: any): boolean
Inherited from GridType.isChildGridRecord
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:652
Parameters
- rec: any
Returns boolean

isColumnGrouped

isColumnGrouped(fieldName: string): boolean
Inherited from GridType.isColumnGrouped
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:647
Parameters
- fieldName: string
Returns boolean

isDetailRecord

isDetailRecord(rec: any): boolean
Inherited from GridType.isDetailRecord
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:648
Parameters
- rec: any
Returns boolean

isExpandedGroup

isExpandedGroup(group: IGroupByRecord): boolean
Inherited from GridType.isExpandedGroup
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:683
Parameters
- group: IGroupByRecord
Returns boolean

isGhostRecord

isGhostRecord(rec: any): boolean
Inherited from GridType.isGhostRecord
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:650
Parameters
- rec: any
Returns boolean

isGroupByRecord

isGroupByRecord(rec: any): boolean
Inherited from GridType.isGroupByRecord
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:649
Parameters
- rec: any
Returns boolean

`Optional` isHierarchicalRecord

isHierarchicalRecord(record: any): boolean
Inherited from GridType.isHierarchicalRecord
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:654
Parameters
- record: any
Returns boolean

isRecordPinned

isRecordPinned(rec: any): boolean
Inherited from GridType.isRecordPinned
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:644
Parameters
- rec: any
Returns boolean

isRecordPinnedByViewIndex

isRecordPinnedByViewIndex(rowIndex: number): boolean
Inherited from GridType.isRecordPinnedByViewIndex
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:646
Parameters
- rowIndex: number
Returns boolean

isSummaryRow

isSummaryRow(rec: any): boolean
Inherited from GridType.isSummaryRow
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:643
Parameters
- rec: any
Returns boolean

`Optional` isTreeRow

isTreeRow(rec: any): boolean
Inherited from GridType.isTreeRow
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:651
Parameters
- rec: any
Returns boolean

moveColumn

moveColumn(column: ColumnType, target: ColumnType, pos: DropPosition): void
Inherited from GridType.moveColumn
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:656
Parameters
- column: ColumnType
- target: ColumnType
- pos: DropPosition
Returns void

navigateTo

navigateTo(rowIndex: number, visibleColumnIndex: number, callback?: ((e: any) => any)): void
Inherited from GridType.navigateTo
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:657
Parameters
- rowIndex: number
- visibleColumnIndex: number
- Optional callback: ((e: any) => any)
  - - (e: any): any
    - Parameters
      - e: any
      Returns any
Returns void

notifyChanges

notifyChanges(repaint?: boolean): void
Inherited from GridType.notifyChanges
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:675
Parameters
- Optional repaint: boolean
Returns void

openAdvancedFilteringDialog

openAdvancedFilteringDialog(): void
Inherited from GridType.openAdvancedFilteringDialog
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:628
Returns void

openRowOverlay

openRowOverlay(id: any): void
Inherited from GridType.openRowOverlay
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:627
Parameters
- id: any
Returns void

pinRow

pinRow(id: any, index?: number, row?: RowType): boolean
Inherited from GridType.pinRow
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:639
Parameters
- id: any
- Optional index: number
- Optional row: RowType
Returns boolean

`Optional` preventHeaderScroll

preventHeaderScroll(args: any): void
Inherited from GridType.preventHeaderScroll
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:688
Parameters
- args: any
Returns void

reflow

reflow(): void
Inherited from GridType.reflow
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:680
Returns void

refreshSearch

refreshSearch(): void
Inherited from GridType.refreshSearch
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:619
Returns void

repositionRowEditingOverlay

repositionRowEditingOverlay(row: RowType): void
Inherited from GridType.repositionRowEditingOverlay
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:678
Parameters
- row: RowType
Returns void

resetColumnCollections

resetColumnCollections(): void
Inherited from GridType.resetColumnCollections
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:676
Returns void

resetHorizontalVirtualization

resetHorizontalVirtualization(): void
Inherited from GridType.resetHorizontalVirtualization
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:623
Returns void

`Optional` resolveOutlet

resolveOutlet(): IgxOverlayOutletDirective
Inherited from GridType.resolveOutlet
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:612
Returns IgxOverlayOutletDirective

selectAllRows

selectAllRows(onlyFilterData?: boolean): void
Inherited from GridType.selectAllRows
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:664
Parameters
- Optional onlyFilterData: boolean
Returns void

selectColumns

selectColumns(columns: string[] | ColumnType[]): void
Inherited from GridType.selectColumns
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:617
Parameters
- columns: string[] | ColumnType[]
Returns void

selectRange

selectRange(range: GridSelectionRange | GridSelectionRange[]): void
Inherited from GridType.selectRange
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:661
Parameters
- range: GridSelectionRange | GridSelectionRange[]
Returns void

selectRows

selectRows(rowIDs: any[], clearCurrentSelection?: boolean): void
Inherited from GridType.selectRows
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:662
Parameters
- rowIDs: any[]
- Optional clearCurrentSelection: boolean
Returns void

selectedColumns

selectedColumns(): ColumnType[]
Inherited from GridType.selectedColumns
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:618
Returns ColumnType[]

setFilteredData

setFilteredData(data: any, pinned: boolean): void
Inherited from GridType.setFilteredData
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:635
Parameters
- data: any
- pinned: boolean
Returns void

setFilteredSortedData

setFilteredSortedData(data: any, pinned: boolean): void
Inherited from GridType.setFilteredSortedData
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:636
Parameters
- data: any
- pinned: boolean
Returns void

setUpPaginator

setUpPaginator(): void
Inherited from GridType.setUpPaginator
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:666
Returns void

showSnackbarFor

showSnackbarFor(index: number): void
Inherited from GridType.showSnackbarFor
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:629
Parameters
- index: number
Returns void

sort

sort(expression: ISortingExpression<any> | ISortingExpression<any>[]): void
Inherited from GridType.sort
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:637
Parameters
- expression: ISortingExpression<any> | ISortingExpression<any>[]
Returns void

`Optional` toggleAll

toggleAll(): void
Inherited from GridType.toggleAll
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:686
Returns void

`Optional` toggleAllGroupRows

toggleAllGroupRows(): void
Inherited from GridType.toggleAllGroupRows
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:685
Returns void

toggleGroup

toggleGroup(groupRow: IGroupByRecord): void
Overrides GridType.toggleGroup
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:699
Parameters
- groupRow: IGroupByRecord
Returns void

trackColumnChanges

trackColumnChanges(index: number, column: any): any
Inherited from GridType.trackColumnChanges
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:621
Parameters
- index: number
- column: any
Returns any

triggerPipes

triggerPipes(): void
Inherited from GridType.triggerPipes
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:677
Returns void

unpinRow

unpinRow(id: any, row?: RowType): boolean
Inherited from GridType.unpinRow
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:640
Parameters
- id: any
- Optional row: RowType
Returns boolean

updateCell

updateCell(value: any, rowSelector: any, column: string): void
Inherited from GridType.updateCell
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:668
Parameters
- value: any
- rowSelector: any
- column: string
Returns void

updateColumns

updateColumns(columns: ColumnType[]): void
Inherited from GridType.updateColumns
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:613
Parameters
- columns: ColumnType[]
Returns void

updateRow

updateRow(value: any, rowSelector: any): void
Inherited from GridType.updateRow
- Defined in projects/igniteui-angular/src/lib/grids/common/grid.interface.ts:673
Parameters
- value: any
- rowSelector: any
Returns void

Interface FlatGridType

Hierarchy

Hierarchy

Properties

Accessors

Methods

Properties

Optional _baseFontSize

_filteredSortedUnpinnedData

_filteredUnpinnedData

_totalRecords

activeNodeChange

advancedFilteringExpressionsTree

advancedFilteringExpressionsTreeChange

allowAdvancedFiltering

allowFiltering

batchEditing

Optional batchEditingChange

calcHeight

calcWidth

Optional cascadeOnDelete

Readonly cdr

cellClick

cellEdit

cellEditDone

cellEditEnter

cellEditExit

cellSelection

Optional childDataKey

Optional childLayoutKeys

Optional childLayoutList

Optional childRow

columnInDrag

columnList

columnMoving

columnMovingEnd

columnMovingStart

columnPin

columnPinned

columnResized

columnSelection

columnSelectionChanging

columnVisibilityChanged

columnVisibilityChanging

columnWidthSetByUser

columns

contextMenu

currencyPositionLeft

data

dataCloneStrategy

dataRowList

dataView

dataWithAddedInTransactionRows

defaultHeaderGroupMinWidth

defaultRowHeight

defaultSummaryHeight

densityChanged

disableTransitions

displayDensity

doubleClick

dragIndicatorIconBase

dragIndicatorIconTemplate

excelStyleHeaderIconTemplate

Optional expansionDepth

expansionStates

filterMode

filterStrategy

filteredSortedData

filtering

filteringDone

filteringExpressionsTree

filteringExpressionsTreeChange

filteringLogic

filteringPipeTrigger

firstEditableColumnIndex

Optional flatData

Optional foreignKey

formGroupCreated

getHeaderCellWidth

Type declaration

`Optional` _baseFontSize

`Optional` batchEditingChange

`Optional` cascadeOnDelete

`Readonly` cdr

`Optional` childDataKey

`Optional` childLayoutKeys

`Optional` childLayoutList

`Optional` childRow

`Optional` expansionDepth

`Optional` flatData

`Optional` foreignKey

`Readonly` gridAPI

`Optional` groupByRowSelectorTemplate

`Optional` groupRowTemplate

`Optional` groupStrategy

`Optional` groupingFlatResult

`Optional` groupingMetadata

`Optional` groupingResult

`Optional` groupsExpanded

`Optional` `Readonly` groupsRecords

`Optional` hasChildrenKey

`Optional` hasExpandableChildren

`Optional` highlightedRowID

`Optional` iconTemplate

`Optional` lastChildGrid

`Optional` loadChildrenOnDemand

`Optional` loadingRows

`Optional` parent