GridType

Interface representing a grid type. It is essentially the blueprint to a grid object. Contains definitions of properties and methods, relevant to a grid Extends IGridDataBindable

Optional _baseFontSize

Section titled "_baseFontSize"

The default font size, calculated for each element

_baseFontSize?: number

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:658

activeNodeChange: EventEmitter<IActiveNodeChangeEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:835

advancedFilteringExpressionsTree: IFilteringExpressionsTree

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:894

advancedFilteringExpressionsTreeChange

Section titled "advancedFilteringExpressionsTreeChange"
advancedFilteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:895

Indicates whether filtering in the grid is enabled. If te value is true, the grid can be filtered

allowFiltering: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:457

Optional batchEditingChange

Section titled "batchEditingChange"
batchEditingChange?: EventEmitter<boolean>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:856

CSS styling calculated for an element: calcHeight, calcWidth, outerWidth

calcHeight: number

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:650

Provides change detection functionality. A change-detection tree collects all views that are to be checked for changes. The property cannot be changed (readonly)

cdr: ChangeDetectorRef

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:770

cellClick: EventEmitter<IGridCellEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:837

cellEdit: EventEmitter<IGridEditEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:866

cellEditDone: EventEmitter<IGridEditDoneEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:867

cellEditEnter: EventEmitter<IGridEditEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:865

cellEditExit: EventEmitter<IGridEditDoneEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:868

Represents the selection mode for cells: 'none','single', 'multiple', 'multipleCascade'

cellSelection: GridSelectionMode

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:791

Optional childLayoutList

Section titled "childLayoutList"
childLayoutList?: QueryList<any>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:824

Indicates if the column of the grid is in drag mode

columnInDrag: any

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:547

An unmodifiable list, containing all the columns of the grid.

columnList: QueryList<ColumnType>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:676

columnMoving: EventEmitter<IColumnMovingEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:851

columnMovingEnd: EventEmitter<IColumnMovingEndEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:849

columnMovingStart: EventEmitter<IColumnMovingStartEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:852

columnPin: EventEmitter<IPinColumnCancellableEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:853

columnPinned: EventEmitter<IPinColumnEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:847

columnResized: EventEmitter<IColumnResizeEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:848

Represents the selection mode for columns: 'none','single', 'multiple', 'multipleCascade'

columnSelection: GridSelectionMode

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:795

columnSelectionChanging: EventEmitter<IColumnSelectionEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:850

columnVisibilityChanged: EventEmitter<IColumnVisibilityChangedEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:855

columnVisibilityChanging: EventEmitter<IColumnVisibilityChangingEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:854

Indicates whether the width of the column is set by the user, or is configured automatically.

columnWidthSetByUser: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:647

contextMenu: EventEmitter<IGridContextMenuEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:840

Indicates whether the currency symbol is positioned to the left of values.

currencyPositionLeft: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:644

Strategy, used for cloning the provided data. The type has one method, that takes any type of data

dataCloneStrategy: IDataCloneStrategy

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:487

dataWithAddedInTransactionRows: any[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:713

Indicates whether transitions are disabled for the grid.

disableTransitions: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:642

doubleClick: EventEmitter<IGridCellEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:839

The base drag indicator icon. Could be of any type

dragIndicatorIconBase: any

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:640

The template for drag indicator icons. Could be of any type

dragIndicatorIconTemplate: any

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:638

The template for header icon It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

excelStyleHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:787

filtering: EventEmitter<IFilteringEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:845

filteringDone: EventEmitter<IFilteringExpressionsTree>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:846

filteringExpressionsTree: IFilteringExpressionsTree

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:892

filteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:893

The filter mode for the grid. It can be quick filter of excel-style filter

filterMode: FilterMode

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:493

formGroupCreated: EventEmitter<IGridFormGroupCreatedEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:876

Property, that gets the header cell inner width for auto-sizing.

getHeaderCellWidth: object

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:763

Represents the grid service type providing API methods for the grid

gridAPI: GridServiceType

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:490

gridKeydown: EventEmitter<IGridKeydownEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:836

Optional groupByRowSelectorTemplate

Section titled "groupByRowSelectorTemplate"

Optional The template for the group row selector. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

groupByRowSelectorTemplate?: TemplateRef<IgxGroupByRowSelectorTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:595

Optional groupingExpansionState

Section titled "groupingExpansionState"
groupingExpansionState?: IGroupByExpandState[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:899

Optional groupingExpressions

Section titled "groupingExpressions"
groupingExpressions?: IGroupingExpression[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:900

Optional groupingExpressionsChange

Section titled "groupingExpressionsChange"
groupingExpressionsChange?: EventEmitter<IGroupingExpression[]>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:901

Optional groupRowTemplate

Section titled "groupRowTemplate"

Optional The template for group-by rows. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

groupRowTemplate?: TemplateRef<IgxGroupByRowTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:589

Optional groupsRecords

Section titled "groupsRecords"
groupsRecords?: IGroupByRecord[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:903

Optional groupStrategy

Section titled "groupStrategy"
groupStrategy?: IGridGroupingStrategy

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:886

Optional hasExpandableChildren

Section titled "hasExpandableChildren"

Optional Indicates whether the grid has expandable children (hierarchical and tree grid)

hasExpandableChildren?: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:566

Indicates whether the grid has columns that are shown

hasVisibleColumns: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:561

The template for header collapsed indicators. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

headerCollapsedIndicatorTemplate: TemplateRef<IgxGridTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:631

The template for header expanded indicators. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

headerExpandedIndicatorTemplate: TemplateRef<IgxGridTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:636

The template for the header selector. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

headSelectorTemplate: TemplateRef<IgxHeadSelectorTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:606

Represents the count of only the hidden (not visible) columns

hiddenColumnsCount: number

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:574

Optional iconTemplate

Section titled "iconTemplate"

Optional The template for grid icons. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

iconTemplate?: TemplateRef<any>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:583

Represents the unique identifier of the grid.

id: string

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:463

Indicates whether cells are selectable in the grid

isCellSelectable: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:699

Indicates whether it is allowed to select more than one row in the grid

isMultiRowSelectionEnabled: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:701

Indicates whether the grid's rows can be selected

isRowSelectable: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:543

Represents the last search in the grid It contains the search text (the user has entered), the match and some settings for the search

lastSearchInfo: ISearchInfo

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:736

Optional loadChildrenOnDemand

Section titled "loadChildrenOnDemand"
loadChildrenOnDemand?: object

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:815

Represents the locale of the grid: USD, EUR, GBP, CNY, JPY, etc.

locale: string

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:446

Indicates whether the grid is currently in a moving state.

moving: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:476

Represents the native HTML element itself

nativeElement: HTMLElement

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:452

Represents the paging of the grid. It can be either 'Local' or 'Remote'

  • Local: Default value; The grid will paginate the data source based on the page
pagingMode: GridPagingMode

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:727

An array of columns, but it counts only the ones that are pinned

pinnedColumns: ColumnType[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:683

Represents the count of only the pinned columns

pinnedColumnsCount: number

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:576

An array of columns, but it counts only the ones that are pinned to the end.

pinnedEndColumns: ColumnType[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:687

The width of pinned element for pinning at end.

pinnedEndWidth: number

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:552

An array of columns, but it counts only the ones that are pinned to the start.

pinnedStartColumns: ColumnType[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:685

The width of pinned element for pinning at start.

pinnedStartWidth: number

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:550

The configuration for columns and rows pinning in the grid It's of type IPinningConfig, which can have value for columns (start, end) and for rows (top, bottom)

pinning: IPinningConfig

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:667

Represents the unique primary key used for identifying rows in the grid

primaryKey: string

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:461

Optional processedExpandedFlatData

Section titled "processedExpandedFlatData"
processedExpandedFlatData?: any[] | null

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:830

Optional processedRecords

Section titled "processedRecords"
processedRecords?: Map<any, ITreeGridRecord>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:832

Optional processedRootRecords

Section titled "processedRootRecords"
processedRootRecords?: ITreeGridRecord[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:826

rangeSelected: EventEmitter<GridSelectionRange>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:842

records?: Map<any, ITreeGridRecord>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:829

The height of the visible rows in the grid.

renderedRowHeight: number

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:465

rowAdd: EventEmitter<IRowDataCancelableEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:857

rowAddedNotifier: Subject<IRowDataEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:860

The template for collapsed row indicators. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

rowCollapsedIndicatorTemplate: TemplateRef<IgxGridRowTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:782

rowDelete: EventEmitter<IRowDataCancelableEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:861

rowDeleted: EventEmitter<IRowDataEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:862

rowDeletedNotifier: Subject<IRowDataEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:864

rowDragEnd: EventEmitter<IRowDragEndEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:874

Indicates whether rows in the grid can be dragged. If te value is true, the rows can be dragged

rowDraggable: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:459

Indicates whether a row is currently being dragged

rowDragging: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:745

rowDragStart: EventEmitter<IRowDragStartEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:873

Indicates whether rows in the grid are editable. If te value is true, the rows can be edited

rowEditable: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:454

rowEditDone: EventEmitter<IGridEditDoneEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:871

rowEditEnter: EventEmitter<IGridEditEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:869

rowEditExit: EventEmitter<IGridEditDoneEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:872

The template for expanded row indicators. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

rowExpandedIndicatorTemplate: TemplateRef<IgxGridRowTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:777

The height of each row in the grid. Setting a constant height can solve problems with not showing all elements when scrolling

rowHeight: number

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:654

Optional rowLoadingIndicatorTemplate

Section titled "rowLoadingIndicatorTemplate"

Optional The template for row loading indicators. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

rowLoadingIndicatorTemplate?: TemplateRef<any>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:601

Represents the selection mode for rows: 'none','single', 'multiple', 'multipleCascade'

rowSelection: GridSelectionMode

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:793

rowSelectionChanging: EventEmitter<IRowSelectionEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:843

The template for row selectors. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

rowSelectorTemplate: TemplateRef<IgxRowSelectorTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:611

rowToggle: EventEmitter<IRowToggleEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:875

selected: EventEmitter<IGridCellEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:841

The service handling selection in the grid. Selecting, deselecting elements

selectionService: IgxGridSelectionService

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:529

Optional showExpandAll

Section titled "showExpandAll"

Optional Indicates whether collapsed grid elements should be expanded

showExpandAll?: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:571

Indicates whether the selectors of the rows are visible

showRowSelectors: boolean

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:545

The template for ascending sort header icons. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

sortAscendingHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:621

The template for descending sort header icons. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

sortDescendingHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:626

The template for sort header icons. It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views

sortHeaderIconTemplate: TemplateRef<IgxGridHeaderTemplateContext>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:616

sortingExpressions: ISortingExpression<any>[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:890

sortingExpressionsChange: EventEmitter<ISortingExpression<any>[]>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:891

The CSS margin of the summaries

summariesMargin: number

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:557

summariesRowList: QueryList<IgxSummaryRowComponent>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:695

Represents the calculation mode for summaries: 'rootLevelOnly', 'childLevelsOnly', 'rootAndChildLevels'

summaryCalculationMode: GridSummaryCalculationMode

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:797

Represents the position of summaries: 'top', 'bottom'

summaryPosition: GridSummaryPosition

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:799

toolbarExporting: EventEmitter<IGridToolbarExportEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:879

Represents the transaction service for the grid.

transactions: TransactionService<Transaction, State>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:715

Optional uniqueColumnValuesStrategy

Section titled "uniqueColumnValuesStrategy"

Property, that provides a callback for loading unique column values on demand. If this property is provided, the unique values it generates will be used by the Excel Style Filtering

uniqueColumnValuesStrategy?: object

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:760

An array of columns, but it counts only the ones that are not pinned

unpinnedColumns: ColumnType[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:681

The width of unpinned element

unpinnedWidth: number

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:555

Represents the validation service for the grid. The type contains properties and methods (logic) for validating records

validation: IgxGridValidationService

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:717

validationStatusChange: EventEmitter<IGridValidationStatusEventArgs>

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:877

The trigger for grid validation. It's value can either be change or blur

validationTrigger: GridValidationTrigger

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:662

Represents the state of virtualization for the grid. It has an owner, start index and chunk size

virtualizationState: IForOfState

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:525

An array of columns, but it counts only the ones visible (not hidden) in the view

visibleColumns: ColumnType[]

Defined in projects/igniteui-angular/grids/core/src/common/grid.interface.ts:679