IgxGridBaseDirective

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

Constructors

new IgxGridBaseDirective(): IgxGridBaseDirective

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:3471

Returns IgxGridBaseDirective

Properties

activeNodeChange

Emitted when the active node is changed.

activeNodeChange: EventEmitter<IActiveNodeChangeEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1058

Example

<igx-grid [data]="data" [autoGenerate]="true" (activeNodeChange)="activeNodeChange($event)"></igx-grid>

addRowEmptyTemplate

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

addRowEmptyTemplate: TemplateRef<void>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:268

Example

<igx-grid [id]="'igx-grid-1'" [data]="Data" [addRowEmptyTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>

advancedFilteringExpressionsTreeChange

Emitted after advanced filtering is performed.

advancedFilteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:385

Remarks

Returns the advanced filtering expressions tree.

Example

<igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
          (advancedFilteringExpressionsTreeChange)="advancedFilteringExprTreeChange($event)"></igx-grid>

autoGenerate

Gets/Sets whether to auto-generate the columns.

autoGenerate: boolean = false

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:211

Remarks

The default value is false. When set to true, it will override all columns declared through code or in markup.

Example

<igx-grid [data]="Data" [autoGenerate]="true"></igx-grid>

autoGenerateExclude

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

autoGenerateExclude: string[] = []

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:228

Remarks

The collection is only used during initialization and changing it will not cause any changes in the generated columns at runtime unless the grid is destroyed and recreated. To modify the columns visible in the UI at runtime, please use their hidden property.

Example

<igx-grid data=[Data] [autoGenerate]="true" [autoGenerateExclude]="['ProductName', 'Count']"></igx-grid>

const Data = [{ 'Id': '1', 'ProductName': 'name1', 'Description': 'description1', 'Count': 5 }]

cdr

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/grid/src/grid-base.directive.ts:167

cellClick

Emitted when a cell is clicked.

cellClick: EventEmitter<IGridCellEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:499

Remarks

Returns the grid cell.

Example

<igx-grid #grid (cellClick)="cellClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>

cellEdit

Emitted when cell has been edited.

cellEdit: EventEmitter<IGridEditEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:645

Remarks

Event is fired after editing is completed, when the cell is exiting edit mode. This event is cancelable.

Example

<igx-grid #grid3 (cellEdit)="editDone($event)" [data]="data" [primaryKey]="'ProductID'">
</igx-grid>

cellEditDone

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

cellEditDone: EventEmitter<IGridEditDoneEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:658

Example

<igx-grid #grid3 (cellEditDone)="editDone($event)" [data]="data" [primaryKey]="'ProductID'">
</igx-grid>

cellEditEnter

Emitted when cell enters edit mode.

cellEditEnter: EventEmitter<IGridEditEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:618

Remarks

This event is cancelable.

Example

<igx-grid #grid3 (cellEditEnter)="editStart($event)" [data]="data" [primaryKey]="'ProductID'">
</igx-grid>

cellEditExit

Emitted when cell exits edit mode.

cellEditExit: EventEmitter<IGridEditDoneEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:630

Example

<igx-grid #grid3 (cellEditExit)="editExit($event)" [data]="data" [primaryKey]="'ProductID'">
</igx-grid>

clipboardOptions

Controls the copy behavior of the grid.

clipboardOptions: IClipboardOptions

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:340

columnInit

Emitted when a column is initialized.

columnInit: EventEmitter<IgxColumnComponent>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:737

Remarks

Returns the column object.

Example

<igx-grid #grid [data]="localData" (columnInit)="initColumns($event)" [autoGenerate]="true"></igx-grid>

columnMoving

Emitted during the column moving operation.

columnMoving: EventEmitter<IColumnMovingEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:936

Remarks

Returns the source and target column objects. This event is cancelable.

Example

<igx-grid (columnMoving)="moving($event)"></igx-grid>

columnMovingEnd

Emitted when column moving ends.

columnMovingEnd: EventEmitter<IColumnMovingEndEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:949

Remarks

Returns the source and target column objects.

Example

<igx-grid (columnMovingEnd)="movingEnds($event)"></igx-grid>

columnMovingStart

Emitted when column moving starts.

columnMovingStart: EventEmitter<IColumnMovingStartEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:923

Remarks

Returns the moved column object.

Example

<igx-grid (columnMovingStart)="movingStart($event)"></igx-grid>

columnPin

Emitted before column is pinned.

columnPin: EventEmitter<IPinColumnCancellableEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:587

Remarks

The index at which to insert the column may be changed through the insertAtIndex property.

Example

public columnPinning(event) {
    if (event.column.field === "Name") {
      event.insertAtIndex = 0;
    }
}

columnPinned

Emitted after column is pinned.

columnPinned: EventEmitter<IPinColumnEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:604

Remarks

The index that the column is inserted at may be changed through the insertAtIndex property.

Example

public columnPinning(event) {
    if (event.column.field === "Name") {
      event.insertAtIndex = 0;
    }
}

columnResized

Emitted after column is resized.

columnResized: EventEmitter<IColumnResizeEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:859

Remarks

Returns the column object's old and new width.

Example

<igx-grid #grid [data]="localData" (columnResized)="resizing($event)" [autoGenerate]="true"></igx-grid>

columnSelectionChanging

Emitted when column is selected.

columnSelectionChanging: EventEmitter<IColumnSelectionEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:570

Example

<igx-grid #grid (columnSelectionChanging)="columnSelectionChanging($event)" [data]="localData" [autoGenerate]="true"></igx-grid>

columnVisibilityChanged

Emitted after column visibility is changed.

columnVisibilityChanged: EventEmitter<IColumnVisibilityChangedEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:910

Remarks

Args: { column: IgxColumnComponent, newValue: boolean }

Example

<igx-grid (columnVisibilityChanged)="visibilityChanged($event)"></igx-grid>

columnVisibilityChanging

Emitted before column visibility is changed.

columnVisibilityChanging: EventEmitter<IColumnVisibilityChangingEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:897

Remarks

Args: { column: any, newValue: boolean }

Example

<igx-grid (columnVisibilityChanging)="visibilityChanging($event)"></igx-grid>

contextMenu

Emitted when a cell or row is right clicked.

contextMenu: EventEmitter<IGridContextMenuEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:871

Remarks

Returns the grid cell object if the immediate context menu target is a cell or an grid row otherwise.

<igx-grid #grid [data]="localData" (contextMenu)="contextMenu($event)" [autoGenerate]="true"></igx-grid>

data

data: any[] | null

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:3319

dataChanged

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

dataChanged: EventEmitter<IForOfDataChangeEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1128

Example

<igx-grid #grid [data]="localData" [autoGenerate]="true" (dataChanged)='handleDataChangedEvent()'></igx-grid>

dataChanging

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

dataChanging: EventEmitter<IForOfDataChangeEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1117

Example

<igx-grid #grid [data]="localData" [autoGenerate]="true" (dataChanging)='handleDataChangingEvent()'></igx-grid>

doubleClick

Emitted when a cell is double clicked.

doubleClick: EventEmitter<IGridCellEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:884

Remarks

Returns the grid cell object.

Example

<igx-grid #grid [data]="localData" (doubleClick)="dblClick($event)" [autoGenerate]="true"></igx-grid>

expansionStatesChange

Emitted when the rows are expanded or collapsed.

expansionStatesChange: EventEmitter<Map<any, boolean>>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1002

Example

<igx-grid [data]="employeeData" (expansionStatesChange)="expansionStatesChange($event)" [autoGenerate]="true"></igx-grid>

filtering

Emitted before filtering expressions are applied.

filtering: EventEmitter<IFilteringEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:777

Remarks

Returns an IFilteringEventArgs object. filteringExpressions key holds the filtering expressions for the column.

Example

<igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true" (filtering)="filtering($event)"></igx-grid>

filteringDone

Emitted after filtering is performed through the UI.

filteringDone: EventEmitter<IFilteringExpressionsTree>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:790

Remarks

Returns the filtering expressions tree of the column for which filtering was performed.

Example

<igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true" (filteringDone)="filteringDone($event)"></igx-grid>

filteringExpressionsTreeChange

Emitted after filtering is performed.

filteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:371

Remarks

Returns the filtering expressions tree of the column for which filtering was performed.

Example

<igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
             (filteringExpressionsTreeChange)="filteringExprTreeChange($event)"></igx-grid>

formGroupCreated

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

formGroupCreated: EventEmitter<IGridFormGroupCreatedEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:524

Example

<igx-grid #grid (formGroupCreated)="formGroupCreated($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>

gridAPI

Represents the grid service type providing API methods for the grid

gridAPI: GridServiceType

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:160

gridCopy

Emitted when a copy operation is executed.

gridCopy: EventEmitter<IGridClipboardEvent>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:990

Remarks

Fired only if copy behavior is enabled through the [clipboardOptions]IgxGridBaseDirective#clipboardOptions.

gridKeydown

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

gridKeydown: EventEmitter<IGridKeydownEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:963

Remarks

This event is fired only if the key combination is supported in the grid. Return the target type, target object and the original event. This event is cancelable.

Example

<igx-grid (gridKeydown)="customKeydown($event)"></igx-grid>

gridScroll

Emitted when grid is scrolled horizontally/vertically.

gridScroll: EventEmitter<IGridScrollEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:397

Example

<igx-grid #grid [data]="localData" [height]="'305px'" [autoGenerate]="true"
             (gridScroll)="onScroll($event)"></igx-grid>

moving

Controls whether columns moving is enabled in the grid.

moving: boolean = false

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:235

navigation: IgxGridNavigationService

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:173

rangeSelected

Emitted when making a range selection.

rangeSelected: EventEmitter<GridSelectionRange>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1096

Remarks

Range selection can be made either through drag selection or through keyboard selection.

rendered

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

rendered: EventEmitter<boolean>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1100

rowAdd

Emmited just before the newly added row is commited.

rowAdd: EventEmitter<IRowDataCancelableEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:846

Remarks

This event is cancelable. Returns an IRowDataCancellableEventArgs` object.

Example

<igx-grid #grid [data]="localData" (rowAdd)="rowAdd($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>

rowAdded

Emitted when a row is added.

rowAdded: EventEmitter<IRowDataEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:804

Remarks

Returns the data for the new grid row object.

Example

<igx-grid #grid [data]="localData" (rowAdded)="rowAdded($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>

rowClasses

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:

callback = (row: RowType) => { return row.selected > 6; }
rowClasses = { 'className' : this.callback };

<igx-grid #grid [data]="Data" [rowClasses] = "rowClasses" [autoGenerate]="true"></igx-grid>

rowClasses: any

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:416

rowClick

Emitted when a row is clicked.

rowClick: EventEmitter<IGridRowEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:512

Remarks

Returns the grid row.

Example

<igx-grid #grid (rowClick)="rowClick($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>

rowDelete

Emmited when deleting a row.

rowDelete: EventEmitter<IRowDataCancelableEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:832

Remarks

This event is cancelable. Returns an IRowDataCancellableEventArgs` object.

Example

<igx-grid #grid [data]="localData" (rowDelete)="rowDelete($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>

rowDeleted

Emitted when a row is deleted.

rowDeleted: EventEmitter<IRowDataEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:818

Remarks

Returns an IRowDataEventArgs object.

Example

<igx-grid #grid [data]="localData" (rowDeleted)="rowDeleted($event)" [height]="'305px'" [autoGenerate]="true"></igx-grid>

rowDragEnd

Emitted when dropping a row.

rowDragEnd: EventEmitter<IRowDragEndEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:981

Remarks

Return the dropped row.

rowDragStart

Emitted when start dragging a row.

rowDragStart: EventEmitter<IRowDragStartEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:972

Remarks

Return the dragged row.

rowEdit

Emitted when exiting edit mode for a row.

rowEdit: EventEmitter<IGridEditEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:691

Remarks

Emitted when [rowEditable]="true" & endEdit(true) is called. Emitted when changing rows during edit mode, selecting an un-editable cell in the edited row, performing paging operation, column resizing, pinning, moving or hitting Done button inside of the rowEditingOverlay, or hitting the Enter key while editing a cell. This event is cancelable.

Example

<igx-grid #grid3 (rowEdit)="editDone($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
</igx-grid>

rowEditDone

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

rowEditDone: EventEmitter<IGridEditDoneEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:708

Remarks

Example

<igx-grid #grid3 (rowEditDone)="editDone($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
</igx-grid>

rowEditEnter

Emitted when a row enters edit mode.

rowEditEnter: EventEmitter<IGridEditEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:673

Remarks

Emitted when [rowEditable]="true". This event is cancelable.

Example

<igx-grid #grid3 (rowEditEnter)="editStart($event)" [primaryKey]="'ProductID'" [rowEditable]="true">
</igx-grid>

rowEditExit

Emitted when row editing is canceled.

rowEditExit: EventEmitter<IGridEditDoneEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:724

Remarks

Emits when [rowEditable]="true" & endEdit(false) is called. Emitted when changing hitting Esc key during cell editing and when click on the Cancel button in the row editing overlay.

Example

<igx-grid #grid3 (rowEditExit)="editExit($event)" [data]="data" [primaryKey]="'ProductID'" [rowEditable]="true">
</igx-grid>

rowPinned

Emitted when the pinned state of a row is changed.

rowPinned: EventEmitter<IPinRowEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1047

Example

<igx-grid [data]="employeeData" (rowPinned)="rowPin($event)" [autoGenerate]="true"></igx-grid>

rowPinning

Emitted when the pinned state of a row is changed.

rowPinning: EventEmitter<IPinRowEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1036

Example

<igx-grid [data]="employeeData" (rowPinning)="rowPin($event)" [autoGenerate]="true"></igx-grid>

rowSelectionChanging

Emitted when grid row is selected.

rowSelectionChanging: EventEmitter<IRowSelectionEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:559

Example

<igx-grid #grid (rowSelectionChanging)="rowSelectionChanging($event)" [data]="localData" [autoGenerate]="true"></igx-grid>

rowStyles

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.

styles = {
 background: 'yellow',
 color: (row: RowType) => row.selected : 'red': 'white'
}

<igx-grid #grid [data]="Data" [rowStyles]="styles" [autoGenerate]="true"></igx-grid>

rowStyles: GridStyleCSSProperty | null = null

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:436

rowToggle

Emitted when the expanded state of a row gets changed.

rowToggle: EventEmitter<IRowToggleEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1025

Example

<igx-grid [data]="employeeData" (rowToggle)="rowToggle($event)" [autoGenerate]="true"></igx-grid>

selected

Emitted when a cell is selected.

selected: EventEmitter<IGridCellEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:548

Remarks

Returns the grid cell.

Example

<igx-grid #grid (selected)="onCellSelect($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>

selectedRowsChange

Emitted when the rows are selected or deselected.

selectedRowsChange: EventEmitter<any[]>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1014

Example

<igx-grid [data]="employeeData" (selectedRowsChange)="selectedRowsChange($event)" [autoGenerate]="true"></igx-grid>

snackbarDisplayTime

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

snackbarDisplayTime: number = 6000

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:198

Remarks

By default it is 6000ms.

sorting

Emitted before sorting expressions are applied.

sorting: EventEmitter<ISortingEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:751

Remarks

Returns an ISortingEventArgs object. sortingExpressions key holds the sorting expressions.

Example

<igx-grid #grid [data]="localData" [autoGenerate]="true" (sorting)="sorting($event)"></igx-grid>

sortingDone

Emitted after sorting is completed.

sortingDone: EventEmitter<ISortingExpression<any> | ISortingExpression<any>[]>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:764

Remarks

Returns the sorting expression.

Example

<igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingDone)="sortingDone($event)"></igx-grid>

sortingExpressionsChange

Emitted before sorting is performed.

sortingExpressionsChange: EventEmitter<ISortingExpression<any>[]>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1071

Remarks

Returns the sorting expressions.

Example

<igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingExpressionsChange)="sortingExprChange($event)"></igx-grid>

toolbarExporting

Emitted when an export process is initiated by the user.

toolbarExporting: EventEmitter<IGridToolbarExportEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1085

Example

toolbarExporting(event: IGridToolbarExportEventArgs){
    const toolbarExporting = event;
}

Optional uniqueColumnValuesStrategy

Gets/Sets a unique values strategy used by the Excel Style Filtering

uniqueColumnValuesStrategy: object

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:470

Remarks

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.

Example

<igx-grid [data]="localData" [filterMode]="'excelStyleFilter'" [uniqueColumnValuesStrategy]="columnValuesStrategy"></igx-grid>

validation

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/grid/src/grid-base.directive.ts:155

validationStatusChange

Emitted when grid's validation status changes.

validationStatusChange: EventEmitter<IGridValidationStatusEventArgs>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:535

Example

<igx-grid #grid (validationStatusChange)="validationStatusChange($event)" [data]="localData" [height]="'305px'" [autoGenerate]="true"></igx-grid>

validationTrigger

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

validationTrigger: GridValidationTrigger = 'change'

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2049

Example

<igx-grid #grid validationTrigger='blur'></igx-grid>

Accessors

advancedFilteringExpressionsTree

Gets/Sets the advanced filtering state.

get advancedFilteringExpressionsTree(): IFilteringExpressionsTree

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1906

Example

let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree;
this.grid.advancedFilteringExpressionsTree = logic;

Returns IFilteringExpressionsTree

set advancedFilteringExpressionsTree(value: IFilteringExpressionsTree): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1910

Parameters

value: IFilteringExpressionsTree

Returns void

allowAdvancedFiltering

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

get allowAdvancedFiltering(): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2323

Example

<igx-grid #grid [data]="localData" [allowAdvancedFiltering]="true" [autoGenerate]="true"></igx-grid>

Returns boolean

set allowAdvancedFiltering(value: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2327

Parameters

value: boolean

Returns void

allowFiltering

Gets/Sets if the filtering is enabled.

get allowFiltering(): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2297

Example

<igx-grid #grid [data]="localData" [allowFiltering]="true" [height]="'305px'" [autoGenerate]="true"></igx-grid>

Returns boolean

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

set allowFiltering(value: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2301

Parameters

value: boolean

Returns void

batchEditing

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.

get batchEditing(): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2804

Example

<igx-grid [batchEditing]="true" [data]="someData">
</igx-grid>

Returns boolean

set batchEditing(val: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2808

Parameters

val: boolean

Returns void

cellMergeMode

Gets/Sets cell merge mode.

get cellMergeMode(): GridCellMergeMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2874

Returns GridCellMergeMode

set cellMergeMode(value: GridCellMergeMode): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2878

Parameters

value: GridCellMergeMode

Returns void

cellSelection

Gets/Sets cell selection mode.

get cellSelection(): GridSelectionMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2855

Returns GridSelectionMode

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

set cellSelection(selectionMode: GridSelectionMode): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2859

Parameters

selectionMode: GridSelectionMode

Returns void

columns

Gets an array of columns.

get columns(): IgxColumnComponent[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4589

Example

const colums = this.grid.columns.

Returns IgxColumnComponent[]

columnSelection

Gets/Sets column selection mode

get columnSelection(): GridSelectionMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2916

Returns GridSelectionMode

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

set columnSelection(selectionMode: GridSelectionMode): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2920

Parameters

selectionMode: GridSelectionMode

Returns void

columnWidth

Gets/Sets the default width of the columns.

get columnWidth(): string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2173

Example

<igx-grid #grid [data]="localData" [columnWidth]="100" [autoGenerate]="true"></igx-grid>

Returns string

set columnWidth(value: string): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2176

Parameters

value: string

Returns void

dataCloneStrategy

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

get dataCloneStrategy(): IDataCloneStrategy

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:325

Example

<igx-grid #grid [data]="localData" [dataCloneStrategy]="customCloneStrategy"></igx-grid>

Returns IDataCloneStrategy

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

set dataCloneStrategy(strategy: IDataCloneStrategy): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:329

Parameters

strategy: IDataCloneStrategy

Returns void

dataRowList

A list of currently rendered grid row's.

get dataRowList(): QueryList<IgxRowDirective>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2593

Example

const dataList = this.grid.dataRowList;

Returns QueryList<IgxRowDirective>

dataView

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

get dataView(): any[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5799

Example

const dataView = this.grid.dataView;

Returns any[]

defaultRowHeight

Gets the default row height.

get defaultRowHeight(): number

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4489

Example

const rowHeigh = this.grid.defaultRowHeight;

Returns number

dragGhostCustomTemplate

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

get dragGhostCustomTemplate(): TemplateRef<IgxGridRowDragGhostContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1217

Returns TemplateRef<IgxGridRowDragGhostContext>

Sets a custom template for the row drag ghost.

<ng-template #template igxRowDragGhost>
   <igx-icon>menu</igx-icon>
</ng-template>

@ViewChild("'template'", {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.dragGhostCustomTemplate = this.template;

set dragGhostCustomTemplate(template: TemplateRef<IgxGridRowDragGhostContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1234

Parameters

template: TemplateRef<IgxGridRowDragGhostContext>

Returns void

dragIndicatorIconTemplate

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

get dragIndicatorIconTemplate(): TemplateRef<IgxGridEmptyTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2684

Returns TemplateRef<IgxGridEmptyTemplateContext>

Sets a custom template that should be used when rendering the row drag indicator icon.

<ng-template #template igxDragIndicatorIcon>
   <igx-icon>expand_less</igx-icon>
</ng-template>

@ViewChild("'template'", {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.dragIndicatorIconTemplate = this.template;

set dragIndicatorIconTemplate(val: TemplateRef<IgxGridEmptyTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2701

Parameters

val: TemplateRef<IgxGridEmptyTemplateContext>

Returns void

emptyFilteredGridMessage

get emptyFilteredGridMessage(): string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2260

Returns string

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

set emptyFilteredGridMessage(value: string): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2256

Example

<igx-grid #grid [data]="Data" [emptyGridMessage]="'The grid is empty'" [autoGenerate]="true"></igx-grid>

Parameters

value: string

Returns void

emptyGridMessage

get emptyGridMessage(): string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2194

Returns string

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

set emptyGridMessage(value: string): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2191

Example

<igx-grid #grid [data]="Data" [emptyGridMessage]="'The grid is empty'" [autoGenerate]="true"></igx-grid>

Parameters

value: string

Returns void

emptyGridTemplate

Gets/Sets a custom template when empty.

get emptyGridTemplate(): TemplateRef<IgxGridTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:252

Example

<ng-template igxGridEmpty>
  <!-- content to show when the grid is empty -->
</ng-template>

<igx-grid [id]="'igx-grid-1'" [data]="Data" [emptyGridTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>

Returns TemplateRef<IgxGridTemplateContext>

set emptyGridTemplate(template: TemplateRef<IgxGridTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:255

Parameters

template: TemplateRef<IgxGridTemplateContext>

Returns void

excelStyleHeaderIconTemplate

Gets the excel style header icon.

get excelStyleHeaderIconTemplate(): TemplateRef<IgxGridHeaderTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1567

Returns TemplateRef<IgxGridHeaderTemplateContext>

Sets the excel style header icon.

<ng-template #template igxExcelStyleHeaderIcon>
<igx-icon>filter_alt</igx-icon>
</ng-template>

@ViewChild('template', {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.excelStyleHeaderIconTemplate = this.template;

set excelStyleHeaderIconTemplate(template: TemplateRef<IgxGridHeaderTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1584

Parameters

template: TemplateRef<IgxGridHeaderTemplateContext>

Returns void

expansionStates

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

get expansionStates(): Map<any, boolean>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4354

Example

<igx-grid #grid [data]="data" [(expansionStates)]="model.expansionStates">
</igx-grid>

Returns Map<any, boolean>

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4359

Parameters

value: Map<any, boolean>

Returns void

filteredData

Returns an array of objects containing the filtered data.

get filteredData(): any

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:3329

Example

let filteredData = this.grid.filteredData;

Returns any

filteredSortedData

Returns an array containing the filtered sorted data.

get filteredSortedData(): any[] | null

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:3341

Example

const filteredSortedData = this.grid1.filteredSortedData;

Returns any[] | null

filteringExpressionsTree

Gets/Sets the filtering state.

get filteringExpressionsTree(): IFilteringExpressionsTree

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1860

Example

<igx-grid #grid [data]="Data" [autoGenerate]="true" [(filteringExpressionsTree)]="model.filteringExpressions"></igx-grid>

Returns IFilteringExpressionsTree

set filteringExpressionsTree(value: IFilteringExpressionsTree): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1864

Parameters

value: IFilteringExpressionsTree

Returns void

filteringLogic

Gets/Sets the filtering logic of the grid.

get filteringLogic(): FilteringLogic

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1839

Example

<igx-grid [data]="Data" [autoGenerate]="true" [filteringLogic]="filtering"></igx-grid>

Returns FilteringLogic

set filteringLogic(value: FilteringLogic): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1843

Parameters

value: FilteringLogic

Returns void

filterMode

Gets/Sets the filter mode.

get filterMode(): FilterMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2349

Example

<igx-grid #grid [data]="localData" [filterMode]="'quickFilter'" [height]="'305px'" [autoGenerate]="true"></igx-grid>

Returns FilterMode

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

set filterMode(value: FilterMode): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2353

Parameters

value: FilterMode

Returns void

filterStrategy

Gets/Sets the filtering strategy of the grid.

get filterStrategy(): IFilteringStrategy

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2443

Example

<igx-grid #grid [data]="localData" [filterStrategy]="filterStrategy"></igx-grid>

Returns IFilteringStrategy

set filterStrategy(classRef: IFilteringStrategy): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2447

Parameters

classRef: IFilteringStrategy

Returns void

hasVisibleColumns

Indicates whether the grid has columns that are shown

get hasVisibleColumns(): any

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5529

Indicates whether the grid has columns that are shown

set hasVisibleColumns(value: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5529

Parameters

value: boolean

Returns void

headerCollapsedIndicatorTemplate

Gets the row collapse indicator template.

get headerCollapsedIndicatorTemplate(): TemplateRef<IgxGridTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1538

Returns TemplateRef<IgxGridTemplateContext>

Sets the row collapse indicator template.

<ng-template igxHeaderCollapsedIndicator>
 <igx-icon role="button">add</igx-icon>
</ng-template>

@ViewChild('template', {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.headerCollapsedIndicatorTemplate = this.template;

set headerCollapsedIndicatorTemplate(template: TemplateRef<IgxGridTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1555

Parameters

template: TemplateRef<IgxGridTemplateContext>

Returns void

headerExpandedIndicatorTemplate

Gets the header expand indicator template.

get headerExpandedIndicatorTemplate(): TemplateRef<IgxGridTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1507

Returns TemplateRef<IgxGridTemplateContext>

Sets the header expand indicator template.

<ng-template igxHeaderExpandedIndicator>
 <igx-icon role="button">remove</igx-icon>
</ng-template>

@ViewChild('template', {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.headerExpandedIndicatorTemplate = this.template;

set headerExpandedIndicatorTemplate(template: TemplateRef<IgxGridTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1524

Parameters

template: TemplateRef<IgxGridTemplateContext>

Returns void

headSelectorTemplate

Gets the header row selector template.

get headSelectorTemplate(): TemplateRef<IgxHeadSelectorTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2607

Returns TemplateRef<IgxHeadSelectorTemplateContext>

Sets the header row selector template.

<ng-template #template igxHeadSelector let-headContext>
{{ headContext.selectedCount }} / {{ headContext.totalCount  }}
</ng-template>

@ViewChild("'template'", {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.headSelectorTemplate = this.template;

set headSelectorTemplate(template: TemplateRef<IgxHeadSelectorTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2624

Parameters

template: TemplateRef<IgxHeadSelectorTemplateContext>

Returns void

height

Gets/Sets the height.

get height(): string | null

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2095

Example

<igx-grid #grid [data]="Data" [height]="'305px'" [autoGenerate]="true"></igx-grid>

Returns string | null

set height(value: string | null): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2099

Parameters

value: string | null

Returns void

hiddenColumnsCount

Gets the number of hidden columns.

get hiddenColumnsCount(): number

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2781

Example

const hiddenCol = this.grid.hiddenColumnsCount;
``

Returns number

hideRowSelectors

Gets/Sets if the row selectors are hidden.

get hideRowSelectors(): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2013

Returns boolean

set hideRowSelectors(value: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2017

Parameters

value: boolean

Returns void

isLoading

get isLoading(): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2222

Returns boolean

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

set isLoading(value: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2209

Example

<igx-grid #grid [data]="Data" [isLoading]="true" [autoGenerate]="true"></igx-grid>

Parameters

value: boolean

Returns void

lastSearchInfo

Represents the last search information.

get lastSearchInfo(): ISearchInfo

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2963

Returns ISearchInfo

loadingGridTemplate

Gets/Sets a custom template when loading.

get loadingGridTemplate(): TemplateRef<IgxGridTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:285

Example

<ng-template igxGridLoading>
  <!-- content to show when the grid is loading -->
</ng-template>

<igx-grid [id]="'igx-grid-1'" [data]="Data" [loadingGridTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>

Returns TemplateRef<IgxGridTemplateContext>

set loadingGridTemplate(template: TemplateRef<IgxGridTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:288

Parameters

template: TemplateRef<IgxGridTemplateContext>

Returns void

locale

Gets/Sets the locale.

get locale(): string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1956

Returns string

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

set locale(value: string): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1960

Parameters

value: string

Returns void

mergeStrategy

Gets/Sets the merge strategy of the grid.

get mergeStrategy(): IGridMergeStrategy

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2478

Example

<igx-grid #grid [data]="localData" [mergeStrategy]="mergeStrategy"></igx-grid>

Returns IGridMergeStrategy

set mergeStrategy(value: IGridMergeStrategy): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2481

Parameters

value: IGridMergeStrategy

Returns void

nativeElement

Gets the native element.

get nativeElement(): HTMLElement

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4458

Example

const nativeEl = this.grid.nativeElement.

Returns HTMLElement

outlet

Gets/Sets the outlet used to attach the grid's overlays to.

get outlet(): IgxOverlayOutletDirective

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4472

Returns IgxOverlayOutletDirective

set outlet(val: IgxOverlayOutletDirective): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4476

Parameters

val: IgxOverlayOutletDirective

Returns void

pagingMode

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

get pagingMode(): GridPagingMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1973

Returns GridPagingMode

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

set pagingMode(val: GridPagingMode): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1977

Parameters

val: GridPagingMode

Returns void

pinnedColumns

Gets an array of the pinned columns.

get pinnedColumns(): IgxColumnComponent[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4601

Example

const pinnedColumns = this.grid.pinnedColumns.

Returns IgxColumnComponent[]

pinnedColumnsCount

Gets the number of pinned columns.

get pinnedColumnsCount(): number

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2788

Returns number

pinnedEndColumns

Gets an array of the pinned to the right columns.

get pinnedEndColumns(): IgxColumnComponent[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4629

Example

const pinnedColumns = this.grid.pinnedEndColumns.

Returns IgxColumnComponent[]

pinnedRows

Gets an array of the pinned rows.

get pinnedRows(): IgxRowDirective[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4642

Example

const pinnedRow = this.grid.pinnedRows;

Returns IgxRowDirective[]

pinnedStartColumns

Gets an array of the pinned to the left columns.

get pinnedStartColumns(): IgxColumnComponent[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4617

Example

const pinnedColumns = this.grid.pinnedStartColumns.

Returns IgxColumnComponent[]

pinning

Gets/Sets the initial pinning configuration.

get pinning(): IPinningConfig

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2277

Example

<igx-grid [pinning]="pinningConfig"></igx-grid>

Returns IPinningConfig

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)

set pinning(value: IPinningConfig): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2280

Parameters

value: IPinningConfig

Returns void

primaryKey

Gets/Sets the primary key.

get primaryKey(): string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:448

Example

<igx-grid #grid [data]="localData" [primaryKey]="'ProductID'" [autoGenerate]="true"></igx-grid>

Returns string

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

set primaryKey(value: string): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:452

Parameters

value: string

Returns void

resourceStrings

get resourceStrings(): IGridResourceStrings

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1823

Returns IGridResourceStrings

Gets/Sets the resource strings.

set resourceStrings(value: IGridResourceStrings): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1818

Parameters

value: IGridResourceStrings

Returns void

rowAddTextTemplate

Gets the row add text template.

get rowAddTextTemplate(): TemplateRef<IgxGridEmptyTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1384

Returns TemplateRef<IgxGridEmptyTemplateContext>

Sets the row add text template.

<ng-template #template igxRowAddText>
Adding Row
</ng-template>

@ViewChild('template', {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.rowAddTextTemplate = this.template;

set rowAddTextTemplate(template: TemplateRef<IgxGridEmptyTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1400

Parameters

template: TemplateRef<IgxGridEmptyTemplateContext>

Returns void

rowCollapsedIndicatorTemplate

Gets the row collapse indicator template.

get rowCollapsedIndicatorTemplate(): TemplateRef<IgxGridRowTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1476

Returns TemplateRef<IgxGridRowTemplateContext>

Sets the row collapse indicator template.

<ng-template igxRowCollapsedIndicator>
 <igx-icon role="button">add</igx-icon>
</ng-template>

@ViewChild('template', {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.rowCollapsedIndicatorTemplate = this.template;

set rowCollapsedIndicatorTemplate(template: TemplateRef<IgxGridRowTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1493

Parameters

template: TemplateRef<IgxGridRowTemplateContext>

Returns void

rowDraggable

Gets/Sets whether rows can be moved.

get rowDraggable(): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2031

Example

<igx-grid #grid [rowDraggable]="true"></igx-grid>

Returns boolean

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

set rowDraggable(val: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2035

Parameters

val: boolean

Returns void

rowEditable

Gets/Sets whether the rows are editable.

get rowEditable(): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2072

Example

<igx-grid #grid [rowEditable]="true" [primaryKey]="'ProductID'" ></igx-grid>

Returns boolean

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

set rowEditable(val: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2076

Parameters

val: boolean

Returns void

rowEditActionsTemplate

Gets the row edit actions template.

get rowEditActionsTemplate(): TemplateRef<IgxGridRowEditActionsTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1414

Returns TemplateRef<IgxGridRowEditActionsTemplateContext>

Sets the row edit actions template.

<ng-template #template igxRowEditActions let-endRowEdit>
    <button type="button" igxButton igxRowEditTabStop (click)="endRowEdit(false)">Cancel</button>
    <button type="button" igxButton igxRowEditTabStop (click)="endRowEdit(true)">Apply</button>
</ng-template>

@ViewChild('template', {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.rowEditActionsTemplate = this.template;

set rowEditActionsTemplate(template: TemplateRef<IgxGridRowEditActionsTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1431

Parameters

template: TemplateRef<IgxGridRowEditActionsTemplateContext>

Returns void

rowEditTextTemplate

Gets the row edit text template.

get rowEditTextTemplate(): TemplateRef<IgxGridRowEditTextTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1354

Returns TemplateRef<IgxGridRowEditTextTemplateContext>

Sets the row edit text template.

<ng-template #template igxRowEditText let-rowChangesCount>
Changes: {{rowChangesCount}}
</ng-template>

@ViewChild('template', {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.rowEditTextTemplate = this.template;

set rowEditTextTemplate(template: TemplateRef<IgxGridRowEditTextTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1370

Parameters

template: TemplateRef<IgxGridRowEditTextTemplateContext>

Returns void

rowExpandedIndicatorTemplate

Gets the row expand indicator template.

get rowExpandedIndicatorTemplate(): TemplateRef<IgxGridRowTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1445

Returns TemplateRef<IgxGridRowTemplateContext>

Sets the row expand indicator template.

<ng-template igxRowExpandedIndicator>
 <igx-icon role="button">remove</igx-icon>
</ng-template>

@ViewChild('template', {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.rowExpandedIndicatorTemplate = this.template;

set rowExpandedIndicatorTemplate(template: TemplateRef<IgxGridRowTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1462

Parameters

template: TemplateRef<IgxGridRowTemplateContext>

Returns void

rowHeight

Gets/Sets the row height.

get rowHeight(): number

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2152

Example

<igx-grid #grid [data]="localData" [rowHeight]="100" [autoGenerate]="true"></igx-grid>

Returns number

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

set rowHeight(value: string | number): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2156

Parameters

value: string | number

Returns void

rowList

A list of grid row.

get rowList(): QueryList<IgxRowDirective>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2572

Example

const rowList = this.grid.rowList;

Returns QueryList<IgxRowDirective>

rowSelection

Gets/Sets row selection mode

get rowSelection(): GridSelectionMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2895

Returns GridSelectionMode

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

set rowSelection(selectionMode: GridSelectionMode): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2899

Parameters

selectionMode: GridSelectionMode

Returns void

rowSelectorTemplate

Gets the row selector template.

get rowSelectorTemplate(): TemplateRef<IgxRowSelectorTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2640

Returns TemplateRef<IgxRowSelectorTemplateContext>

Sets a custom template for the row selectors.

<ng-template #template igxRowSelector let-rowContext>
   <igx-checkbox [checked]="rowContext.selected"></igx-checkbox>
</ng-template>

@ViewChild("'template'", {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.rowSelectorTemplate = this.template;

set rowSelectorTemplate(template: TemplateRef<IgxRowSelectorTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2657

Parameters

template: TemplateRef<IgxRowSelectorTemplateContext>

Returns void

selectedRows

get selectedRows(): any[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2530

Returns any[]

Gets/Sets the current selection state.

set selectedRows(rowIDs: any[]): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2526

Example

<igx-grid [data]="localData" primaryKey="ID" rowSelection="multiple" [selectedRows]="[0, 1, 2]"><igx-grid>

Parameters

rowIDs: any[]

Returns void

selectRowOnClick

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

get selectRowOnClick(): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5812

Returns boolean

set selectRowOnClick(enabled: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5816

Parameters

enabled: boolean

Returns void

shouldGenerate

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

get shouldGenerate(): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2239

Example

this.grid.shouldGenerate = true;

Returns boolean

set shouldGenerate(value: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2243

Parameters

value: boolean

Returns void

showSummaryOnCollapse

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

get showSummaryOnCollapse(): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2425

Example

<igx-grid #grid [data]="localData" [showSummaryOnCollapse]="true" [autoGenerate]="true"></igx-grid>

Returns boolean

set showSummaryOnCollapse(value: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2429

Parameters

value: boolean

Returns void

sortAscendingHeaderIconTemplate

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

get sortAscendingHeaderIconTemplate(): TemplateRef<IgxGridHeaderTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1600

Returns TemplateRef<IgxGridHeaderTemplateContext>

Sets a custom template that should be used when rendering a header sorting indicator when columns are sorted in asc order.

<ng-template #template igxSortAscendingHeaderIcon>
   <igx-icon>expand_less</igx-icon>
</ng-template>

@ViewChild("'template'", {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.sortAscendingHeaderIconTemplate = this.template;

set sortAscendingHeaderIconTemplate(template: TemplateRef<IgxGridHeaderTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1621

Parameters

template: TemplateRef<IgxGridHeaderTemplateContext>

Returns void

sortDescendingHeaderIconTemplate

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

get sortDescendingHeaderIconTemplate(): TemplateRef<IgxGridHeaderTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1633

Returns TemplateRef<IgxGridHeaderTemplateContext>

Sets a custom template that should be used when rendering a header sorting indicator when columns are sorted in desc order.

<ng-template #template igxSortDescendingHeaderIcon>
   <igx-icon>expand_more</igx-icon>
</ng-template>

@ViewChild("'template'", {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.sortDescendingHeaderIconTemplate = this.template;

set sortDescendingHeaderIconTemplate(template: TemplateRef<IgxGridHeaderTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1650

Parameters

template: TemplateRef<IgxGridHeaderTemplateContext>

Returns void

sortHeaderIconTemplate

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

get sortHeaderIconTemplate(): TemplateRef<IgxGridHeaderTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1665

Returns TemplateRef<IgxGridHeaderTemplateContext>

Sets a custom template that should be used when rendering a header sorting indicator when columns are not sorted.

<ng-template #template igxSortHeaderIcon>
   <igx-icon>unfold_more</igx-icon>
</ng-template>

@ViewChild("'template'", {read: TemplateRef })
public template: TemplateRef<any>;
this.grid.sortHeaderIconTemplate = this.template;

set sortHeaderIconTemplate(template: TemplateRef<IgxGridHeaderTemplateContext>): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1682

Parameters

template: TemplateRef<IgxGridHeaderTemplateContext>

Returns void

sortingExpressions

Gets/Sets the sorting state.

get sortingExpressions(): ISortingExpression<any>[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2760

Example

<igx-grid #grid [data]="Data" [autoGenerate]="true" [(sortingExpressions)]="model.sortingExpressions"></igx-grid>

Returns ISortingExpression<any>[]

set sortingExpressions(value: ISortingExpression<any>[]): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2764

Parameters

value: ISortingExpression<any>[]

Returns void

sortingOptions

get sortingOptions(): ISortingOptions

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2507

Returns ISortingOptions

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

set sortingOptions(value: ISortingOptions): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2499

Example

const _sortingOptions: ISortingOptions = {
     mode: 'single'
}

html <igx-grid [sortingOptions]="sortingOptions">

Parameters

value: ISortingOptions

Returns void

sortStrategy

Gets/Sets the sorting strategy of the grid.

get sortStrategy(): IGridSortingStrategy

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2460

Example

<igx-grid #grid [data]="localData" [sortStrategy]="sortStrategy"></igx-grid>

Returns IGridSortingStrategy

set sortStrategy(value: IGridSortingStrategy): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2464

Parameters

value: IGridSortingStrategy

Returns void

summaryCalculationMode

Gets/Sets the summary calculation mode.

get summaryCalculationMode(): GridSummaryCalculationMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2400

Example

<igx-grid #grid [data]="localData" summaryCalculationMode="rootLevelOnly" [autoGenerate]="true"></igx-grid>

Returns GridSummaryCalculationMode

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

set summaryCalculationMode(value: GridSummaryCalculationMode): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2404

Parameters

value: GridSummaryCalculationMode

Returns void

summaryPosition

Gets/Sets the summary position.

get summaryPosition(): GridSummaryPosition

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2380

Example

<igx-grid #grid [data]="localData" summaryPosition="top" [autoGenerate]="true"></igx-grid>

Returns GridSummaryPosition

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

set summaryPosition(value: GridSummaryPosition): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2384

Parameters

value: GridSummaryPosition

Returns void

summaryRowHeight

get summaryRowHeight(): number

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:304

Returns number

Get/Set summary row height

set summaryRowHeight(value: number): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:296

Parameters

value: number

Returns void

totalRecords

Returns the total number of records.

get totalRecords(): number

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4736

Example

const totalRecords = this.grid.totalRecords;

Returns number

set totalRecords(total: number): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4740

Parameters

total: number

Returns void

transactions

Get transactions service for the grid.

get transactions(): TransactionService<Transaction, State>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2821

Returns TransactionService<Transaction, State>

unpinnedColumns

Gets an array of unpinned columns.

get unpinnedColumns(): IgxColumnComponent[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4654

Example

const unpinnedColumns = this.grid.unpinnedColumns.

Returns IgxColumnComponent[]

virtualizationState

Returns the state of the grid virtualization.

get virtualizationState(): IForOfState

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:3569

Example

const gridVirtState = this.grid1.virtualizationState;

Returns IForOfState

visibleColumns

Returns an array of visible columns.

get visibleColumns(): IgxColumnComponent[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4717

Example

const visibleColumns = this.grid.visibleColumns.

Returns IgxColumnComponent[]

width

Gets/Sets the width of the grid.

get width(): string | null

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2125

Example

let gridWidth = this.grid.width;

Returns string | null

set width(value: string | null): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2129

Parameters

value: string | null

Returns void

Methods

addRow

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

addRow(data: any): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4917

Parameters

data: any

Returns void

Example

this.grid1.addRow(record);

beginAddRowById

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

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6564

Parameters

rowID: any
The rowID to spawn the add row UI for, or null to spawn it as the first record in the data view
asChild: boolean
Whether the record should be added as a child. Only applicable to igxTreeGrid.

Returns void

Example

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

beginAddRowByIndex

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

beginAddRowByIndex(index: number): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6622

Parameters

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

Returns void

Example

this.grid.beginAddRowByIndex(0);

clearCellSelection

Deselect selected cells.

clearCellSelection(): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5896

Returns void

Example

this.grid.clearCellSelection();

clearFilter

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

clearFilter(name: string): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5231

Parameters

name: string

Returns void

Example

this.grid.clearFilter();

clearSearch

Removes all the highlights in the cell.

clearSearch(): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5481

Returns void

Example

this.grid.clearSearch();

clearSort

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

clearSort(name: string): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5246

Parameters

name: string

Returns void

Example

this.grid.clearSort();

closeAdvancedFilteringDialog

Closes the advanced filtering dialog.

closeAdvancedFilteringDialog(applyChanges: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6451

Parameters

applyChanges: boolean
indicates whether the changes should be applied

Returns void

collapseAll

Collapses all rows.

collapseAll(): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4389

Returns void

Example

this.grid.collapseAll();

collapseRow

Collapses the row by its id.

collapseRow(rowID: any): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4420

Parameters

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

Returns void

Example

this.grid.collapseRow(rowID);

deleteRow

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

deleteRow(rowSelector: any): any

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4940

Parameters

rowSelector: any

Returns any

Example

this.grid1.deleteRow(0);

deselectAllColumns

Deselects all columns

deselectAllColumns(): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6059

Returns void

Example

this.grid.deselectAllColumns();

deselectAllRows

Deselects all rows

deselectAllRows(onlyFilterData: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5880

Parameters

onlyFilterData: boolean

Returns void

Example

this.grid.deselectAllRows();

deselectColumns

Deselect specified columns by field.

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6033

Parameters

columns: string[] | ColumnType[]

Returns void

Example

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

deselectRows

Deselect specified rows by ID.

deselectRows(rowIDs: any[]): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5844

Parameters

rowIDs: any[]

Returns void

Example

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

disableSummaries

Disable summaries for the specified column.

disableSummaries(columns: string | ISummaryExpression[]): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5207

Parameters

columns: string | ISummaryExpression[]

Returns void

Example

grid.disableSummaries({ fieldName: 'ProductName' });

enableSummaries

Enables summaries for the specified column and applies your customSummary.

enableSummaries(expressions: ISummaryExpression[]): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5175

Parameters

expressions: ISummaryExpression[]

Returns void

Example

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

Enable summaries for the listed columns.

endEdit

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

endEdit(commit: boolean, event: KeyboardEvent | MouseEvent | FocusEvent): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6528

Parameters

commit: boolean
event: KeyboardEvent | MouseEvent | FocusEvent

Returns boolean

Example

<button type="button" igxButton (click)="grid.endEdit(true)">Commit Row</button>

expandAll

Expands all rows.

expandAll(): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4376

Returns void

Example

this.grid.expandAll();

expandRow

Expands the row by its id.

expandRow(rowID: any): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4405

Parameters

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

Returns void

Example

this.grid.expandRow(rowID);

filter

Filters a single column.

filter(name: string, value: any, conditionOrExpressionTree: IFilteringOperation | IFilteringExpressionsTree, ignoreCase: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5133

Parameters

name: string
value: any
conditionOrExpressionTree: IFilteringOperation | IFilteringExpressionsTree
ignoreCase: boolean

Returns void

Example

public filter(term) {
     this.grid.filter("ProductName", term, IgxStringFilteringOperand.instance().condition("contains"));
}

filterGlobal

Filters all the column in the grid with the same condition.

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5150

Parameters

value: any
condition: IFilteringOperation
ignoreCase: boolean

Returns void

Example

grid.filterGlobal('some', IgxStringFilteringOperand.instance().condition('contains'));

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5414

Parameters

text: string
the string to search.
caseSensitive: boolean
optionally, if the search should be case sensitive (defaults to false).
exactMatch: boolean
optionally, if the text should match the entire value (defaults to false).

Returns number

Example

this.grid.findNext("financial");

findPrev

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5431

Parameters

text: string
the string to search.
caseSensitive: boolean
optionally, if the search should be case sensitive (defaults to false).
exactMatch: boolean
optionally, if the text should match the entire value (defaults to false).

Returns number

Example

this.grid.findPrev("financial");

getColumnByName

Returns the column by field name.

getColumnByName(name: string): IgxColumnComponent

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4680

Parameters

name: string

Returns IgxColumnComponent

Example

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

getColumnByVisibleIndex

getColumnByVisibleIndex(index: number): IgxColumnComponent

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4684

Parameters

index: number

Returns IgxColumnComponent

getHeaderGroupWidth

Gets the width to be set on grid header group.

getHeaderGroupWidth(column: IgxColumnComponent): string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4665

Parameters

column: IgxColumnComponent

Returns string

getNextCell

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

getNextCell(currRowIndex: number, curVisibleColIndex: number, callback: object): ICellPosition

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6266

Parameters

currRowIndex: number
curVisibleColIndex: number
callback: object

Returns ICellPosition

Example

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

getPinnedEndWidth

Gets calculated width of the pinned areas.

getPinnedEndWidth(takeHidden: boolean): number

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5740

Parameters

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

Returns number

Example

const pinnedWidth = this.grid.getPinnedEndWidth();

getPinnedStartWidth

Gets calculated width of the pinned areas.

getPinnedStartWidth(takeHidden: boolean): number

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5717

Parameters

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

Returns number

Example

const pinnedWidth = this.grid.getPinnedStartWidth();

getPreviousCell

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

getPreviousCell(currRowIndex: number, curVisibleColIndex: number, callback: object): ICellPosition

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6302

Parameters

currRowIndex: number
curVisibleColIndex: number
callback: object

Returns ICellPosition

Example

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

getRowData

Returns the data that is contained in the row component.

getRowData(rowSelector: any): any

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5066

Parameters

rowSelector: any
correspond to rowID

Returns any

Example

const data = grid.getRowData(94741);

getSelectedColumnsData

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

getSelectedColumnsData(formatters: boolean, headers: boolean): any[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6084

Parameters

formatters: boolean
headers: boolean

Returns any[]

getSelectedData

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

getSelectedData(formatters: boolean, headers: boolean): any[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5976

Parameters

formatters: boolean
headers: boolean

Returns any[]

getSelectedRanges

Get the currently selected ranges in the grid.

getSelectedRanges(): GridSelectionRange[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5964

Returns GridSelectionRange[]

isRecordPinnedByIndex

Returns whether the record is pinned or not.

isRecordPinnedByIndex(rowIndex: number): boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:3607

Parameters

rowIndex: number
Index of the record in the filteredSortedData collection.

Returns boolean

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:

// DON'Ts:
// don't call markForCheck from inside a loop
// don't call markForCheck when a primitive has changed
grid.data.forEach(rec => {
 rec = newValue;
 grid.markForCheck();
});

// DOs
// call markForCheck after updating a nested property
grid.data.forEach(rec => {
 rec.nestedProp1.nestedProp2 = newValue;
});
grid.markForCheck();

markForCheck(): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4902

Returns void

Example

grid.markForCheck();

moveColumn

Places a column before or after the specified target column.

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4825

Parameters

Returns void

Example

grid.moveColumn(column, target);

navigateTo

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

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6218

Parameters

rowIndex: number
visibleColIndex: number
cb: object

Returns void

Example

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

openAdvancedFilteringDialog

Opens the advanced filtering dialog.

openAdvancedFilteringDialog(overlaySettings: OverlaySettings): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6431

Parameters

overlaySettings: OverlaySettings

Returns void

pinColumn

Pins a column by field name.

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5283

Parameters

columnName: string | IgxColumnComponent
index: number
pinningPosition: ColumnPinningPosition

Returns boolean

Example

this.grid.pinColumn("ID");

pinRow

Pin the row by its id.

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5316

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

Returns boolean

Example

this.grid.pinRow(rowID);

recalculateAutoSizes

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

recalculateAutoSizes(): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4699

Returns void

Example

this.grid1.recalculateAutoSizes();

reflow

Recalculates grid width/height dimensions.

reflow(): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5397

Returns void

Example

this.grid.reflow();

refreshSearch

Reapplies the existing search.

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5446

Parameters

updateActiveInfo: boolean
endEdit: boolean

Returns number

Example

this.grid.refreshSearch();

selectAllColumns

Selects all columns

selectAllColumns(): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6072

Returns void

Example

this.grid.deselectAllColumns();

selectAllRows

Selects all rows

selectAllRows(onlyFilterData: boolean): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5862

Parameters

onlyFilterData: boolean

Returns void

Example

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

selectColumns

Select specified columns.

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:6005

Parameters

columns: string[] | ColumnType[]
clearCurrentSelection: boolean
if true clears the current selection

Returns void

Example

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

selectedColumns

Get current selected columns.

selectedColumns(): ColumnType[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5990

Returns ColumnType[]

Example

Returns an array with selected columns

const selectedColumns = this.grid.selectedColumns();

selectRange

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

selectRange(arg: GridSelectionRange | GridSelectionRange[] | null | undefined): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5924

Parameters

arg: GridSelectionRange | GridSelectionRange[] | null | undefined

Returns void

selectRows

Select specified rows by ID.

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5830

Parameters

rowIDs: any[]
clearCurrentSelection: boolean
if true clears the current selection

Returns void

Example

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

sort

Sort a single column.

sort(expression: ISortingExpression<any> | ISortingExpression<any>[]): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5085

Parameters

expression: ISortingExpression<any> | ISortingExpression<any>[]

Returns void

Example

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

toggleColumnVisibility

Toggles the specified column's visibility.

toggleColumnVisibility(args: IColumnVisibilityChangedEventArgs): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4331

Parameters

args: IColumnVisibilityChangedEventArgs

Returns void

Example

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

toggleRow

Toggles the row by its id.

toggleRow(rowID: any): void

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4436

Parameters

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

Returns void

Example

this.grid.toggleRow(rowID);

unpinColumn

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

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5298

Parameters

columnName: string | IgxColumnComponent
index: number

Returns boolean

Example

this.grid.pinColumn("ID");

unpinRow

Unpin the row by its id.

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5351

Parameters

rowID: any
The row id - primaryKey value or the data record instance.
row: RowType

Returns boolean

Example

this.grid.unpinRow(rowID);

updateCell

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

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4992

Parameters

value: any
the new value which is to be set.
rowSelector: any
corresponds to rowID.
column: string
corresponds to column field.

Returns void

Example

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

updateRow

Updates the grid row

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

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:5037

Parameters

value: any
rowSelector: any
correspond to rowID

Returns void

Example

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