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:661

activeNodeChange: EventEmitter<IActiveNodeChangeEventArgs>

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

advancedFilteringExpressionsTree: IFilteringExpressionsTree

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

advancedFilteringExpressionsTreeChange

Section titled "advancedFilteringExpressionsTreeChange"
advancedFilteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree>

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

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:461

Optional batchEditingChange

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

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

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

calcHeight: number

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

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:777

cellEditDone: EventEmitter<IGridEditDoneEventArgs>

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

cellEditEnter: EventEmitter<IGridEditEventArgs>

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

cellEditExit: EventEmitter<IGridEditDoneEventArgs>

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

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

cellSelection: GridSelectionMode

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

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:551

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:683

columnMoving: EventEmitter<IColumnMovingEventArgs>

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

columnMovingEnd: EventEmitter<IColumnMovingEndEventArgs>

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

columnMovingStart: EventEmitter<IColumnMovingStartEventArgs>

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

columnPin: EventEmitter<IPinColumnCancellableEventArgs>

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

columnPinned: EventEmitter<IPinColumnEventArgs>

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

columnResized: EventEmitter<IColumnResizeEventArgs>

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

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

columnSelection: GridSelectionMode

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

columnSelectionChanging: EventEmitter<IColumnSelectionEventArgs>

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

columnVisibilityChanged: EventEmitter<IColumnVisibilityChangedEventArgs>

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

columnVisibilityChanging: EventEmitter<IColumnVisibilityChangingEventArgs>

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

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:651

contextMenu: EventEmitter<IGridContextMenuEventArgs>

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

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:648

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:491

Indicates whether transitions are disabled for the grid.

disableTransitions: boolean

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

doubleClick: EventEmitter<IGridCellEventArgs>

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

The base drag indicator icon. Could be of any type

dragIndicatorIconBase: any

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

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:642

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:794

filteringDone: EventEmitter<IFilteringExpressionsTree>

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

filteringExpressionsTree: IFilteringExpressionsTree

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

filteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree>

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

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:497

formGroupCreated: EventEmitter<IGridFormGroupCreatedEventArgs>

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

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:770

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:494

gridKeydown: EventEmitter<IGridKeydownEventArgs>

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

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:599

Optional groupingExpansionState

Section titled "groupingExpansionState"
groupingExpansionState?: IGroupByExpandState[]

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

Optional groupingExpressions

Section titled "groupingExpressions"
groupingExpressions?: IGroupingExpression[]

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

Optional groupingExpressionsChange

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

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

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:593

Optional groupStrategy

Section titled "groupStrategy"
groupStrategy?: IGridGroupingStrategy

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

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:570

Indicates whether the grid has columns that are shown

hasVisibleColumns: boolean

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

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:635

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:640

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:610

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

hiddenColumnsCount: number

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

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:587

Represents the unique identifier of the grid.

id: string

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

Indicates whether cells are selectable in the grid

isCellSelectable: boolean

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

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:708

Indicates whether the grid's rows can be selected

isRowSelectable: boolean

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

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:743

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:450

Indicates whether the grid is currently in a moving state.

moving: boolean

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

Represents the native HTML element itself

nativeElement: HTMLElement

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

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:734

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:690

Represents the count of only the pinned columns

pinnedColumnsCount: number

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

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:694

The width of pinned element for pinning at end.

pinnedEndWidth: number

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

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:692

The width of pinned element for pinning at start.

pinnedStartWidth: number

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

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:674

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:465

Optional processedExpandedFlatData

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

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

Optional processedRecords

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

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

Optional processedRootRecords

Section titled "processedRootRecords"
processedRootRecords?: ITreeGridRecord[]

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

rangeSelected: EventEmitter<GridSelectionRange>

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

The height of the visible rows in the grid.

renderedRowHeight: number

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

rowAdd: EventEmitter<IRowDataCancelableEventArgs>

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

rowAddedNotifier: Subject<IRowDataEventArgs>

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

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:789

rowDelete: EventEmitter<IRowDataCancelableEventArgs>

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

rowDeletedNotifier: Subject<IRowDataEventArgs>

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

rowDragEnd: EventEmitter<IRowDragEndEventArgs>

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

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:463

Indicates whether a row is currently being dragged

rowDragging: boolean

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

rowDragStart: EventEmitter<IRowDragStartEventArgs>

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

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:458

rowEditDone: EventEmitter<IGridEditDoneEventArgs>

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

rowEditEnter: EventEmitter<IGridEditEventArgs>

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

rowEditExit: EventEmitter<IGridEditDoneEventArgs>

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

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:784

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:657

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:605

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

rowSelection: GridSelectionMode

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

rowSelectionChanging: EventEmitter<IRowSelectionEventArgs>

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

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:615

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

selectionService: IgxGridSelectionService

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

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:575

Indicates whether the selectors of the rows are visible

showRowSelectors: boolean

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

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:625

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:630

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:620

sortingExpressions: ISortingExpression<any>[]

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

sortingExpressionsChange: EventEmitter<ISortingExpression<any>[]>

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

The CSS margin of the summaries

summariesMargin: number

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

summariesRowList: QueryList<IgxSummaryRowComponent>

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

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

summaryCalculationMode: GridSummaryCalculationMode

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

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

summaryPosition: GridSummaryPosition

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

toolbarExporting: EventEmitter<IGridToolbarExportEventArgs>

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

Represents the transaction service for the grid.

transactions: TransactionService<Transaction, State>

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

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:767

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:688

The width of unpinned element

unpinnedWidth: number

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

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:724

validationStatusChange: EventEmitter<IGridValidationStatusEventArgs>

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

Determines when the validation error tooltip of an invalid cell is displayed. Its value can either be active or hover

validationTooltipTrigger: GridValidationTooltipTrigger

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

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:665

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:529

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:686