Ignite UI for Angular

すべて
  • パブリック
  • パブリック/保護
  • すべて

クラス IgxGridComponent

グリッドは、表データを表示および操作する方法を提供します。

@igxmodule

IgxGridModule

@igxgroup

Grids & Lists

@igxkeywords

grid, table

@igxtheme

igx-grid-theme

@備考:

Ignite UI Grid は簡単に表データを表示して操作するために使用されます。データをバインドした後、フィルタリング、並べ替え、および編集操作を使用して変更できます。

@例:
<igx-grid [data]="employeeData" [autoGenerate]="false">
  <igx-column field="first" header="First Name"></igx-column>
  <igx-column field="last" header="Last Name"></igx-column>
  <igx-column field="role" header="Role"></igx-column>
</igx-grid>

階層

実装

  • GridType
  • OnInit
  • DoCheck
  • AfterContentInit
  • AfterViewInit

Index

コンストラクタ

プロパティ

アクセサー

メソッド

コンストラクタ

constructor

  • new IgxGridComponent(selectionService: IgxGridSelectionService, colResizingService: IgxColumnResizingService, gridAPI: GridBaseAPIService<IgxGridBaseDirective & GridType>, _transactions: TransactionService<Transaction, State>, elementRef: ElementRef<any>, zone: NgZone, document: any, cdr: ChangeDetectorRef, resolver: ComponentFactoryResolver, differs: IterableDiffers, viewRef: ViewContainerRef, navigation: IgxGridNavigationService, filteringService: IgxFilteringService, overlayService: IgxOverlayService, summaryService: IgxGridSummaryService, _displayDensityOptions: IDisplayDensityOptions, localeId: string, platform: PlatformUtil): IgxGridComponent

プロパティ

_destroyed

_destroyed: boolean = false

actionStrip

actionStrip: IgxActionStripComponent

activeNodeChange

activeNodeChange: EventEmitter<IActiveNodeChangeEventArgs> = ...

Emmited when the active node is changed.

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

addRowEmptyTemplate

addRowEmptyTemplate: TemplateRef<any>

グリッドが空のときに行 UI を追加するためのカスタム テンプレートを取得または設定します。

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

advancedFilteringExpressionsTreeChange

advancedFilteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree> = ...

Emitted after advanced filtering is performed.

@remarks

Returns the advanced filtering expressions tree.

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

autoGenerate

autoGenerate: boolean = false

列を自動生成するかどうかを取得または設定します。

@備考:

デフォルト値は False です。true に設定た場合、コードまたはマークアップで宣言されたすべての列がオーバーライドされます。

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

cdr

cdr: ChangeDetectorRef

cellClick

cellClick: EventEmitter<IGridCellEventArgs> = ...

Emitted when IgxGridCellComponent is clicked.

@remarks

Returns the IgxGridCellComponent.

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

cellEdit

cellEdit: EventEmitter<IGridEditEventArgs> = ...

Emitted when cell has been edited.

@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

cellEditDone: EventEmitter<IGridEditDoneEventArgs> = ...

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

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

cellEditEnter

cellEditEnter: EventEmitter<IGridEditEventArgs> = ...

Emitted when cell enters edit mode.

@remarks

This event is cancelable.

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

cellEditExit

cellEditExit: EventEmitter<IGridEditDoneEventArgs> = ...

Emitted when cell exits edit mode.

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

clipboardOptions

clipboardOptions: object = ...

Controls the copy behavior of the grid.

Type declaration

  • copyFormatters: boolean
  • copyHeaders: boolean
  • enabled: boolean
  • separator: string

colResizingService

colResizingService: IgxColumnResizingService

columnInit

columnInit: EventEmitter<IgxColumnComponent> = ...

Emitted when a column is initialized.

@remarks

Returns the column object.

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

columnMoving

columnMoving: EventEmitter<IColumnMovingEventArgs> = ...

Emitted during the column moving operation.

@remarks

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

@example
<igx-grid [columnHiding]="true" [showToolbar]="true" (columnMoving)="moving($event)"></igx-grid>

columnMovingEnd

columnMovingEnd: EventEmitter<IColumnMovingEndEventArgs> = ...

Emitted when column moving ends.

@remarks

Returns the source and target IgxColumnComponent objects.

@example
<igx-grid [columnHiding]="true" [showToolbar]="true" (columnMovingEnd)="movingEnds($event)"></igx-grid>

columnMovingStart

columnMovingStart: EventEmitter<IColumnMovingStartEventArgs> = ...

Emitted when column moving starts.

@remarks

Returns the moved IgxColumnComponent object.

@example
<igx-grid [columnHiding]="true" [showToolbar]="true" (columnMovingStart)="movingStart($event)"></igx-grid>

columnPin

columnPin: EventEmitter<IPinColumnCancellableEventArgs> = ...

Emitted before IgxColumnComponent is pinned.

@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

columnPinned: EventEmitter<IPinColumnEventArgs> = ...

Emitted after IgxColumnComponent is pinned.

@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

columnResized: EventEmitter<IColumnResizeEventArgs> = ...

Emitted after column is resized.

@remarks

Returns the IgxColumnComponent object's old and new width.

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

columnSelected

columnSelected: EventEmitter<IColumnSelectionEventArgs> = ...

Emitted when IgxColumnComponent is selected.

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

columnVisibilityChanged

columnVisibilityChanged: EventEmitter<IColumnVisibilityChangedEventArgs> = ...

Emitted after column visibility is changed.

@remarks

Args: { column: IgxColumnComponent, newValue: boolean }

@example
<igx-grid [columnHiding]="true" [showToolbar]="true" (columnVisibilityChanged)="visibilityChanged($event)"></igx-grid>

columnVisibilityChanging

columnVisibilityChanging: EventEmitter<IColumnVisibilityChangingEventArgs> = ...

Emitted before column visibility is changed.

@remarks

Args: { column: any, newValue: boolean }

@example
<igx-grid [columnHiding]="true" [showToolbar]="true" (columnVisibilityChanging)="visibilityChanging($event)"></igx-grid>

contextMenu

contextMenu: EventEmitter<IGridCellEventArgs> = ...

Emitted when a cell is right clicked.

@remarks

Returns the IgxGridCellComponent object.

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

dataPreLoad

dataPreLoad: EventEmitter<IForOfState> = ...

新しいデータ チャンクが仮想化から読み込まれたときに発生されます。

@例:
 <igx-grid #grid [data]="localData" [autoGenerate]="true" (dataPreLoad)='handleDataPreloadEvent()'></igx-grid>

document

document: any

doubleClick

doubleClick: EventEmitter<IGridCellEventArgs> = ...

Emitted when a cell is double clicked.

@remarks

Returns the IgxGridCellComponent object.

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

dragRowID

dragRowID: any = null

Gets the row ID that is being dragged.

@remarks

The row ID is either the primaryKey value or the data record instance.

dropAreaTemplate

dropAreaTemplate: TemplateRef<any>

GroupBy ドロップ領域として描画されるテンプレートを取得または設定します。

@備考:

作成したグループを展開または縮小として描画されるかどうかを取得または設定します。

@例:
<igx-grid [dropAreaTemplate]="dropAreaRef">
</igx-grid>
<ng-template #myDropArea>
     <span> Custom drop area! </span>
</ng-template>

emptyFilteredGridTemplate

emptyFilteredGridTemplate: TemplateRef<any>

A template reference for the template when the filtered grid is empty.

@example
const emptyTempalte = this.grid.emptyGridTemplate;

emptyGridDefaultTemplate

emptyGridDefaultTemplate: TemplateRef<any>

A template reference for the template when the grid is empty.

@example
const emptyTempalte = this.grid.emptyGridTemplate;

emptyGridTemplate

emptyGridTemplate: TemplateRef<any>

空の場合のカスタム テンプレートを取得または設定します。

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

evenRowCSS

evenRowCSS: string = 'igx-grid__tr--even'

Gets/Sets the styling classes applied to all even IgxGridRowComponents in the grid.

@example
<igx-grid #grid [data]="Data" [evenRowCSS]="'igx-grid--my-even-class'" [autoGenerate]="true"></igx-grid>

excelStyleHeaderIconTemplate

excelStyleHeaderIconTemplate: TemplateRef<any> = null

The custom template, if any, that should be used when rendering a row expand indicator.

filtering

filtering: EventEmitter<IFilteringEventArgs> = ...

Emitted before filtering expressions are applied.

@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

filteringDone: EventEmitter<IFilteringExpressionsTree> = ...

Emitted after filtering is performed through the UI.

@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

filteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree> = ...

Emitted after filtering is performed.

@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>

filteringService

filteringService: IgxFilteringService

gridAPI

gridAPI: GridBaseAPIService<IgxGridBaseDirective & GridType>

gridCopy

gridCopy: EventEmitter<IGridClipboardEvent> = ...

Emitted when a copy operation is executed.

@remarks

Fired only if copy behavior is enabled through the [clipboardOptions]{@link IgxGridBaseDirective#clipboardOptions}.

gridKeydown

gridKeydown: EventEmitter<IGridKeydownEventArgs> = ...

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

@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

gridScroll: EventEmitter<IGridScrollEventArgs> = ...

Emitted when grid is scrolled horizontally/vertically.

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

groupsExpanded

groupsExpanded: boolean = true

作成したグループを展開または縮小として描画されるかどうかを取得または設定します。

@備考:

デフォルトの描画状態は展開です。

@例:
<igx-grid #grid [data]="Data" [groupsExpanded]="false" [autoGenerate]="true"></igx-grid>

groupsRecords

groupsRecords: IGroupByRecord[] = []

グループ化レコードの階層表現を取得します。

@例:
let groupRecords = this.grid.groupsRecords;

headerCollapseIndicatorTemplate

headerCollapseIndicatorTemplate: TemplateRef<any> = null

The custom template, if any, that should be used when rendering a header collapse indicator.

headerExpandIndicatorTemplate

headerExpandIndicatorTemplate: TemplateRef<any> = null

The custom template, if any, that should be used when rendering a header expand indicator.

id

id: string = ...

id 属性の値を取得または設定します。

@備考:

提供されていない場合は、自動的に生成されます。

@例:
<igx-grid [id]="'igx-grid-1'" [data]="Data" [autoGenerate]="true"></igx-grid>

loadingGridTemplate

loadingGridTemplate: TemplateRef<any>

読み込み時のカスタム テンプレートを取得または設定します。

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

navigation

navigation: IgxGridNavigationService

oddRowCSS

oddRowCSS: string = 'igx-grid__tr--odd'

Gets/Sets the styling classes applied to all odd IgxGridRowComponents in the grid.

@example
<igx-grid #grid [data]="Data" [evenRowCSS]="'igx-grid--my-odd-class'" [autoGenerate]="true"></igx-grid>

onDensityChanged

onDensityChanged: EventEmitter<IDensityChangedEventArgs> = ...

onGroupingDone

onGroupingDone: EventEmitter<IGroupingDoneEventArgs> = ...

列がグループ化/グループ解除されたときに発生します。

@備考:

groupBy()またはclearGrouping()API メソッドを呼び出して引数として渡すことにより複数列が一度に グループ化された場合にonGroupingDone イベントは一度のみ発生します。 イベント引数は、ISortingExpressionとグループ化/グループ解除操作と関連するIgxColumnComponentを含むexpressions、groupedColumns、ungroupedColumnsプロパティを提供します。groupedColumnsとungroupedColumns` は新しく変更 (最近のグループ化/グループ解除操作によって影響) された列のみ表示し、 現在グループ化/グループ解除されているすべての列ではありません。 列

@例:
<igx-grid #grid [data]="localData" (onGroupingDone)="groupingDone($event)" [autoGenerate]="true"></igx-grid>

pageChange

pageChange: EventEmitter<number> = ...

Emitted after the current page is changed.

@example
<igx-grid (pageChange)="onPageChange($event)"></igx-grid>

public onPageChange(page: number) {
  this.currentPage = page;
}

paginationTemplate

paginationTemplate: TemplateRef<any>

Gets/Sets a custom ng-template for the pagination UI of the grid.

@example
<igx-grid #grid [paging]="true" [myTemplate]="myTemplate" [height]="'305px'"></igx-grid>

pagingDone

pagingDone: EventEmitter<IPageEventArgs> = ...

Emitted after paging is performed.

@remarks

Returns an object consisting of the previous and next pages.

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

perPageChange

perPageChange: EventEmitter<number> = ...

Emitted when perPage property value of the grid is changed.

@example
<igx-grid #grid (perPageChange)="onPerPageChange($event)" [autoGenerate]="true"></igx-grid>

public onPerPageChange(perPage: number) {
  this.perPage = perPage;
}

primaryKey

primaryKey: any

Gets/Sets the primary key.

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

rangeSelected

rangeSelected: EventEmitter<GridSelectionRange> = ...

Emitted when making a range selection.

@remarks

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

rendered

rendered: EventEmitter<boolean> = ...

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

rendered$

rendered$: Observable<boolean> = ...

rowAdded

rowAdded: EventEmitter<IRowDataEventArgs> = ...

Emitted when a row added through the API.

@remarks

Returns the data for the new IgxGridRowComponent object.

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

rowCollapsedIndicatorTemplate

rowCollapsedIndicatorTemplate: TemplateRef<any> = null

The custom template, if any, that should be used when rendering a row collapse indicator.

rowDeleted

rowDeleted: EventEmitter<IRowDataEventArgs> = ...

Emitted when a row is deleted through API.

@remarks

Returns an IRowDataEventArgs object.

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

rowDragEnd

rowDragEnd: EventEmitter<IRowDragEndEventArgs> = ...

Emitted when dropping a row.

@remarks

Return the dropped row.

rowDragStart

rowDragStart: EventEmitter<IRowDragStartEventArgs> = ...

Emitted when start dragging a row.

@remarks

Return the dragged row.

rowEdit

rowEdit: EventEmitter<IGridEditEventArgs> = ...

Emitted when exiting edit mode for a row.

@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

rowEditDone: EventEmitter<IGridEditDoneEventArgs> = ...

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

@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.

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

rowEditEnter

rowEditEnter: EventEmitter<IGridEditEventArgs> = ...

Emitted when a row enters edit mode.

@remarks

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

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

rowEditExit

rowEditExit: EventEmitter<IGridEditDoneEventArgs> = ...

Emitted when row editing is canceled.

@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>

rowExpandedIndicatorTemplate

rowExpandedIndicatorTemplate: TemplateRef<any> = null

The custom template, if any, that should be used when rendering a row expand indicator.

rowPinning

rowPinning: EventEmitter<IPinRowEventArgs> = ...

Emitted when the pinned state of a row is changed.

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

rowSelected

rowSelected: EventEmitter<IRowSelectionEventArgs> = ...

Emitted when IgxGridRowComponent is selected.

@example
<igx-grid #grid (rowSelected)="onCellClickChange($event)" [data]="localData" [autoGenerate]="true"></igx-grid>

rowToggle

rowToggle: EventEmitter<IRowToggleEventArgs> = ...

Emitted when the expanded state of a row gets changed.

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

selected

selected: EventEmitter<IGridCellEventArgs> = ...

Emitted when IgxGridCellComponent is selected.

@remarks

Returns the IgxGridCellComponent.

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

selectionService

selectionService: IgxGridSelectionService

shouldGenerate

shouldGenerate: boolean

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

@remarks

This will allow to bind the grid to remote data and having auto-generated columns at the same time. Note that after generating the columns, this property would be disabled to avoid re-creating columns each time a new data is assigned.

@example
 this.grid.shouldGenerate = true;

snackbarDisplayTime

snackbarDisplayTime: number = 6000

行追加の snackbar 通知の表示時間を取得/設定します。

@備考

デフォルトでは 6000ms です。

sorting

sorting: EventEmitter<ISortingEventArgs> = ...

Emitted before sorting expressions are applied.

@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

sortingDone: EventEmitter<ISortingExpression | ISortingExpression[]> = ...

Emitted after sorting is completed.

@remarks

Returns the sorting expression.

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

sortingExpressionsChange

sortingExpressionsChange: EventEmitter<ISortingExpression[]> = ...

Emitted before sorting is performed.

@remarks

Returns the sorting expressions.

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

summaryService

summaryService: IgxGridSummaryService

toolbarExporting

toolbarExporting: EventEmitter<IGridToolbarExportEventArgs> = ...

Emitted when an export process is initiated by the user.

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

uniqueColumnValuesStrategy

uniqueColumnValuesStrategy: function

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

@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>

Type declaration

アクセサー

activeDescendant

  • get activeDescendant(): string

advancedFilteringExpressionsTree

allowAdvancedFiltering

  • get allowAdvancedFiltering(): boolean
  • set allowAdvancedFiltering(value: boolean): void

allowFiltering

  • get allowFiltering(): boolean
  • set allowFiltering(value: boolean): void

bannerClass

  • get bannerClass(): string

cellSelection

columnHiding

  • get columnHiding(): boolean
  • set columnHiding(value: boolean): void

columnHidingTitle

  • get columnHidingTitle(): string
  • set columnHidingTitle(v: string): void

columnPinning

  • get columnPinning(): boolean
  • set columnPinning(value: boolean): void

columnPinningTitle

  • get columnPinningTitle(): string
  • set columnPinningTitle(v: string): void

columnSelection

columnWidth

  • get columnWidth(): string
  • set columnWidth(value: string): void

columns

data

  • get data(): any[]
  • set data(value: any[]): void

dataRowList

dataView

  • get dataView(): any[]

defaultHeaderGroupMinWidth

  • get defaultHeaderGroupMinWidth(): number

defaultRowHeight

  • get defaultRowHeight(): number

displayDensity

dragIndicatorIconTemplate

  • get dragIndicatorIconTemplate(): TemplateRef<any>
  • set dragIndicatorIconTemplate(val: TemplateRef<any>): void

dropAreaMessage

  • get dropAreaMessage(): string
  • set dropAreaMessage(value: string): void

dropAreaVisible

  • get dropAreaVisible(): boolean

emptyFilteredGridMessage

  • get emptyFilteredGridMessage(): string
  • set emptyFilteredGridMessage(value: string): void

emptyGridMessage

  • get emptyGridMessage(): string
  • set emptyGridMessage(value: string): void

expansionStates

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

exportCsv

  • get exportCsv(): boolean
  • set exportCsv(newValue: boolean): void

exportCsvText

  • get exportCsvText(): string
  • set exportCsvText(newValue: string): void

exportExcel

  • get exportExcel(): boolean
  • set exportExcel(newValue: boolean): void

exportExcelText

  • get exportExcelText(): string
  • set exportExcelText(newValue: string): void

exportText

  • get exportText(): string
  • set exportText(newValue: string): void

filterCellList

  • get filterCellList(): IgxGridFilteringCellComponent[]

filterMode

filterStrategy

filteredData

  • get filteredData(): any
  • set filteredData(value: any): void

filteredSortedData

  • get filteredSortedData(): any[]

filteringExpressionsTree

filteringLogic

groupAreaTemplate

  • get groupAreaTemplate(): TemplateRef<any>
  • set groupAreaTemplate(template: TemplateRef<any>): void

groupRowTemplate

  • get groupRowTemplate(): TemplateRef<any>
  • set groupRowTemplate(template: TemplateRef<any>): void

groupingExpansionState

groupingExpressions

groupsRowList

  • get groupsRowList(): QueryList<any>

hasColumnGroups

  • get hasColumnGroups(): boolean

hasColumnLayouts

  • get hasColumnLayouts(): boolean

hasEditableColumns

  • get hasEditableColumns(): boolean

hasFilterableColumns

  • get hasFilterableColumns(): boolean

hasGroupableColumns

  • get hasGroupableColumns(): boolean

hasMovableColumns

  • get hasMovableColumns(): boolean

hasSortableColumns

  • get hasSortableColumns(): boolean

hasSummarizedColumns

  • get hasSummarizedColumns(): boolean

headerCellList

  • get headerCellList(): IgxGridHeaderComponent[]

headerGroupsList

  • get headerGroupsList(): IgxGridHeaderGroupComponent[]

headerWidth

  • get headerWidth(): number

height

  • get height(): string
  • set height(value: string): void

hiddenColumnsCount

  • get hiddenColumnsCount(): number

hiddenColumnsText

  • get hiddenColumnsText(): string
  • set hiddenColumnsText(value: string): void

hideGroupedColumns

  • get hideGroupedColumns(): boolean
  • set hideGroupedColumns(value: boolean): void

hideRowSelectors

  • get hideRowSelectors(): boolean
  • set hideRowSelectors(value: boolean): void

isFirstPage

  • get isFirstPage(): boolean

isLastPage

  • get isLastPage(): boolean

isLoading

  • get isLoading(): boolean
  • set isLoading(value: boolean): void

locale

  • get locale(): string
  • set locale(value: string): void

nativeElement

  • get nativeElement(): any

outlet

page

  • get page(): number
  • set page(val: number): void

paging

  • get paging(): boolean
  • set paging(value: boolean): void

pagingMode

perPage

  • get perPage(): number
  • set perPage(val: number): void

pinnedColumns

pinnedColumnsCount

  • get pinnedColumnsCount(): number

pinnedColumnsText

  • get pinnedColumnsText(): string
  • set pinnedColumnsText(value: string): void

pinnedDataView

  • get pinnedDataView(): any[]

pinnedRowHeight

  • get pinnedRowHeight(): any

pinnedRows

  • get pinnedRows(): IgxGridRowComponent[]

pinnedWidth

  • get pinnedWidth(): number

pinning

resourceStrings

rowDraggable

  • get rowDraggable(): boolean
  • set rowDraggable(val: boolean): void

rowEditable

  • get rowEditable(): boolean
  • set rowEditable(val: boolean): void

rowHeight

  • get rowHeight(): any
  • set rowHeight(value: any): void

rowList

  • get rowList(): QueryList<any>

rowSelection

selectRowOnClick

  • get selectRowOnClick(): boolean
  • set selectRowOnClick(enabled: boolean): void

selectedCells

selectedRows

  • get selectedRows(): any[]
  • set selectedRows(rowIDs: any[]): void

showGroupArea

  • get showGroupArea(): boolean
  • set showGroupArea(value: boolean): void

showSummaryOnCollapse

  • get showSummaryOnCollapse(): boolean
  • set showSummaryOnCollapse(value: boolean): void

showToolbar

  • get showToolbar(): boolean
  • set showToolbar(newValue: boolean): void

sortStrategy

sortingExpressions

summaryCalculationMode

summaryPosition

toolbarTitle

  • get toolbarTitle(): string
  • set toolbarTitle(newValue: string): void

totalHeight

  • get totalHeight(): any

totalItemCount

  • get totalItemCount(): number
  • set totalItemCount(count: number): void

totalPages

  • get totalPages(): number

totalRecords

  • get totalRecords(): number
  • set totalRecords(total: number): void

totalWidth

  • get totalWidth(): number

transactions

unpinnedColumns

unpinnedDataView

  • get unpinnedDataView(): any[]

unpinnedWidth

  • get unpinnedWidth(): number

virtualizationState

visibleColumns

width

  • get width(): string
  • set width(value: string): void

メソッド

_setupListeners

  • _setupListeners(): void

_setupServices

  • _setupServices(): void

addRow

  • addRow(data: any): void

clearFilter

  • clearFilter(name?: string): void

clearGrouping

  • clearGrouping(name?: string | string[]): void

  • Clears grouping for particular column, array of columns or all columns.

    @remarks

    Clears all grouping in the grid, if no parameter is passed. If a parameter is provided, clears grouping for a particular column or an array of columns.

    @example
    this.grid.clearGrouping(); //clears all grouping
this.grid.clearGrouping("ID"); //ungroups a single column
this.grid.clearGrouping(["ID", "Column1", "Column2"]); //ungroups multiple columns

    パラメーター

    • オプション name: string | string[]

      Name of column or array of column names to be ungrouped.

    返却 void

clearSearch

  • clearSearch(): void

clearSort

  • clearSort(name?: string): void

closeAdvancedFilteringDialog

  • closeAdvancedFilteringDialog(applyChanges: boolean): void

collapseAll

  • collapseAll(): void

collapseRow

  • collapseRow(rowID: any): void

combineSelectedCellAndColumnData

  • combineSelectedCellAndColumnData(columnData: any[], formatters?: boolean, headers?: boolean): any[]

deleteRow

  • deleteRow(rowSelector: any): void

deselectAllColumns

  • deselectAllColumns(): void

deselectAllRows

  • deselectAllRows(onlyFilterData?: boolean): void

deselectColumns

deselectRows

  • deselectRows(rowIDs: any[]): void

deselectRowsInGroup

disableSummaries

  • disableSummaries(...rest: any[]): void

enableSummaries

  • enableSummaries(...rest: any[]): void

  • Enables summaries for the specified column and applies your customSummary.

    @remarks

    If you do not provide the customSummary, then the default summary for the column data type will be applied.

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

    Enable summaries for the listed columns.

    @example
    grid.enableSummaries('ProductName');

    パラメーター

    • 残りの引数 ...rest: any[]

    返却 void

endEdit

  • endEdit(commit?: boolean, event?: Event): void

expandAll

  • expandAll(): void

expandRow

  • expandRow(rowID: any): void

filter

filterGlobal

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

findNext

  • findNext(text: string, caseSensitive?: boolean, exactMatch?: boolean): number

  • Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible.

    @remarks

    Returns how many times the grid contains the string.

    @example
    this.grid.findNext("financial");

    パラメーター

    • 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).

    返却 number

findPrev

  • findPrev(text: string, caseSensitive?: boolean, exactMatch?: boolean): number

  • Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible.

    @remarks

    Returns how many times the grid contains the string.

    @example
    this.grid.findPrev("financial");

    パラメーター

    • 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).

    返却 number

fullyExpandGroup

getCellByColumn

getCellByColumnVisibleIndex

getCellByKey

getColumnByName

getColumnByVisibleIndex

getEmptyRecordObjectFor

  • getEmptyRecordObjectFor(rec: any): any

getHeaderGroupWidth

getNextCell

  • getNextCell(currRowIndex: number, curVisibleColIndex: number, callback?: function): ICellPosition

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

    @remarks

    You can pass callback function as a third parameter of getPreviousCell method. The callback function accepts IgxColumnComponent as a param

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

    パラメーター

    • currRowIndex: number
    • curVisibleColIndex: number
    • callback: function = null
        • (IgxColumnComponent: any): boolean

        • パラメーター

          • IgxColumnComponent: any

          返却 boolean

    返却 ICellPosition

getPinnedWidth

  • getPinnedWidth(takeHidden?: boolean): number

getPreviousCell

  • getPreviousCell(currRowIndex: number, curVisibleColIndex: number, callback?: function): ICellPosition

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

    @remarks

    You can pass callback function as a third parameter of getPreviousCell method. The callback function accepts IgxColumnComponent as a param

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

    パラメーター

    • currRowIndex: number
    • curVisibleColIndex: number
    • callback: function = null
        • (IgxColumnComponent: any): boolean

        • パラメーター

          • IgxColumnComponent: any

          返却 boolean

    返却 ICellPosition

getRowByIndex

  • getRowByIndex(index: number): RowType

getRowByKey

getRowData

  • getRowData(rowSelector: any): any

getSelectedColumnsData

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

getSelectedData

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

groupBy

  • Groups by a new IgxColumnComponent based on the provided expression, or modifies an existing one.

    @remarks

    Also allows for multiple columns to be grouped at once if an array of ISortingExpression is passed. The onGroupingDone event would get raised only once if this method gets called multiple times with the same arguments.

    @example
    this.grid.groupBy({ fieldName: name, dir: SortingDirection.Asc, ignoreCase: false });
this.grid.groupBy([
    { fieldName: name1, dir: SortingDirection.Asc, ignoreCase: false },
    { fieldName: name2, dir: SortingDirection.Desc, ignoreCase: true },
    { fieldName: name3, dir: SortingDirection.Desc, ignoreCase: false }
]);

    パラメーター

    返却 void

isExpandedGroup

isRecordPinnedByIndex

  • isRecordPinnedByIndex(rowIndex: number): boolean

markForCheck

  • markForCheck(): void

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

    ```typescript // 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();
    @example
    grid.markForCheck();

    返却 void

moveColumn

navigateTo

  • navigateTo(rowIndex: number, visibleColIndex?: number, cb?: function): void

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

    @remarks

    Also can execute a custom logic over the target element, through a callback function that accepts { targetType: GridKeydownTargetType, target: Object }

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

    パラメーター

    • rowIndex: number
    • visibleColIndex: number = -1
    • cb: function = null
        • (args: any): void

        • パラメーター

          • args: any

          返却 void

    返却 void

nextPage

  • nextPage(): void

openAdvancedFilteringDialog

paginate

  • paginate(val: number): void

pinColumn

pinRow

  • pinRow(rowID: any, index?: number): boolean

preventHeaderScroll

  • preventHeaderScroll(args: any): void

previousPage

  • previousPage(): void

reflow

  • reflow(): void

refreshSearch

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

selectAllColumns

  • selectAllColumns(): void

selectAllRows

  • selectAllRows(onlyFilterData?: boolean): void

  • Selects all rows

    @remarks

    By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows. If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows.

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

    パラメーター

    • onlyFilterData: boolean = true

    返却 void

selectColumns

  • selectColumns(columns: string[] | IgxColumnComponent[], clearCurrentSelection?: boolean): void

selectRows

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

selectRowsInGroup

  • selectRowsInGroup(groupRow: IGroupByRecord, clearPrevSelection?: boolean): void

selectedColumns

sort

toggleAllGroupRows

  • toggleAllGroupRows(): void

toggleColumnVisibility

toggleGroup

toggleRow

  • toggleRow(rowID: any): void

unpinColumn

unpinRow

  • unpinRow(rowID: any): boolean

updateCell

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

  • Updates the IgxGridRowComponent and the corresponding data record by primary key.

    @remarks

    Requires that the primaryKey property is set.

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

    パラメーター

    • value: any

      the new value which is to be set.

    • rowSelector: any

      corresponds to rowID.

    • column: string

      corresponds to column field.

    返却 void

updateRow

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

  • Updates the IgxGridRowComponent

    @remarks

    The row is specified by rowSelector parameter and the data source record with the passed value. This method will apply requested update only if primary key is specified in the grid.

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

    パラメーター

    • value: any
    • rowSelector: any

      correspond to rowID

    返却 void