クラス IgxHierarchicalGridBaseDirective

階層

実装

  • DoCheck
  • OnInit
  • OnInit
  • DoCheck
  • OnDestroy
  • AfterContentInit
  • AfterViewInit

コンストラクタ

プロパティ

アクセサー

メソッド

オブジェクト リテラル

コンストラクタ

constructor

プロパティ

_destroyed

_destroyed: boolean = false

advancedFilteringExpressionsTreeChange

advancedFilteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree> = new 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>

cdr

cdr: ChangeDetectorRef

colResizingService

colResizingService: IgxColumnResizingService

columnHidingTitle

columnHidingTitle: string = ""

定義済みの列非表示 UI に表示されるタイトルを取得または設定します。

@例:
<igx-grid [showToolbar]="true" [columnHiding]="true" columnHidingTitle="Column Hiding"></igx-grid>

columnPinningTitle

columnPinningTitle: string = ""

列ピン固定 UI に表示されるタイトルを取得または設定します。

@例:
<igx-grid #grid [data]="localData" [columnPinning]="'true" [columnPinningTitle]="'Column Hiding'" [autoGenerate]="true"></igx-grid>

crudService

crudService: IgxGridCRUDService

data

data: any[]

document

document: any

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>

expandChildren

expandChildren: boolean

filteredData

filteredData: any[]

filteringExpressionsTreeChange

filteringExpressionsTreeChange: EventEmitter<IFilteringExpressionsTree> = new EventEmitter<IFilteringExpressionsTree>()

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

@備考:

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

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

filteringService

filteringService: IgxFilteringService

gridAPI

gridAPI: GridBaseAPIService<IgxGridBaseDirective & GridType>

hasChildrenKey

hasChildrenKey: string

headerCollapseIndicatorTemplate

headerCollapseIndicatorTemplate: TemplateRef<any> = null

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

headerExpandIndicatorTemplate

headerExpandIndicatorTemplate: TemplateRef<any> = null

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

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>

onCellClick

onCellClick: EventEmitter<IGridCellEventArgs> = new EventEmitter<IGridCellEventArgs>()

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

@備考:

IgxGridCellComponent を返します。

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

onCellEdit

onCellEdit: EventEmitter<IGridEditEventArgs> = new EventEmitter<IGridEditEventArgs>()

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

@備考:

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

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

onCellEditCancel

onCellEditCancel: EventEmitter<IGridEditEventArgs> = new EventEmitter<IGridEditEventArgs>()

送信せずに値を編集するときに生成されます。

@備考:

(Esc キーが押された時など) このイベントはキャンセルできます。

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

onCellEditEnter

onCellEditEnter: EventEmitter<IGridEditEventArgs> = new EventEmitter<IGridEditEventArgs>()

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

@備考:

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

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

onColumnInit

onColumnInit: EventEmitter<IgxColumnComponent> = new EventEmitter<IgxColumnComponent>()

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

@備考:

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

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

onColumnMoving

onColumnMoving: EventEmitter<IColumnMovingEventArgs> = new EventEmitter<IColumnMovingEventArgs>()

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

@備考:

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

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

onColumnMovingEnd

onColumnMovingEnd: EventEmitter<IColumnMovingEndEventArgs> = new EventEmitter<IColumnMovingEndEventArgs>()

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

@備考:

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

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

onColumnMovingStart

onColumnMovingStart: EventEmitter<IColumnMovingStartEventArgs> = new EventEmitter<IColumnMovingStartEventArgs>()

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

@備考:

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

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

onColumnPinning

onColumnPinning: EventEmitter<IPinColumnEventArgs> = new EventEmitter<IPinColumnEventArgs>()

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

@備考:

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

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

onColumnResized

onColumnResized: EventEmitter<IColumnResizeEventArgs> = new EventEmitter<IColumnResizeEventArgs>()

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

@備考:

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

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

onColumnSelectionChange

onColumnSelectionChange: EventEmitter<IColumnSelectionEventArgs> = new EventEmitter<IColumnSelectionEventArgs>()

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

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

onColumnVisibilityChanged

onColumnVisibilityChanged: EventEmitter<IColumnVisibilityChangedEventArgs> = new EventEmitter<IColumnVisibilityChangedEventArgs>()

列の表示状態を変更するときに発生されます。

@備考:

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

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

onContextMenu

onContextMenu: EventEmitter<IGridCellEventArgs> = new EventEmitter<IGridCellEventArgs>()

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

@備考:

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

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

onDataPreLoad

onDataPreLoad: EventEmitter<IForOfState> = new EventEmitter<IForOfState>()

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

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

onDensityChanged

onDensityChanged: EventEmitter<IDensityChangedEventArgs> = new EventEmitter<IDensityChangedEventArgs>()

onDoubleClick

onDoubleClick: EventEmitter<IGridCellEventArgs> = new EventEmitter<IGridCellEventArgs>()

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

@備考:

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

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

onFilteringDone

onFilteringDone: EventEmitter<IFilteringExpressionsTree> = new EventEmitter<IFilteringExpressionsTree>()

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

@備考:

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

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

onGridCopy

onGridCopy: EventEmitter<IGridClipboardEvent> = new EventEmitter<IGridClipboardEvent>()

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

@備考:

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

onGridKeydown

onGridKeydown: EventEmitter<IGridKeydownEventArgs> = new EventEmitter<IGridKeydownEventArgs>()

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

@備考:

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

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

onPagingDone

onPagingDone: EventEmitter<IPageEventArgs> = new EventEmitter<IPageEventArgs>()

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

@備考:

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

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

onRangeSelection

onRangeSelection: EventEmitter<GridSelectionRange> = new EventEmitter<GridSelectionRange>()

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

@備考:

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

onRowAdded

onRowAdded: EventEmitter<IRowDataEventArgs> = new EventEmitter<IRowDataEventArgs>()

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

@備考:

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

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

onRowDeleted

onRowDeleted: EventEmitter<IRowDataEventArgs> = new EventEmitter<IRowDataEventArgs>()

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

@備考:

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

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

onRowDragEnd

onRowDragEnd: EventEmitter<IRowDragEndEventArgs> = new EventEmitter<IRowDragEndEventArgs>()

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

@備考:

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

onRowDragStart

onRowDragStart: EventEmitter<IRowDragStartEventArgs> = new EventEmitter<IRowDragStartEventArgs>()

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

@備考:

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

onRowEdit

onRowEdit: EventEmitter<IGridEditEventArgs> = new EventEmitter<IGridEditEventArgs>()

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

@備考:

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

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

onRowEditCancel

onRowEditCancel: EventEmitter<IGridEditEventArgs> = new EventEmitter<IGridEditEventArgs>()

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

@備考:

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

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

onRowEditEnter

onRowEditEnter: EventEmitter<IGridEditEventArgs> = new EventEmitter<IGridEditEventArgs>()

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

@備考:

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

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

onRowPinning

onRowPinning: EventEmitter<IPinRowEventArgs> = new EventEmitter<IPinRowEventArgs>()

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

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

onRowSelectionChange

onRowSelectionChange: EventEmitter<IRowSelectionEventArgs> = new EventEmitter<IRowSelectionEventArgs>()

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

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

onRowToggle

onRowToggle: EventEmitter<IRowToggleEventArgs> = new EventEmitter<IRowToggleEventArgs>()

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

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

onSelection

onSelection: EventEmitter<IGridCellEventArgs> = new EventEmitter<IGridCellEventArgs>()

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

@備考:

IgxGridCellComponent を返します。

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

onSortingDone

onSortingDone: EventEmitter<ISortingExpression | ISortingExpression[]> = new EventEmitter<ISortingExpression | Array<ISortingExpression>>()

並べ替えが UI で実行されたときに発生されます。

@備考:

並べ替え式を返します。

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

onToolbarExporting

onToolbarExporting: EventEmitter<IGridToolbarExportEventArgs> = new EventEmitter<IGridToolbarExportEventArgs>()

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

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

pageChange

pageChange: EventEmitter<number> = new 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>

perPageChange

perPageChange: EventEmitter<number> = new 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>

rootGrid

rootGrid: any

rowCollapsedIndicatorTemplate

rowCollapsedIndicatorTemplate: TemplateRef<any> = null

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

rowExpandedIndicatorTemplate

rowExpandedIndicatorTemplate: TemplateRef<any> = null

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

selectionService

selectionService: IgxGridSelectionService

shouldGenerate

shouldGenerate: boolean

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

@備考:

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

@例:
 this.grid.shouldGenerate = true;

showExpandAll

showExpandAll: boolean = false

sortingExpressionsChange

sortingExpressionsChange: EventEmitter<ISortingExpression[]> = new EventEmitter<ISortingExpression[]>()

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

@備考:

並べ替え式を返します。

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

summaryService

summaryService: IgxGridSummaryService

toolbar

toolbar: IgxGridToolbarComponent = null

IgxToolbarComponent へのアクセスを提供します。

@例:
const gridToolbar = this.grid.toolbar;

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
  • 列非表示 UI が有効かどうかを取得または設定します。

    @備考:

    デフォルトで無効 (false) に設定されます。 UI を操作するには、以下の例のようにツールバーを有効にする必要があります。

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

    返却 boolean

  • 列非表示 UI が有効かどうかを取得または設定します。

    @備考:

    デフォルトで無効 (false) に設定されます。 UI を操作するには、以下の例のようにツールバーを有効にする必要があります。

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

    パラメーター

    • value: boolean

    返却 void

columnPinning

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

columnSelection

columnWidth

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

columns

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

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

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

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

pinnedColumnsText

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

pinnedDataView

  • get pinnedDataView(): any[]

pinnedRowHeight

  • get pinnedRowHeight(): any

pinnedRows

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

selectedCells

showToolbar

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

sortStrategy

sortingExpressions

summaryCalculationMode

summaryPosition

toolbarCustomContentTemplate

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

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

clearSearch

  • clearSearch(): void

clearSort

  • clearSort(name?: string): void

closeAdvancedFilteringDialog

  • closeAdvancedFilteringDialog(applyChanges: boolean): void

collapseAll

  • collapseAll(): void

collapseRow

  • collapseRow(rowID: any): void

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

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

getRowByKey

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

    @備考:

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

    パラメーター

    • デフォルト値 formatters: boolean = false
    • デフォルト値 headers: boolean = false

    返却 any[]

isRecordPinnedByIndex

  • isRecordPinnedByIndex(rowIndex: number): boolean

markForCheck

  • 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

    返却 void

nextPage

  • nextPage(): void

openAdvancedFilteringDialog

  • openAdvancedFilteringDialog(): void

paginate

  • paginate(val: number): void

pinColumn

pinRow

  • pinRow(rowID: any, index?: number): boolean
  • ID によって行をピン固定します。

    @備考:

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

    @例:
    this.grid.pinRow(rowID);

    パラメーター

    • rowID: any

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

    • オプション 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

selectedRows

  • selectedRows(): any[]

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

オブジェクト リテラル

clipboardOptions

clipboardOptions: object

Controls the copy behavior of the grid.

copyFormatters

copyFormatters: boolean = true

Apply the columns formatters (if any) on the data in the clipboard output.

copyHeaders

copyHeaders: boolean = true

Include the columns headers in the clipboard output.

enabled

enabled: boolean = true

Enables/disables the copy behavior

separator

separator: string = " "

The separator used for formatting the copy output. Defaults to \t.