Class IgxGridComponent

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

IgxGridModule

グリッド & リスト

grid, table

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>

階層

Hierarchy

  • IgxGridBaseDirective
    • IgxGridComponent

実装

  • GridType
  • OnInit
  • DoCheck
  • AfterContentInit
  • AfterViewInit

コンストラクター

プロパティ

メソッド

メソッド

コンストラクター

  • パラメーター

    • validation: IgxGridValidationService

      グリッドの検証サービスを表します。このタイプには、レコードを検証するためのプロパティとメソッド (ロジック) が含まれます。

    • colResizingService: IgxColumnResizingService
    • gridAPI: GridServiceType

      グリッドに API メソッドを提供するグリッド サービス タイプを表します。

    • transactionFactory: IgxFlatTransactionFactory
    • elementRef: ElementRef<HTMLElement>
    • zone: NgZone
    • cdr: ChangeDetectorRef

      変更検出機能を提供します。 変更検出ツリーは、変更がチェックされるすべてのビューを収集します。 プロパティは変更できません (読み取り専用)。

    • differs: IterableDiffers
    • viewRef: ViewContainerRef
    • injector: Injector
    • envInjector: EnvironmentInjector
    • navigation: IgxGridNavigationService
    • textHighlightService: IgxTextHighlightService
    • overlayService: IgxOverlayService
    • localeId: string
    • platform: PlatformUtil
    • _diTransactions: TransactionService<Transaction, State>

    返却 IgxGridComponent

プロパティ

activeNodeChange: EventEmitter<IActiveNodeChangeEventArgs> = ...

アクティブなノードが変更されたときに発生します。

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

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

<igx-grid [id]="'igx-grid-1'" [data]="Data" [addRowEmptyTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
advancedFilteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree> = ...

高度フィルタリングが UI で実行された後に発生されます。

高度フィルタリング式ツリーを返します。

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

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

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

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

生成された列コレクションから除外されるプロパティ キーのリストを取得または設定します

コレクションは初期化中にのみ使用され、それを変更しても、グリッドが破棄されて再作成されない限り、 実行時に生成された列に変更は発生しません。実行時に UI に表示される列を変更するには、 hidden プロパティを使用してください。

<igx-grid data=[Data] [autoGenerate]="true" [autoGenerateExclude]="['ProductName', 'Count']"></igx-grid>
const Data = [{ 'Id': '1', 'ProductName': 'name1', 'Description': 'description1', 'Count': 5 }]
cdr: ChangeDetectorRef

変更検出機能を提供します。 変更検出ツリーは、変更がチェックされるすべてのビューを収集します。 プロパティは変更できません (読み取り専用)。

cellClick: EventEmitter<IGridCellEventArgs> = ...

セルがクリックされたときに発生します。

IgxGridCell を返します。

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

セルが編集された後に生成されます。

編集を完了してセルの編集モードを終了するときにイベントが発生します。 このイベントはキャンセルできます。

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

セルが編集され、編集が確定された後に発生します。

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

セルが編集モードに入るときに生成されます。

このイベントはキャンセルできます。

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

セルが編集モードを終了すると発行されます。

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

グリッドのコピー動作を制御します。

columnInit: EventEmitter<IgxColumnComponent> = ...

列が初期化されるときに発生します。

列オブジェクトを返します。

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

列移動操作のときに発生されます。

ソースとターゲットの IgxColumnComponent オブジェクトを返します。このイベントはキャンセルできます。

<igx-grid (columnMoving)="moving($event)"></igx-grid>
columnMovingEnd: EventEmitter<IColumnMovingEndEventArgs> = ...

列移動が終了したときに発生されます。

ソースとターゲットの IgxColumnComponent オブジェクトを返します。

<igx-grid (columnMovingEnd)="movingEnds($event)"></igx-grid>
columnMovingStart: EventEmitter<IColumnMovingStartEventArgs> = ...

列移動を開始したときに発生されます。

移動した IgxColumnComponent オブジェクトを返します。

<igx-grid (columnMovingStart)="movingStart($event)"></igx-grid>
columnPin: EventEmitter<IPinColumnCancellableEventArgs> = ...

IgxColumnComponent がピン固定される前に発生します。

列に挿入するインデックスは insertAtIndex プロパティによって変更できます。

public columnPinning(event) {
if (event.column.field === "Name") {
event.insertAtIndex = 0;
}
}
columnPinned: EventEmitter<IPinColumnEventArgs> = ...

IgxColumnComponent がピン固定された後に発生します。

列に挿入するインデックスは insertAtIndex プロパティによって変更できます。

public columnPinning(event) {
if (event.column.field === "Name") {
event.insertAtIndex = 0;
}
}
columnResized: EventEmitter<IColumnResizeEventArgs> = ...

列のサイズが変更された後に発行されます。

IgxColumnComponent オブジェクトの古い幅および新しい幅を返します。

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

IgxColumnComponent が選択されたときに発生します。

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

列の表示状態が変更された後に発行されます。

引数: { column: IgxColumnComponent, newValue: boolean }

<igx-grid (columnVisibilityChanged)="visibilityChanged($event)"></igx-grid>
columnVisibilityChanging: EventEmitter<IColumnVisibilityChangingEventArgs> = ...

列の表示状態が変更される前に発行されます。

引数: { column: any, newValue: boolean }

<igx-grid (columnVisibilityChanging)="visibilityChanging($event)"></igx-grid>
contextMenu: EventEmitter<IGridContextMenuEventArgs> = ...

セルまたは行を右クリックすると発行されます。

直近のコンテキスト メニュー ターゲットがセルの場合は IgxGridCell オブジェクトを返し、それ以外の場合は IgxGridRow を返します。

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

データ操作、再バインドなどのためにグリッドのデータ ビューが変更された後に発生します。

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

データ操作、再バインドなどのためにグリッドのデータ ビューが変更される前に発生します。

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

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

 <igx-grid #grid [data]="localData" [autoGenerate]="true" (dataPreLoad)='handleDataPreloadEvent()'></igx-grid>
doubleClick: EventEmitter<IGridCellEventArgs> = ...

セルがダブルクリックされたときに発生されます。

IgxGridCell オブジェクトを返します。

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

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

GroupBy 領域を表示するためにグリッドでグループ可能な列が 1 列以上必要です。

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

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

<igx-grid [id]="'igx-grid-1'" [data]="Data" [emptyGridTemplate]="myTemplate" [autoGenerate]="true"></igx-grid>
filtering: EventEmitter<IFilteringEventArgs> = ...

フィルタリング式が適用される前に発生されます。

IFilteringEventArgs オブジェクトを返します。filteringExpressions キーは、列のフィルタリング式を保持します。

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

UI を介してフィルタリングが実行された後に発行されます。

フィルターされた列のフィルタリング式ツリーを返します。

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

フィルタリングが UI で実行された後に発生されます。

フィルターされた列のフィルタリング式ツリーを返します。

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

行/セルの編集時に formGroup が作成されたときに発生します。

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

グリッドに API メソッドを提供するグリッド サービス タイプを表します。

gridCopy: EventEmitter<IGridClipboardEvent> = ...

コピー操作が実行されたときに発生します。

[clipboardOptions]IgxGridBaseDirective#clipboardOptions を使用してコピー動作が有効になっている場合のみ発生します。

gridKeydown: EventEmitter<IGridKeydownEventArgs> = ...

グリッドの内の要素に対してキーダウンがトリガーされたときに発生します。

このイベントは、グリッドでキーの組み合わせがサポートされている場合にのみ発生します。 ターゲット タイプ、ターゲット オブジェクト、および元のイベントを返します。このイベントはキャンセルできます。

 <igx-grid (gridKeydown)="customKeydown($event)"></igx-grid>
gridScroll: EventEmitter<IGridScrollEventArgs> = ...

グリッドが水平/垂直にスクロールされるときに発生します。

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

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

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

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

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

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

<igx-grid #grid [data]="Data" [groupsExpanded]="false" [autoGenerate]="true"></igx-grid>
id: string = ...

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

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

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

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

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

列移動がグリッドで有効かどうかを制御します。

navigation: IgxGridNavigationService
primaryKey: string

プライマリ キーを取得または設定します。

<igx-grid #grid [data]="localData" [primaryKey]="'ProductID'" [autoGenerate]="true"></igx-grid>
rangeSelected: EventEmitter<GridSelectionRange> = ...

範囲選択を行ったときに発生します。

範囲選択がドラッグ選択またはキーボード選択による行います。

rendered: EventEmitter<boolean> = ...

ngAfterViewInit の後に発生します。この時点で、グリッドは DOM に存在します。

rowAdd: EventEmitter<IRowDataCancelableEventArgs> = ...

新しく追加された行がコミットされる直前に発行します。

このイベントはキャンセルできます。 IRowDataCancellableEventArgs オブジェクトを返します。

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

行が追加されたときに発生します。

新しい IgxGridRowComponent オブジェクトのデータを返します。

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

グリッドの行要素に条件付きクラス セレクターを設定します。 キーと値のペアを含むオブジェクト リテラルを受け取ります。 キーは CSS クラスの名前です。 値はブール値を返すコールバック関数またはブール値です。例:

callback = (row: RowType) => { return row.selected > 6; }
rowClasses = { 'className' : this.callback };
<igx-grid #grid [data]="Data" [rowClasses] = "rowClasses" [autoGenerate]="true"></igx-grid>

IgxColumnComponent

rowClick: EventEmitter<IGridRowEventArgs> = ...

行を削除するときに発行します。

このイベントはキャンセルできます。 IGridEditEventArgs オブジェクトを返します。

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

行を削除するときに発行します。

このイベントはキャンセルできます。 IRowDataCancellableEventArgs オブジェクトを返します。

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

行が削除されたときに発生します。

IRowDataEventArgs オブジェクトを返します。

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

行をドロップしたときに発行されます。

ドロップされた行を返します。

rowDragStart: EventEmitter<IRowDragStartEventArgs> = ...

行をドラッグし始めたときに発生します。

ドラッグされた行を返します。

rowEdit: EventEmitter<IGridEditEventArgs> = ...

行の編集モードを終了するときに発生されます。

[rowEditable]="true" & endEdit(true) が呼び出されるときに発生されます。 編集モード中に行を変更した時、編集された行内の編集が無効なセルを選択した時、ページング操作時、列のサイズ変更時、ピン固定時、移動時、rowEditingOverlay 内で Done ボタンを押したとき、またはセルの編集中に Enter キーを押したときに発生します。 このイベントはキャンセルできます。

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

行の編集モードを終了し、編集が確定された後に発生します。

[rowEditable]="true" & endEdit(true) が呼び出されるときに発生されます。 編集モード中に行を変更した時、編集された行内の編集が無効なセルを選択した時、ページング操作時、列のサイズ変更時、ピン固定時、移動時、rowEditingOverlay 内で Done ボタンを押したとき、またはセルの編集中に Enter キーを押したときに発生します。

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

行が編集モードに入るときに生成されます。

[rowEditable]="true" のときに発生されます。 このイベントはキャンセルできます。

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

行編集がキャンセルされるときに発生されます。

[rowEditable]="true" & endEdit(false) が呼び出されるときに発生されます。 セル編集のときに Esc キーを押して、行編集オーバーレイに Cancel ボタン を押すと発生されます。

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

行のピン固定状態が変更されたときに呼び出されます。

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

行のピン固定状態が変更されたときに呼び出されます。

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

IgxGridRowComponent が選択されたときに発生します。

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

グリッドの行要素に条件付きスタイル プロパティを設定します。 キーがスタイル プロパティであり、 値が評価用の式であるオブジェクト リテラルを受け入れます。

styles = {
background: 'yellow',
color: (row: RowType) => row.selected : 'red': 'white'
}
<igx-grid #grid [data]="Data" [rowStyles]="styles" [autoGenerate]="true"></igx-grid>

IgxColumnComponent

rowToggle: EventEmitter<IRowToggleEventArgs> = ...

行の展開状態が変更されているときに呼び出されます。

<igx-grid [data]="employeeData" (rowToggle)="rowToggle($event)" [autoGenerate]="true"></igx-grid>
selected: EventEmitter<IGridCellEventArgs> = ...

セルが選択されたときに発生発生します。

IgxGridCell を返します。

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

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

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

sorting: EventEmitter<ISortingEventArgs> = ...

ソート式が適用される前に発生されます。

ISortingEventArgs オブジェクトを返します。sortingExpressions キーは、ソート式を保持します。

<igx-grid #grid [data]="localData" [autoGenerate]="true" (sorting)="sorting($event)"></igx-grid>
sortingDone: EventEmitter<ISortingExpression<any> | ISortingExpression<any>[]> = ...

ソートが完了した後に発行されます。

ソート式を返します。

<igx-grid #grid [data]="localData" [autoGenerate]="true" (sortingDone)="sortingDone($event)"></igx-grid>
sortingExpressionsChange: EventEmitter<ISortingExpression<any>[]> = ...

ソートが UI で実行された前に発生されます。

ソート式を返します。

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

ユーザーがエクスポート処理が開始すると発生されます。

toolbarExporting(event: IGridToolbarExportEventArgs){
const toolbarExporting = event;
}
uniqueColumnValuesStrategy: ((column: ColumnType, filteringExpressionsTree: IFilteringExpressionsTree, done: ((values: any[]) => void)) => void)

Excel スタイル フィルタリングによって使用される一意の値戦略を取得または設定します。

要求に応じて一意の列値をロードするためのコールバックを提供します。 このプロパティが提供された場合、生成される一意の値は Excel スタイル フィルタリングによって使用されます。

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

Type declaration

    • (column, filteringExpressionsTree, done): void
    • パラメーター

      返却 void

validation: IgxGridValidationService

グリッドの検証サービスを表します。このタイプには、レコードを検証するためのプロパティとメソッド (ロジック) が含まれます

validationStatusChange: EventEmitter<IGridValidationStatusEventArgs> = ...

グリッドの検証状態が変更されたときに発生します。

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

グリッドの編集時に使用される検証のトリガーを取得または設定します。

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

メソッド

  • get defaultHeaderGroupMinWidth(): number
  • IgxGridHeaderGroupComponentの最小許容幅を返します。

    ヘッダー グループ コンポーネントの幅を制限するために内部で使用されます。 以下の値は、ヘッダーセルのデフォルトの右/左パディング値に基づいています。

    返却 number

  • get shouldGenerate(): boolean
  • グリッドの初期化後に列が自動で再生成されるかどうかを取得または設定します。

    これにより、グリッドをリモート データにバインドし、同時に列を自動生成できるようになります。 列を生成した後は、新しいデータが割り当てられるたびに列が再作成されるのを避けるために、このプロパティは無効になることに注意してください。

     this.grid.shouldGenerate = true;
    

    バージョン 18.2.0。列の再作成は、代わりに autoGenerate に依存するようになりました。

    返却 boolean

  • set shouldGenerate(value): void
  • パラメーター

    • value: boolean

    返却 void

  • get showSummaryOnCollapse(): boolean
  • groupBy / 親行が縮小されたときに集計行を表示するかどうかを制御します。

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

    デフォルトでは、showSummaryOnCollapse は 'false' に設定されています。これは、 グループ化/親行が縮小されたときに、集計行が表示されないことを意味します。

    返却 boolean

  • set showSummaryOnCollapse(value): void
  • パラメーター

    • value: boolean

    返却 void

メソッド

  • rowID で指定された行の下に UI を生成し、追加モードに入ります。

    行追加 UI を生成する場合は RowID、データ ビューの最初のレコードとして生成する場合は null。

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

    パラメーター

    • rowID: any

      行追加 UI を生成する場合は RowID、データ ビューの最初のレコードとして生成する場合は null。

    • asChild: boolean

      レコードを子として追加する必要があるかどうか。igxTreeGrid にのみ適用されます。

    返却 void

  • 指定されたインデックスで UI を生成することにより、追加モードに入ります。

    インデックスに使用できる値は、0 から現在の行数 (this.grid.dataView.length) までの整数です。

    this.grid.beginAddRowByIndex(0);
    

    パラメーター

    • index: number

      UI を生成するインデックスです。0 から 現在の行数 (this.grid.dataView.length) までの整数を設定できます。

    返却 void

  • 名前が提供された場合、対応する IgxColumnComponent のフィルター状態をクリアします。

    それ以外の場合、すべての IgxColumnComponent のフィルター状態をクリアします。

    this.grid.clearFilter();
    

    パラメーター

    • name: string

    返却 void

  • 特定の列、列の配列またはすべての列のグループ化をクリアします。

    パラメーターが渡されない場合、グリッドのグループ化をすべてクリアします。 パラメーターが提供された場合、特定の列または列の配列のグループ化をクリアします。

    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[]

      グループ化が解除される列の名前または列名の配列です。

    返却 void

  • 名前が提供された場合、対応する IgxColumnComponent のフィルター状態をクリアします。

    それ以外の場合、すべての IgxColumnComponent のソート状態をクリアします。

    this.grid.clearSort();
    

    パラメーター

    • name: string

    返却 void

  • 高度なフィルタリング ダイアログを閉じます。

    パラメーター

    • applyChanges: boolean

      変更を適用する必要があるかどうかを示します。

    返却 void

  • ID によって行を縮小します。

    ID は、primaryKey 値またはデータ レコード インスタンスです。

    this.grid.collapseRow(rowID);
    

    パラメーター

    • rowID: any

      行 ID - primaryKey 値またはデータ レコード インスタンスです。

    返却 void

  • プライマリ キーによって IgxGridRowComponent および対応するデータ レコードを削除します。

    primaryKey プロパティの設定が必要です。 メソッドは、rowID である rowSelector をパラメーターとして受け取ります。

    this.grid1.deleteRow(0);
    

    パラメーター

    • rowSelector: any

    返却 any

  • すべての行を選択解除します。

    フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。 onlyFilterData のパラメーターを false に設定すると、削除された行を除きグリッド内のすべての行を選択解除します。

    this.grid.deselectAllRows();
    

    パラメーター

    • onlyFilterData: boolean = true

    返却 void

  • 指定した列で集計を無効にします。

    grid.disableSummaries('ProductName');
    

    配列の列で集計を無効にします。

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

    パラメーター

    • ...rest: any[]

    返却 void

  • 指定した列で集計を有効にし、customSummary を適用します。

    customSummary を設定しない場合、列のデータ タイプのデフォルト集計が適用されます。

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

    配列の列で集計を有効にします。

    grid.enableSummaries('ProductName');
    

    パラメーター

    • ...rest: any[]

    返却 void

  • 現在の行の行トランザクションを完成し、グリッド編集がキャンセルされたかどうかを返します。

    commit === true の場合、未解決状態からデータ (またはトランザクション サービス) へ渡します。

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

    パラメーター

    • commit: boolean = true
    • event: Event

    返却 boolean

  • ID によって行を展開します。

    ID は、primaryKey 値またはデータ レコード インスタンスです。

    this.grid.expandRow(rowID);
    

    パラメーター

    • rowID: any

      行 ID - primaryKey 値またはデータ レコード インスタンスです。

    返却 void

  • 同じ条件で IgxGridComponent のすべての IgxColumnComponent をフィルターします。

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

    パラメーター

    • value: any
    • condition: any
    • ignoreCase: any

    返却 void

  • グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。

    グリッドに文字列が何回含まれるかを返します。

    this.grid.findNext("financial");
    

    パラメーター

    • text: string

      検索する文字列。

    • caseSensitive: boolean

      オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルト値は false)。

    • exactMatch: boolean

      オプションで、テキストは値全体に一致するかどうか (デフォルト値は false)。

    返却 number

  • グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。

    グリッドに文字列が何回含まれるかを返します。

    this.grid.findPrev("financial");
    

    パラメーター

    • text: string

      検索する文字列。

    • caseSensitive: boolean

      オプションで、検索する文字列と検索で大文字と小文字の区別をするかどうか (デフォルト値は false)。

    • exactMatch: boolean

      オプションで、テキストは値全体に一致するかどうか (デフォルト値は false)。

    返却 number

  • 特定の基準に一致する、現在位置に従って次のセルを定義する ICellPosition を返します。

    getPreviousCell メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。 コールバック関数は、引数として IgxColumnComponent を受け入れます。

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

    パラメーター

    • currRowIndex: number
    • curVisibleColIndex: number
    • callback: ((IgxColumnComponent: any) => boolean) = null
        • (IgxColumnComponent): boolean
        • パラメーター

          • IgxColumnComponent: any

          返却 boolean

    返却 ICellPosition

  • ピン固定領域の計算幅を取得します。

    const pinnedWidth = this.grid.getPinnedWidth();
    

    パラメーター

    • takeHidden: boolean = false

      ピン固定の領域の非表示の列を考慮に入れるかどうか。

    返却 number

  • 特定の基準に一致する、現在位置に従って 前のセルを定義する ICellPosition を返します。

    getPreviousCell メソッド の 3 番目のパラメーターとしてコールバック関数を渡すことができます。 コールバック関数は、引数として IgxColumnComponent を受け入れます。

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

    パラメーター

    • currRowIndex: number
    • curVisibleColIndex: number
    • callback: ((IgxColumnComponent: any) => boolean) = null
        • (IgxColumnComponent): boolean
        • パラメーター

          • IgxColumnComponent: any

          返却 boolean

    返却 ICellPosition

  • 行コンポーネントに含まれているデータを返します。

    プライマリ キーが指定されていない場合、行セレクターは行データと一致します。

    const data = grid.getRowData(94741);
    

    パラメーター

    • rowSelector: any

      rowID に対応します。

    返却 any

  • 現在の列選択の配列を [{ column.field: cell.value }, ...] の形式で返します。

    formatters が有効な場合、セル値はそれぞれの列フォーマッタ (もしあれば) によってフォーマットされます。headers が有効な場合、列フィールドの代わりに列ヘッダーがある場合はそれを使います。

    パラメーター

    • formatters: boolean = false
    • headers: boolean = false

    返却 any[]

  • 現在のセル選択の配列を [{ column.field: cell.value }, ...] の形式で返します。

    formatters が有効な場合、セル値はそれぞれの列フォーマッタ (もしあれば) によってフォーマットされます。headers が有効な場合、列フィールドの代わりに列ヘッダーがある場合はそれを使います。

    パラメーター

    • formatters: boolean = false
    • headers: boolean = false

    返却 any[]

  • IgxColumnComponent を提供された式によってグループ化、または既存の式を変更します。

    ISortingExpression の配列が渡されると複数列を一度にグループ化できるようになります。 このメソッドが同じ引数で複数回呼びだされた場合、groupingDone イベントは 1 度のみ発生します。

    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

  • レコードがピン固定されているかどうかを返します。

    パラメーター

    • rowIndex: number

      filteredSortedData コレクション内のレコードのインデックスです。

    返却 boolean

  • IgxGridComponent の変更検出をトリガーします。 markForCheck を呼び出すと、グリッドのパイプも明示的にトリガーされ、すべての更新が処理されます。 不要なときに使用したり、誤用したりすると、パフォーマンスが低下する可能性があります。

    // 注意事項
    // ループ内から markForCheck を呼び出さないでください。
    // プリミティブが変更されたときに markForCheck を呼び出さないでください。
    grid.data.forEach(rec => {
    rec = newValue;
    grid.markForCheck();
    });

    // 注意事項
    // ネストされたプロパティを更新した後に markForCheck を呼び出します。
    grid.data.forEach(rec => {
    rec.nestedProp1.nestedProp2 = newValue;
    });
    grid.markForCheck();
    grid.markForCheck();
    

    返却 void

  • rowindexvisibleColumnIndex に基づいてグリッド内の位置に移動します。

    { targetType: GridKeydownTargetType, target: Object } を受け入れるコールバック関数を通してターゲット要素上で カスタム ロジックを実行することもできます。

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

    パラメーター

    • rowIndex: number
    • visibleColIndex: number = -1
    • cb: ((args: any) => void) = null
        • (args): void
        • パラメーター

          • args: any

          返却 void

    返却 void

  • ID によって行をピン固定します。

    ID は、primaryKey 値またはデータ レコード インスタンスです。

    this.grid.pinRow(rowID);
    

    パラメーター

    • rowID: any

      行 ID - primaryKey 値またはデータ レコード インスタンスです。

    • index: number

      ピン固定されたコレクションに挿入する行のインデックス。

    返却 boolean

  • 既存の検索を再適用します。

    グリッドに前回の検索テキストが何回含まれるかを返します。

    this.grid.refreshSearch();
    

    パラメーター

    • updateActiveInfo: boolean
    • endEdit: boolean = true

    返却 number

  • すべての行を選択します。

    フィルタリング機能が有効にされる場合、selectAllRows() および deselectAllRows() はフィルターされた行のみを選択/選択解除します。 onlyFilterData のパラメーターを false に設定すると、削除された行を除き Grid 内のすべての行が選択されます。

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

    パラメーター

    • onlyFilterData: boolean = true

    返却 void

  • 指定した行を ID によって選択します。

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

    パラメーター

    • rowIDs: any[]
    • clearCurrentSelection: boolean

      True の場合、現在の選択をクリアします。

    返却 void

  • ID によって行を切り替えます。

    ID は、primaryKey 値またはデータ レコード インスタンスです。

    this.grid.toggleRow(rowID);
    

    パラメーター

    • rowID: any

      行 ID - primaryKey 値またはデータ レコード インスタンスです。

    返却 void

  • ID によって行のピン固定を解除します。

    ID は、primaryKey 値またはデータ レコード インスタンスです。

    this.grid.unpinRow(rowID);
    

    パラメーター

    • rowID: any

      行 ID - primaryKey 値またはデータ レコード インスタンスです。

    返却 boolean

  • プライマリ キーによって IgxGridRowComponent および対応するデータ レコードを削除します。

    primaryKey プロパティの設定が必要です。

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

    パラメーター

    • value: any

      設定する新しい値です。

    • rowSelector: any

      rowID に対応します。

    • column: string

      列フィールドに対応します。

    返却 void

  • Updates the IgxGridRowComponent

    行が rowSelector パラメーター および渡された値を持つデータ ソース レコードによって指定されます。 このメソッドは、プライマリ キーがグリッドで指定されている場合のみ要求した更新を適用します。

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

    パラメーター

    • value: any
    • rowSelector: any

      rowID に対応します。

    返却 void