IgxPivotGridComponent

Pivot Grid provides a way to present and manipulate data in a pivot table view.

Igx Module: IgxPivotGridModule
Igx Theme: igx-grid-theme
Igx Keywords: pivot, grid, table
Igx Group: Grids & Lists

Remarks

[object Object]

Example

<igx-pivot-grid [data]="data" [pivotConfiguration]="configuration">
</igx-pivot-grid>

Constructors

new IgxPivotGridComponent(): IgxPivotGridComponent

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

Returns IgxPivotGridComponent

Properties

activeNodeChange

Inherited from: IgxGridBaseDirective

Emitted when the active node is changed.

activeNodeChange: EventEmitter<IActiveNodeChangeEventArgs>

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

Example

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

advancedFilteringExpressionsTreeChange

Inherited from: IgxGridBaseDirective

Emitted after advanced filtering is performed.

advancedFilteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree>

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

Remarks

Returns the advanced filtering expressions tree.

Example

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

autoGenerateConfig

Gets/Sets whether to auto-generate the pivot configuration based on the provided data.

autoGenerateConfig: boolean = false

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:324

Remarks

The default value is false. When set to true, it will override all dimensions and values in the pivotConfiguration.

Example

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

cdr

Inherited from: IgxGridBaseDirective

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

cellClick

Inherited from: IgxGridBaseDirective

Emitted when a cell is clicked.

cellClick: EventEmitter<IGridCellEventArgs>

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

Remarks

Returns the IgxGridCell.

Example

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

childrenResolved

Inherited from: IgxGridBaseDirective

Emitted when content children are resolved and collections in grid are updated.

childrenResolved: EventEmitter<void>

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

clipboardOptions

Inherited from: IgxGridBaseDirective

Controls the copy behavior of the grid.

clipboardOptions: IClipboardOptions

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

columnInit

Inherited from: IgxGridBaseDirective

Emitted when a column is initialized.

columnInit: EventEmitter<IgxColumnComponent>

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

Remarks

Returns the column object.

Example

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

columnResized

Inherited from: IgxGridBaseDirective

Emitted after column is resized.

columnResized: EventEmitter<IColumnResizeEventArgs>

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

Remarks

Returns the IgxColumnComponent object's old and new width.

Example

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

columnSelectionChanging

Inherited from: IgxGridBaseDirective

Emitted when IgxColumnComponent is selected.

columnSelectionChanging: EventEmitter<IColumnSelectionEventArgs>

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

Example

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

columnVisibilityChanged

Inherited from: IgxGridBaseDirective

Emitted after column visibility is changed.

columnVisibilityChanged: EventEmitter<IColumnVisibilityChangedEventArgs>

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

Remarks

Args: { column: IgxColumnComponent, newValue: boolean }

Example

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

columnVisibilityChanging

Inherited from: IgxGridBaseDirective

Emitted before column visibility is changed.

columnVisibilityChanging: EventEmitter<IColumnVisibilityChangingEventArgs>

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

Remarks

Args: { column: any, newValue: boolean }

Example

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

contextMenu

Inherited from: IgxGridBaseDirective

Emitted when a cell or row is right clicked.

contextMenu: EventEmitter<IGridContextMenuEventArgs>

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

Remarks

Returns the IgxGridCell object if the immediate context menu target is a cell or an IgxGridRow otherwise.

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

dataChanged

Inherited from: IgxGridBaseDirective

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

Example

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

dataChanging

Inherited from: IgxGridBaseDirective

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

Example

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

dimensionInit

Emitted when the dimension is initialized.

dimensionInit: EventEmitter<IPivotDimension>

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:200

Remarks

Emits the dimension that is about to be initialized.

Example

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

dimensionsChange

Emitted when the dimension collection is changed via the grid chip area.

dimensionsChange: EventEmitter<IDimensionsChange>

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:174

Remarks

Returns the new dimension collection and its type:

Example

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

dimensionsSortingExpressionsChange

Emitted when a dimension is sorted.

dimensionsSortingExpressionsChange: EventEmitter<ISortingExpression<any>[]>

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:226

Example

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

doubleClick

Inherited from: IgxGridBaseDirective

Emitted when a cell is double clicked.

doubleClick: EventEmitter<IGridCellEventArgs>

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

Remarks

Returns the IgxGridCell object.

Example

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

emptyPivotGridTemplate

Gets/Sets a custom template when pivot grid is empty.

emptyPivotGridTemplate: TemplateRef<void>

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:2443

Example

<igx-pivot-grid [emptyPivotGridTemplate]="myTemplate"><igx-pivot-grid>

expansionStatesChange

Inherited from: IgxGridBaseDirective

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

Example

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

filtering

Inherited from: IgxGridBaseDirective

Emitted before filtering expressions are applied.

filtering: EventEmitter<IFilteringEventArgs>

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

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

Inherited from: IgxGridBaseDirective

Emitted after filtering is performed through the UI.

filteringDone: EventEmitter<IFilteringExpressionsTree>

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

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

Inherited from: IgxGridBaseDirective

Emitted after filtering is performed.

filteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree>

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

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

Inherited from: IgxGridBaseDirective

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

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: GridBaseAPIService<IgxGridBaseDirective & GridType>

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:157

gridCopy

Inherited from: IgxGridBaseDirective

Emitted when a copy operation is executed.

gridCopy: EventEmitter<IGridClipboardEvent>

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

Remarks

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

gridKeydown

Inherited from: IgxGridBaseDirective

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

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

Inherited from: IgxGridBaseDirective

Emitted when grid is scrolled horizontally/vertically.

gridScroll: EventEmitter<IGridScrollEventArgs>

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

Example

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

navigation: IgxPivotGridNavigationService

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:159

pivotConfigurationChange

Emitted when any of the pivotConfiguration properties is changed via the grid chip area.

pivotConfigurationChange: EventEmitter<IPivotConfigurationChangedEventArgs>

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:186

Example

<igx-pivot-grid #grid [data]="localData" [height]="'305px'"
             (pivotConfigurationChanged)="configurationChanged($event)"></igx-grid>

rangeSelected

Inherited from: IgxGridBaseDirective

Emitted when making a range selection.

rangeSelected: EventEmitter<GridSelectionRange>

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

Remarks

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

rendered

Inherited from: IgxGridBaseDirective

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

rowClasses

Inherited from: IgxGridBaseDirective

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

rowClick

Inherited from: IgxGridBaseDirective

Emitted when a row is clicked.

rowClick: EventEmitter<IGridRowEventArgs>

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

Remarks

Returns the IgxGridRow.

Example

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

rowDimensionHeaderTemplate

rowDimensionHeaderTemplate: TemplateRef<IgxColumnTemplateContext>

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:285

rowSelectionChanging

Inherited from: IgxGridBaseDirective

Emitted when IgxGridRowComponent is selected.

rowSelectionChanging: EventEmitter<IRowSelectionEventArgs>

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

Example

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

rowStyles

Inherited from: IgxGridBaseDirective

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: any = null

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

rowToggle

Inherited from: IgxGridBaseDirective

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

Example

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

selected

Inherited from: IgxGridBaseDirective

Emitted when a cell is selected.

selected: EventEmitter<IGridCellEventArgs>

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

Remarks

Returns the IgxGridCell.

Example

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

selectedRowsChange

Inherited from: IgxGridBaseDirective

Emitted when the rows are selected or deselected.

selectedRowsChange: EventEmitter<any[]>

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

Example

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

sorting

Inherited from: IgxGridBaseDirective

Emitted before sorting expressions are applied.

sorting: EventEmitter<ISortingEventArgs>

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

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

Inherited from: IgxGridBaseDirective

Emitted after sorting is completed.

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

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

Remarks

Returns the sorting expression.

Example

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

sortingExpressionsChange

Inherited from: IgxGridBaseDirective

Emitted before sorting is performed.

sortingExpressionsChange: EventEmitter<ISortingExpression<any>[]>

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

Remarks

Returns the sorting expressions.

Example

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

uniqueColumnValuesStrategy

Inherited from: IgxGridBaseDirective

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

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

Inherited from: IgxGridBaseDirective

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

validationStatusChange

Inherited from: IgxGridBaseDirective

Emitted when grid's validation status changes.

validationStatusChange: EventEmitter<IGridValidationStatusEventArgs>

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

Example

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

validationTrigger

Inherited from: IgxGridBaseDirective

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

Example

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

valueChipTemplate

Gets/Sets a custom template for the value chips.

valueChipTemplate: TemplateRef<IgxPivotGridValueTemplateContext>

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:282

Example

<igx-pivot-grid [valueChipTemplate]="myTemplate"><igx-pivot-grid>

valueInit

Emitted when the value is initialized.

valueInit: EventEmitter<IPivotValue>

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:213

Remarks

Emits the value that is about to be initialized.

Example

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

valuesChange

Emitted when the values collection is changed via the grid chip area.

valuesChange: EventEmitter<IValuesChange>

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:240

Remarks

Returns the new dimension

Example

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

advancedFilteringExpressionsTree

Inherited from: IgxGridBaseDirective

advancedFilteringExpressionsTree: IFilteringExpressionsTree

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1914, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1918

cellMergeMode

Inherited from: IgxGridBaseDirective

cellMergeMode: GridCellMergeMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2881, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2885

cellSelection

Inherited from: IgxGridBaseDirective

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

cellSelection: GridSelectionMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2862, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2866

columnSelection

Inherited from: IgxGridBaseDirective

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

columnSelection: GridSelectionMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2923, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2927

columnWidth

Inherited from: IgxGridBaseDirective

columnWidth: string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2181, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2184

data

data: any[]

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1129, projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1153

dataCloneStrategy

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:314, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:318

defaultExpandState

defaultExpandState: boolean

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:669, projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:673

dragGhostCustomTemplate

Inherited from: IgxGridBaseDirective

dragGhostCustomTemplate: TemplateRef<IgxGridRowDragGhostContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1230, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1247

emptyFilteredGridMessage

Inherited from: IgxGridBaseDirective

emptyFilteredGridMessage: string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2263, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2267

emptyGridMessage

Inherited from: IgxGridBaseDirective

emptyGridMessage: string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2199, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2202

emptyGridTemplate

Inherited from: IgxGridBaseDirective

emptyGridTemplate: TemplateRef<IgxGridTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:241, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:244

excelStyleHeaderIconTemplate

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:1580, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1597

expansionStates

Inherited from: IgxGridBaseDirective

expansionStates: Map<any, boolean>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4355, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4360

filteringExpressionsTree

Inherited from: IgxGridBaseDirective

filteringExpressionsTree: IFilteringExpressionsTree

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1868, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1872

filteringLogic

Inherited from: IgxGridBaseDirective

filteringLogic: FilteringLogic

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1847, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1851

filterStrategy

Inherited from: IgxGridBaseDirective

filterStrategy: IFilteringStrategy

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2450, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2454

headerCollapsedIndicatorTemplate

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:1551, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1568

headerExpandedIndicatorTemplate

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:1520, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1537

headSelectorTemplate

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:2614, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2631

height

Inherited from: IgxGridBaseDirective

height: string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2103, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2107

isLoading

Inherited from: IgxGridBaseDirective

isLoading: boolean

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2216, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2229

loadingGridTemplate

Inherited from: IgxGridBaseDirective

loadingGridTemplate: TemplateRef<IgxGridTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:274, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:277

locale

Inherited from: IgxGridBaseDirective

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

locale: string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1964, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1968

mergeStrategy

Inherited from: IgxGridBaseDirective

mergeStrategy: IGridMergeStrategy

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2485, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2488

outlet

Inherited from: IgxGridBaseDirective

outlet: IgxOverlayOutletDirective

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4473, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:4477

pivotConfiguration

The configuration settings for the pivot grid. it includes dimension strategy for rows and columns, filters and data keys

pivotConfiguration: IPivotConfiguration

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:298, projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:309

pivotUI

Specifies whether to show the pivot configuration UI in the grid.

pivotUI: IPivotUISettings

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:336, projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:342

primaryKey

Inherited from: IgxGridBaseDirective

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

primaryKey: string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:437, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:441

resourceStrings

Inherited from: IgxGridBaseDirective

resourceStrings: IGridResourceStrings

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1826, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1831

rowAddTextTemplate

Inherited from: IgxGridBaseDirective

rowAddTextTemplate: TemplateRef<IgxGridEmptyTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1397, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1413

rowCollapsedIndicatorTemplate

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:1489, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1506

rowEditActionsTemplate

Inherited from: IgxGridBaseDirective

rowEditActionsTemplate: TemplateRef<IgxGridRowEditActionsTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1427, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1444

rowEditTextTemplate

Inherited from: IgxGridBaseDirective

rowEditTextTemplate: TemplateRef<IgxGridRowEditTextTemplateContext>

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1367, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1383

rowExpandedIndicatorTemplate

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:1458, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1475

rowHeight

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:2160, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2164

rowSelection

Inherited from: IgxGridBaseDirective

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

rowSelection: GridSelectionMode

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2902, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2906

rowSelectorTemplate

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:2647, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2664

selectRowOnClick

Inherited from: IgxGridBaseDirective

selectRowOnClick: boolean

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

sortAscendingHeaderIconTemplate

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:1613, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1630

sortDescendingHeaderIconTemplate

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:1642, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1659

sortHeaderIconTemplate

Inherited from: IgxGridBaseDirective

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/grid/src/grid-base.directive.ts:1674, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:1691

sortingExpressions

Inherited from: IgxGridBaseDirective

sortingExpressions: ISortingExpression<any>[]

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2767, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2771

sortingOptions

Inherited from: IgxGridBaseDirective

sortingOptions: ISortingOptions

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2506, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2514

sortStrategy

Inherited from: IgxGridBaseDirective

sortStrategy: IGridSortingStrategy

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2467, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2471

superCompactMode

superCompactMode: boolean

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:363, projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:367

width

Inherited from: IgxGridBaseDirective

width: string

Defined in projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2133, projects/igniteui-angular/grids/grid/src/grid-base.directive.ts:2137

Accessors

allDimensions

Gets the full list of dimensions.

get allDimensions(): IPivotDimension[]

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1049

Example

const dimensions = this.grid.allDimensions;

Returns IPivotDimension[]

columns

Inherited from: IgxGridBaseDirective

Gets an array of IgxColumnComponents.

get columns(): IgxColumnComponent[]

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

Example

const colums = this.grid.columns.

Returns IgxColumnComponent[]

dataRowList

Inherited from: IgxGridBaseDirective

A list of currently rendered IgxGridRowComponent's.

get dataRowList(): QueryList<IgxRowDirective>

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

Example

const dataList = this.grid.dataRowList;

Returns QueryList<IgxRowDirective>

dataView

Inherited from: IgxGridBaseDirective

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

Example

const dataView = this.grid.dataView;

Returns any[]

defaultRowHeight

Inherited from: IgxGridBaseDirective

Gets the default row height.

get defaultRowHeight(): number

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

Example

const rowHeigh = this.grid.defaultRowHeight;

Returns number

dimensionsSortingExpressions

Gets the sorting expressions generated for the dimensions.

get dimensionsSortingExpressions(): ISortingExpression<any>[]

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:251

Example

const expressions = this.grid.dimensionsSortingExpressions;

Returns ISortingExpression<any>[]

filteredData

Inherited from: IgxGridBaseDirective

Returns an array of objects containing the filtered data.

get filteredData(): any

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

Example

let filteredData = this.grid.filteredData;

Returns any

filteredSortedData

Inherited from: IgxGridBaseDirective

Returns an array containing the filtered sorted data.

get filteredSortedData(): any[]

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

Example

const filteredSortedData = this.grid1.filteredSortedData;

Returns any[]

id

Gets/Sets the value of the id attribute.

get id(): string

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1112

Example

<igx-pivot-grid [id]="'igx-pivot-1'" [data]="Data"></igx-pivot-grid>

Returns string

lastSearchInfo

Inherited from: IgxGridBaseDirective

Represents the last search information.

get lastSearchInfo(): ISearchInfo

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

Returns ISearchInfo

nativeElement

Inherited from: IgxGridBaseDirective

Gets the native element.

get nativeElement(): HTMLElement

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

Example

const nativeEl = this.grid.nativeElement.

Returns HTMLElement

pinnedEndColumns

Inherited from: IgxGridBaseDirective

Gets an array of the pinned to the right IgxColumnComponents.

get pinnedEndColumns(): IgxColumnComponent[]

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

Example

const pinnedColumns = this.grid.pinnedEndColumns.

Returns IgxColumnComponent[]

pinnedStartColumns

Inherited from: IgxGridBaseDirective

Gets an array of the pinned to the left IgxColumnComponents.

get pinnedStartColumns(): IgxColumnComponent[]

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

Example

const pinnedColumns = this.grid.pinnedStartColumns.

Returns IgxColumnComponent[]

rowList

Inherited from: IgxGridBaseDirective

A list of IgxGridRowComponent.

get rowList(): QueryList<IgxRowDirective>

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

Example

const rowList = this.grid.rowList;

Returns QueryList<IgxRowDirective>

selectedRows

Gets/Sets the current selection state.

get selectedRows(): any[]

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:946

Example

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

Returns any[]

summaryRowHeight

Get/Set IgxSummaryRow height

get summaryRowHeight(): number

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:842

Returns number

virtualizationState

Inherited from: IgxGridBaseDirective

Returns the state of the grid virtualization.

get virtualizationState(): IForOfState

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

Example

const gridVirtState = this.grid1.virtualizationState;

Returns IForOfState

visibleColumns

Inherited from: IgxGridBaseDirective

Returns an array of visible IgxColumnComponents.

get visibleColumns(): IgxColumnComponent[]

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

Example

const visibleColumns = this.grid.visibleColumns.

Returns IgxColumnComponent[]

Methods

autoSizeRowDimension

Auto-sizes row dimension cells.

autoSizeRowDimension(dimension: IPivotDimension): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1595

Parameters

dimension: IPivotDimension
The row dimension to size.

Returns void

Example

this.grid.autoSizeRowDimension(dimension);

clearCellSelection

Inherited from: IgxGridBaseDirective

Deselect selected cells.

clearCellSelection(): void

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

Returns void

Example

this.grid.clearCellSelection();

clearFilter

Inherited from: IgxGridBaseDirective

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

clearFilter(name: string): void

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

Parameters

name: string

Returns void

Example

this.grid.clearFilter();

clearSort

Inherited from: IgxGridBaseDirective

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

clearSort(name: string): void

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

Parameters

name: string

Returns void

Example

this.grid.clearSort();

deselectAllColumns

Inherited from: IgxGridBaseDirective

Deselects all columns

deselectAllColumns(): void

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

Returns void

Example

this.grid.deselectAllColumns();

deselectAllRows

Inherited from: IgxGridBaseDirective

Deselects all rows

deselectAllRows(onlyFilterData: boolean): void

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

Parameters

onlyFilterData: boolean

Returns void

Example

this.grid.deselectAllRows();

deselectColumns

Inherited from: IgxGridBaseDirective

Deselect specified columns by field.

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

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

Parameters

columns: string[] | ColumnType[]

Returns void

Example

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

deselectRows

Inherited from: IgxGridBaseDirective

Deselect specified rows by ID.

deselectRows(rowIDs: any[]): void

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

Parameters

rowIDs: any[]

Returns void

Example

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

filter

Inherited from: IgxGridBaseDirective

Filters a single IgxColumnComponent.

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

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

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"));
}

filterDimension

Filters a single IPivotDimension.

filterDimension(dimension: IPivotDimension, value: any, conditionOrExpressionTree: IFilteringOperation | IFilteringExpressionsTree): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1858

Parameters

dimension: IPivotDimension
value: any
conditionOrExpressionTree: IFilteringOperation | IFilteringExpressionsTree

Returns void

Example

public filter() {
     const set = new Set();
     set.add('Value 1');
     set.add('Value 2');
     this.grid1.filterDimension(this.pivotConfigHierarchy.rows[0], set, IgxStringFilteringOperand.instance().condition('in'));
}

filterGlobal

Inherited from: IgxGridBaseDirective

Filters all the IgxColumnComponent in the IgxGridComponent with the same condition.

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

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

Parameters

value: any
condition: any
ignoreCase: any

Returns void

Example

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

getColumnByName

Inherited from: IgxGridBaseDirective

Returns the IgxColumnComponent by field name.

getColumnByName(name: string): IgxColumnComponent

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

Parameters

name: string

Returns IgxColumnComponent

Example

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

getColumnByVisibleIndex

Inherited from: IgxGridBaseDirective

getColumnByVisibleIndex(index: number): IgxColumnComponent

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

Parameters

index: number

Returns IgxColumnComponent

getColumnGroupExpandState

getColumnGroupExpandState(col: IgxColumnComponent): boolean

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1531

Parameters

col: IgxColumnComponent

Returns boolean

getHeaderGroupWidth

Inherited from: IgxGridBaseDirective

Gets the width to be set on IgxGridHeaderGroupComponent.

getHeaderGroupWidth(column: IgxColumnComponent): string

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

Parameters

column: IgxColumnComponent

Returns string

getPinnedEndWidth

Inherited from: IgxGridBaseDirective

Gets calculated width of the pinned areas.

getPinnedEndWidth(takeHidden: boolean): number

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

Parameters

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

Returns number

Example

const pinnedWidth = this.grid.getPinnedEndWidth();

getRowData

Inherited from: IgxGridBaseDirective

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

Parameters

rowSelector: any
correspond to rowID

Returns any

Example

const data = grid.getRowData(94741);

getSelectedColumnsData

Inherited from: IgxGridBaseDirective

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

Parameters

formatters: boolean
headers: boolean

Returns any[]

getSelectedData

Inherited from: IgxGridBaseDirective

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

Parameters

formatters: boolean
headers: boolean

Returns any[]

getSelectedRanges

Inherited from: IgxGridBaseDirective

Get the currently selected ranges in the grid.

getSelectedRanges(): GridSelectionRange[]

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

Returns GridSelectionRange[]

insertDimensionAt

Inserts dimension in target collection by type at specified index or at the collection's end.

insertDimensionAt(dimension: IPivotDimension, targetCollectionType: PivotDimensionType, index: number): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1628

Parameters

dimension: IPivotDimension
The dimension that will be added.
targetCollectionType: PivotDimensionType
The target collection type to add to. Can be Row, Column or Filter.
index: number
The index in the collection at which to add. This parameter is optional. If not set it will add it to the end of the collection.

Returns void

Example

this.grid.insertDimensionAt(dimension, PivotDimensionType.Row, 1);

insertValueAt

Inserts value at specified index or at the end.

insertValueAt(value: IPivotValue, index: number): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1737

Parameters

value: IPivotValue
The value definition that will be added.
index: number
The index in the collection at which to add. This parameter is optional. If not set it will add it to the end of the collection.

Returns void

Example

this.grid.insertValueAt(value, 1);

markForCheck

Inherited from: IgxGridBaseDirective

Triggers change detection for the IgxGridComponent. 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:4903

Returns void

Example

grid.markForCheck();

moveDimension

Move dimension from its currently collection to the specified target collection by type at specified index or at the collection's end.

moveDimension(dimension: IPivotDimension, targetCollectionType: PivotDimensionType, index: number): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1659

Parameters

dimension: IPivotDimension
The dimension that will be moved.
targetCollectionType: PivotDimensionType
The target collection type to move it to. Can be Row, Column or Filter.
index: number
The index in the collection at which to add. This parameter is optional. If not set it will add it to the end of the collection.

Returns void

Example

this.grid.moveDimension(dimension, PivotDimensionType.Row, 1);

moveValue

Move value from its currently at specified index or at the end.

moveValue(value: IPivotValue, index: number): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1765

Parameters

value: IPivotValue
The value that will be moved.
index: number
The index in the collection at which to add. This parameter is optional. If not set it will add it to the end of the collection.

Returns void

Example

this.grid.moveValue(value, 1);

navigateTo

Inherited from: IgxGridBaseDirective

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

Parameters

rowIndex: number
visibleColIndex: number
cb: object

Returns void

Example

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

notifyDimensionChange

Notifies for dimension change.

notifyDimensionChange(regenerateColumns: boolean): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1033

Parameters

regenerateColumns: boolean

Returns void

recalculateAutoSizes

Inherited from: IgxGridBaseDirective

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

Returns void

Example

this.grid1.recalculateAutoSizes();

reflow

Inherited from: IgxGridBaseDirective

Recalculates grid width/height dimensions.

reflow(): void

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

Returns void

Example

this.grid.reflow();

removeDimension

Removes dimension from its currently collection.

removeDimension(dimension: IPivotDimension): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1683

Parameters

dimension: IPivotDimension
The dimension to be removed.

Returns void

Example

this.grid.removeDimension(dimension);

removeValue

Removes value from collection.

removeValue(value: IPivotValue): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1784

Parameters

value: IPivotValue
The value to be removed.

Returns void

Example

this.grid.removeValue(dimension);

selectAllColumns

Inherited from: IgxGridBaseDirective

Selects all columns

selectAllColumns(): void

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

Returns void

Example

this.grid.deselectAllColumns();

selectAllRows

Inherited from: IgxGridBaseDirective

Selects all rows

selectAllRows(onlyFilterData: boolean): void

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

Parameters

onlyFilterData: boolean

Returns void

Example

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

selectColumns

Inherited from: IgxGridBaseDirective

Select specified columns.

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

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

Parameters

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

Returns void

Example

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

selectedColumns

Inherited from: IgxGridBaseDirective

Get current selected columns.

selectedColumns(): ColumnType[]

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

Returns ColumnType[]

Example

Returns an array with selected columns

const selectedColumns = this.grid.selectedColumns();

selectRange

Inherited from: IgxGridBaseDirective

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

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

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

Parameters

arg: GridSelectionRange | GridSelectionRange[]

Returns void

selectRows

Inherited from: IgxGridBaseDirective

Select specified rows by ID.

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

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

Parameters

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

Returns void

Example

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

sort

Inherited from: IgxGridBaseDirective

Sort a single IgxColumnComponent.

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

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

Parameters

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

Returns void

Example

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

sortDimension

Sort the dimension and its children in the provided direction.

sortDimension(dimension: IPivotDimension, sortDirection: SortingDirection): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1824

Parameters

dimension: IPivotDimension
sortDirection: SortingDirection

Returns void

Example

this.grid.sortDimension(dimension, SortingDirection.Asc);

toggleColumn

toggleColumn(col: IgxColumnComponent): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1275

Parameters

col: IgxColumnComponent

Returns void

toggleDimension

Toggles the dimension's enabled state on or off.

toggleDimension(dimension: IPivotDimension): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1706

Parameters

dimension: IPivotDimension
The dimension to be toggled.

Returns void

Example

this.grid.toggleDimension(dimension);

toggleRow

Inherited from: IgxGridBaseDirective

Toggles the row by its id.

toggleRow(rowID: any): void

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

Parameters

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

Returns void

Example

this.grid.toggleRow(rowID);

toggleRowGroup

toggleRowGroup(col: IgxColumnComponent, newState: boolean): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1537

Parameters

col: IgxColumnComponent
newState: boolean

Returns void

toggleValue

Toggles the value's enabled state on or off.

toggleValue(value: IPivotValue): void

Defined in projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts:1806

Parameters

value: IPivotValue
The value to be toggled.

Returns void

Example

this.grid.toggleValue(value);