クラス IgxTreeGridComponent

Ignite UI for Angular Tree Grid - ヘルプ

Ignite UI Tree Grid は統一性のあるテーブルとして書式設定されたスキーマで階層型データを表示および操作し、 並べ替え、フィルタリング、エディティング、列ピン固定、ページング、列移動、非表示など高度な機能を提供します。 例:

<igx-tree-grid [data]="employeeData" primaryKey="employeeID" foreignKey="PID" [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-tree-grid>

階層

実装

  • GridType
  • OnInit
  • AfterViewInit
  • DoCheck
  • AfterContentInit

Index

コンストラクタ

プロパティ

アクセサー

メソッド

コンストラクタ

constructor

  • new IgxTreeGridComponent(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): IgxTreeGridComponent

プロパティ

_destroyed

_destroyed: boolean = false

actionStrip

activeNodeChange

activeNodeChange: EventEmitter<IActiveNodeChangeEventArgs> = ...

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

@例:
<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> = ...

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

@備考:

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

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

cascadeOnDelete

cascadeOnDelete: boolean = true

親が削除されると子レコードも削除されるかどうかを表す @Input プロパティ。 デフォルトで true に設定されて、親とともにすべての子を削除します。

<igx-tree-grid [data]="employeeData" [primaryKey]="'employeeID'" [foreignKey]="'parentID'" cascadeOnDelete="false">
</igx-tree-grid>
@次のメンバー:

IgxTreeGridComponent

cdr

cdr: ChangeDetectorRef

cellClick

cellClick: EventEmitter<IGridCellEventArgs> = ...

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

@備考:

IgxGridCellComponent を返します。

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

cellEdit

cellEdit: EventEmitter<IGridEditEventArgs> = ...

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

@備考:

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

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

cellEditDone

cellEditDone: EventEmitter<IGridEditDoneEventArgs> = ...

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

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

cellEditEnter

cellEditEnter: EventEmitter<IGridEditEventArgs> = ...

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

@備考:

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

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

cellEditExit

cellEditExit: EventEmitter<IGridEditDoneEventArgs> = ...

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

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

childDataKey

childDataKey: any

IgxTreeGridComponent の子データ キーを設定する @Input プロパティ。

<igx-tree-grid #grid [data]="employeeData" [childDataKey]="'employees'" [autoGenerate]="true"></igx-tree-grid>
@次のメンバー:

IgxTreeGridComponent

clipboardOptions

clipboardOptions: object = ...

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

Type declaration

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

colResizingService

colResizingService: IgxColumnResizingService

columnInit

columnInit: EventEmitter<IgxColumnComponent> = ...

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

@備考:

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

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

columnMoving

columnMoving: EventEmitter<IColumnMovingEventArgs> = ...

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

@備考:

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

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

columnMovingEnd

columnMovingEnd: EventEmitter<IColumnMovingEndEventArgs> = ...

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

@備考:

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

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

columnMovingStart

columnMovingStart: EventEmitter<IColumnMovingStartEventArgs> = ...

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

@備考:

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

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

columnPin

columnPin: EventEmitter<IPinColumnCancellableEventArgs> = ...

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

@備考:

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

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

columnPinned

columnPinned: EventEmitter<IPinColumnEventArgs> = ...

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

@備考:

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

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

columnResized

columnResized: EventEmitter<IColumnResizeEventArgs> = ...

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

@備考:

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

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

columnSelected

columnSelected: EventEmitter<IColumnSelectionEventArgs> = ...

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

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

columnVisibilityChanged

columnVisibilityChanged: EventEmitter<IColumnVisibilityChangedEventArgs> = ...

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

@備考:

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

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

columnVisibilityChanging

columnVisibilityChanging: EventEmitter<IColumnVisibilityChangingEventArgs> = ...

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

@備考:

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

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

contextMenu

contextMenu: EventEmitter<IGridCellEventArgs> = ...

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

@備考:

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

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

document

document: any

doubleClick

doubleClick: EventEmitter<IGridCellEventArgs> = ...

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

@備考:

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

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

dragRowID

dragRowID: any = null

ドラッグされている行 ID を取得します。

@備考:

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

emptyFilteredGridTemplate

emptyFilteredGridTemplate: TemplateRef<any>

フィルターされたグリッドが空の場合に表示されるテンプレートのテンプレート参照。

@例:
const emptyTempalte = this.grid.emptyGridTemplate;

emptyGridDefaultTemplate

emptyGridDefaultTemplate: TemplateRef<any>

グリッドが空の場合に表示されるテンプレートのテンプレート参照。

@例:
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'

グリッドですべての偶数の IgxGridRowComponent に適用されるスタイル クラスを取得または設定します。

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

excelStyleHeaderIconTemplate

excelStyleHeaderIconTemplate: TemplateRef<any> = null

行展開インジケーターをレンダリングするときに使用する必要があるカスタム テンプレート (存在する場合)。

filtering

filtering: EventEmitter<IFilteringEventArgs> = ...

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

@備考:

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

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

filteringDone

filteringDone: EventEmitter<IFilteringExpressionsTree> = ...

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

@備考:

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

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

filteringExpressionsTreeChange

filteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree> = ...

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

@備考:

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

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

filteringService

filteringService: IgxFilteringService

foreignKey

foreignKey: any

IgxTreeGridComponent の外部キーを設定する @Input プロパティ。

<igx-tree-grid #grid [data]="employeeData" [primaryKey]="'employeeID'" [foreignKey]="'parentID'" [autoGenerate]="true">
</igx-tree-grid>
@次のメンバー:

IgxTreeGridComponent

gridAPI

gridAPI: GridBaseAPIService<IgxGridBaseDirective & GridType>

gridCopy

gridCopy: EventEmitter<IGridClipboardEvent> = ...

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

@備考:

[clipboardOptions]{@link IgxGridBaseDirective#clipboardOptions} でコピー動作が有効になっている場合にのみ発生します。

gridKeydown

gridKeydown: EventEmitter<IGridKeydownEventArgs> = ...

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

@備考:

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

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

gridScroll

gridScroll: EventEmitter<IGridScrollEventArgs> = ...

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

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

hasChildrenKey

hasChildrenKey: any

行に子があるかどうかを示すキーを設定する @Input プロパティ。 このプロパティは、ロードオンデマンドの場合のみ使用されます。

<igx-tree-grid #grid [data]="employeeData" [primaryKey]="'employeeID'" [foreignKey]="'parentID'"
               [loadChildrenOnDemand]="loadChildren"
               [hasChildrenKey]="'hasEmployees'">
</igx-tree-grid>
@次のメンバー:

IgxTreeGridComponent

headerCollapseIndicatorTemplate

headerCollapseIndicatorTemplate: TemplateRef<any> = null

ヘッダー折りたたみインジケーターをレンダリングするときに使用する必要があるカスタム テンプレート (存在する場合)。

headerExpandIndicatorTemplate

headerExpandIndicatorTemplate: TemplateRef<any> = null

ヘッダー展開インジケーターをレンダリングするときに使用する必要があるカスタム テンプレート (存在する場合)。

id

id: string = ...

id 属性の値を設定する @Input プロパティ。提供されていない場合は、自動的に生成されます。

<igx-tree-grid [id]="'igx-tree-grid-1'"></igx-tree-grid>
@次のメンバー:

IgxTreeGridComponent

loadChildrenOnDemand

loadChildrenOnDemand: function

要求に応じて子行をロードするためのコールバックを提供する @Input プロパティ。

<igx-tree-grid [data]="employeeData" [primaryKey]="'employeeID'" [foreignKey]="'parentID'" [loadChildrenOnDemand]="loadChildren">
</igx-tree-grid>
public loadChildren = (parentID: any, done: (children: any[]) => void) => {
    this.dataService.getData(parentID, children => done(children));
}
@次のメンバー:

IgxTreeGridComponent

Type declaration

    • (parentID: any, done: function): void
    • パラメーター

      • parentID: any
      • done: function
          • (children: any[]): void
          • パラメーター

            • children: any[]

            返却 void

      返却 void

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'

グリッドですべての奇数の IgxGridRowComponent に適用されるスタイル クラスを取得または設定します。

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

onDensityChanged

onDensityChanged: EventEmitter<IDensityChangedEventArgs> = ...

pageChange

pageChange: EventEmitter<number> = ...

現在のページが変更されたときに発生されます。

@例:
<igx-grid (pageChange)="onPageChange($event)"></igx-grid>
public onPageChange(page: number) {
  this.currentPage = page;
}

paginationTemplate

paginationTemplate: TemplateRef<any>

グリッド ページング UI のカスタム ng-template を取得または設定します。

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

pagingDone

pagingDone: EventEmitter<IPageEventArgs> = ...

ページングが実行された後に発生されます。

@備考:

前のページおよび次のページを含むオブジェクトを返します。

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

perPageChange

perPageChange: EventEmitter<number> = ...

グリッドの perPage プロパティ値が変更されたときに発生します。

@例:
<igx-grid #grid (perPageChange)="onPerPageChange($event)" [autoGenerate]="true"></igx-grid>
public onPerPageChange(perPage: number) {
  this.perPage = perPage;
}

primaryKey

primaryKey: any

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

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

processedRecords

processedRecords: Map<any, ITreeGridRecord> = ...

処理済み (フィルターと並べ替え済み) のルートITreeGridRecord の配列のマップを返します。

// primaryKey=2 の処理済みレコードを取得します。
const states = this.grid.processedRecords.get(2);
@次のメンバー:

IgxTreeGridComponent

processedRootRecords

processedRootRecords: ITreeGridRecord[]

処理済み (フィルターと並べ替え済み) のルート ITreeGridRecord の配列を返します。

// index=2 の処理済みルート レコールドを取得します。
const states = this.grid.processedRootRecords[2];
@次のメンバー:

IgxTreeGridComponent

rangeSelected

rangeSelected: EventEmitter<GridSelectionRange> = ...

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

@備考:

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

records

records: Map<any, ITreeGridRecord> = ...

すべての ITreeGridRecord のマップを返します。

// primaryKey=2 のルート レベルを取得します。
const states = this.grid.records.get(2);
@次のメンバー:

IgxTreeGridComponent

rendered

rendered: EventEmitter<boolean> = ...

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

rendered$

rendered$: Observable<boolean> = ...

rootRecords

rootRecords: ITreeGridRecord[]

ITreeGridRecord のルート レベルの配列を返します。

// index=2 のルート レベルを取得します。
const states = this.grid.rootRecords[2];
@次のメンバー:

IgxTreeGridComponent

rowAdded

rowAdded: EventEmitter<IRowDataEventArgs> = ...

行が API によって追加されたときに発生されます。

@備考:

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

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

rowCollapsedIndicatorTemplate

rowCollapsedIndicatorTemplate: TemplateRef<any> = null

行折りたたみインジケーターをレンダリングするときに使用する必要があるカスタム テンプレート (存在する場合)。

rowDeleted

rowDeleted: EventEmitter<IRowDataEventArgs> = ...

行が API によって削除されたときに発生されます。

@備考:

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

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

rowDragEnd

rowDragEnd: EventEmitter<IRowDragEndEventArgs> = ...

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

@備考:

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

rowDragStart

rowDragStart: EventEmitter<IRowDragStartEventArgs> = ...

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

@備考:

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

rowEdit

rowEdit: EventEmitter<IGridEditEventArgs> = ...

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

@備考:

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

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

rowEditDone

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

rowEditEnter: EventEmitter<IGridEditEventArgs> = ...

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

@備考:

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

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

rowEditExit

rowEditExit: EventEmitter<IGridEditDoneEventArgs> = ...

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

@備考:

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

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

rowExpandedIndicatorTemplate

rowExpandedIndicatorTemplate: TemplateRef<any> = null

行展開インジケーターをレンダリングするときに使用する必要があるカスタム テンプレート (存在する場合)。

rowPinning

rowPinning: EventEmitter<IPinRowEventArgs> = ...

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

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

rowSelected

rowSelected: EventEmitter<IRowSelectionEventArgs> = ...

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

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

rowToggle

rowToggle: EventEmitter<IRowToggleEventArgs> = ...

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

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

selected

selected: EventEmitter<IGridCellEventArgs> = ...

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

@備考:

IgxGridCellComponent を返します。

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

selectionService

selectionService: IgxGridSelectionService

shouldGenerate

shouldGenerate: boolean

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

@備考:

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

@例:
 this.grid.shouldGenerate = true;

snackbarDisplayTime

snackbarDisplayTime: number = 6000

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

@備考:

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

sorting

sorting: EventEmitter<ISortingEventArgs> = ...

並べ替え式が適用される前に発生されます。

@備考:

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

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

sortingDone

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

並べ替えが完了した後に発生されます。

@備考:

並べ替え式を返します。

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

sortingExpressionsChange

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

並べ替えが実行された前に発生されます。

@備考:

並べ替え式を返します。

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

summaryService

summaryService: IgxGridSummaryService

toolbarExporting

toolbarExporting: EventEmitter<IGridToolbarExportEventArgs> = ...

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

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

uniqueColumnValuesStrategy

uniqueColumnValuesStrategy: function

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

@備考:

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

@例:
<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
  • IgxGridHeaderGroupComponent の最小許容幅を返します。

    @備考:

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

    返却 number

defaultRowHeight

  • get defaultRowHeight(): number

displayDensity

dragIndicatorIconTemplate

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

emptyFilteredGridMessage

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

emptyGridMessage

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

expansionDepth

  • get expansionDepth(): number
  • set expansionDepth(value: number): void
  • IgxTreeGridComponent で展開されるレベルの数を設定する @Input プロパティ。 デフォルトで Infinity に設定されて、つまりすべてのレベルは展開されます。

    <igx-tree-grid #grid [data]="employeeData" [childDataKey]="'employees'" expansionDepth="1" [autoGenerate]="true"></igx-tree-grid>
    
    @次のメンバー:

    IgxTreeGridComponent

    返却 number

  • IgxTreeGridComponent で展開されるレベルの数を設定する @Input プロパティ。 デフォルトで Infinity に設定されて、つまりすべてのレベルは展開されます。

    <igx-tree-grid #grid [data]="employeeData" [childDataKey]="'employees'" expansionDepth="1" [autoGenerate]="true"></igx-tree-grid>
    

    パラメーター

    • value: number

    返却 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

hasColumnGroups

  • get hasColumnGroups(): boolean

hasColumnLayouts

  • get hasColumnLayouts(): boolean

hasEditableColumns

  • get hasEditableColumns(): boolean

hasFilterableColumns

  • get hasFilterableColumns(): 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

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>

rowLoadingIndicatorTemplate

  • get rowLoadingIndicatorTemplate(): TemplateRef<any>
  • set rowLoadingIndicatorTemplate(value: TemplateRef<any>): void
  • ロードオンデマンドが有効になっているときに行ローディング インジケータのテンプレートを提供する @Input プロパティ。

    ```html <ng-template #rowLoadingTemplate> loop

    <igx-tree-grid #grid [data]="employeeData" [primaryKey]="'ID'" [foreignKey]="'parentID'" [loadChildrenOnDemand]="loadChildren" [rowLoadingIndicatorTemplate]="rowLoadingTemplate"> ```

    @次のメンバー:

    IgxTreeGridComponent

    返却 TemplateRef<any>

  • ロードオンデマンドが有効になっているときに行ローディング インジケータのテンプレートを提供する @Input プロパティ。

    ```html <ng-template #rowLoadingTemplate> loop

    <igx-tree-grid #grid [data]="employeeData" [primaryKey]="'ID'" [foreignKey]="'parentID'" [loadChildrenOnDemand]="loadChildren" [rowLoadingIndicatorTemplate]="rowLoadingTemplate"> ```

    パラメーター

    • value: TemplateRef<any>

    返却 void

rowSelection

selectRowOnClick

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

selectedCells

selectedRows

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

showSummaryOnCollapse

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

    @例:
    <igx-grid #grid [data]="localData" [showSummaryOnCollapse]="true" [autoGenerate]="true"></igx-grid>
    
    @備考:

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

    返却 boolean

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

    パラメーター

    • 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

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, parentRowID?: any): void
  • parentRowID を指定しない場合、新しく作成された行はルート レベルに追加されます。 それ以外の場合、指定された parentRowID と一致する primaryKey を持つ行の子として追加されます。 parentRowID は存在しない場合、エラーを発生します。

    const record = {
        ID: this.grid.data[this.grid1.data.length - 1].ID + 1,
        Name: this.newRecord
    };
    this.grid.addRow(record, 1); // ID = 1 の行に新しい子行を追加します。
    
    @次のメンバー:

    IgxTreeGridComponent

    パラメーター

    • data: any
    • オプション parentRowID: any

    返却 void

clearFilter

  • clearFilter(name?: string): 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
  • プライマリキーによって IgxGridRowComponent および対応するデータ レコードを削除します。

    @備考:

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

    @例:
    this.grid1.deleteRow(0);
    

    パラメーター

    • rowSelector: any

    返却 void

deselectAllColumns

  • deselectAllColumns(): void

deselectAllRows

  • deselectAllRows(onlyFilterData?: boolean): void
  • すべての行を選択解除します。

    @備考:

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

    @例:
    this.grid.deselectAllRows();
    

    パラメーター

    • onlyFilterData: boolean = true

    返却 void

deselectColumns

deselectRows

  • deselectRows(rowIDs: any[]): void

disableSummaries

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

enableSummaries

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

endEdit

  • endEdit(commit?: boolean, event?: Event): void
  • 現在の行の行トランザクションを完成します。

    @備考:

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

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

    パラメーター

    • commit: boolean = true
    • オプション 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
  • グリッドで文字列の次の出現を検索します。表示されていない場合はセルへスクロールします。

    @備考:

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

    @例:
    this.grid.findNext("financial");
    

    パラメーター

    • text: string

      検索する文字列。

    • オプション caseSensitive: boolean

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

    • オプション exactMatch: boolean

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

    返却 number

findPrev

  • findPrev(text: string, caseSensitive?: boolean, exactMatch?: boolean): number
  • グリッドで文字列の前の出現を検索します。表示されていない場合はセルへスクロールします。

    @備考:

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

    @例:
    this.grid.findPrev("financial");
    

    パラメーター

    • text: string

      検索する文字列。

    • オプション caseSensitive: boolean

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

    • オプション exactMatch: boolean

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

    返却 number

getCellByColumn

getCellByColumnVisibleIndex

getCellByKey

getColumnByName

getColumnByVisibleIndex

getDefaultExpandState

getEmptyRecordObjectFor

  • getEmptyRecordObjectFor(rec: any): any

getHeaderGroupWidth

getNextCell

  • getNextCell(currRowIndex: number, curVisibleColIndex: number, callback?: function): ICellPosition
  • 特定の基準に一致する、現在位置に従って次のセルを 定義する ICellPosition を返します。

    @備考:

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

    @例:
     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
  • 特定の基準に一致する、現在位置に従って次のセルを 定義する ICellPosition を返します。

    @備考:

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

    @例:
     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[]
  • 現在の列選択の配列を [{ column.field: cell.value }, ...] の形式で返します。

    @備考:

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

    パラメーター

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

    返却 any[]

getSelectedData

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

isRecordPinnedByIndex

  • isRecordPinnedByIndex(rowIndex: number): boolean

markForCheck

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

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

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

    @例:
    grid.markForCheck();
    

    返却 void

moveColumn

navigateTo

  • navigateTo(rowIndex: number, visibleColIndex?: number, cb?: function): void
  • rowindexvisibleColumnIndex に基づいてグリッド内の位置に移動します。

    @備考:

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

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

ngDoCheck

  • ngDoCheck(): void

openAdvancedFilteringDialog

paginate

  • paginate(val: number): void

pinColumn

pinRow

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

previousPage

  • previousPage(): void

reflow

  • reflow(): void

refreshSearch

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

selectAllColumns

  • selectAllColumns(): void

selectAllRows

  • selectAllRows(onlyFilterData?: boolean): void
  • すべての行を選択します。

    @備考:

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

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

selectedColumns

sort

toggleColumnVisibility

toggleRow

  • toggleRow(rowID: any): void

unpinColumn

unpinRow

  • unpinRow(rowID: any): boolean

updateCell

  • updateCell(value: any, rowSelector: any, column: string): void
  • プライマリキーによって IgxGridRowComponent および対応するデータ レコードを更新します。

    @備考:

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

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

    パラメーター

    • value: any

      設定する新しい値。

    • rowSelector: any

      rowID に対応します。

    • column: string

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

    返却 void

updateRow

  • updateRow(value: any, rowSelector: any): void
  • 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