QuickGrid<TGridItem> クラス

定義

名前空間:: Microsoft.AspNetCore.Components.QuickGrid

アセンブリ:: Microsoft.AspNetCore.Components.QuickGrid.dll

パッケージ:: Microsoft.AspNetCore.Components.QuickGrid v10.0.0

パッケージ:: Microsoft.AspNetCore.Components.QuickGrid v11.0.0-rc.2.26504.105

パッケージ:: Microsoft.AspNetCore.Components.QuickGrid v8.0.19

パッケージ:: Microsoft.AspNetCore.Components.QuickGrid v9.0.8

ソース:: QuickGrid.razor

ソース:: QuickGrid.razor

ソース:: QuickGrid.razor

ソース:: QuickGrid.razor

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

グリッドを表示するコンポーネント。

[Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")]
public class QuickGrid<TGridItem> : Microsoft.AspNetCore.Components.ComponentBase, IAsyncDisposable

[Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")]
[Microsoft.AspNetCore.Components.CacheBehavior(Microsoft.AspNetCore.Components.CacheBehavior.Throw)]
[Microsoft.AspNetCore.Components.CacheCondition(Microsoft.AspNetCore.Components.CacheVaryBy.Query)]
public class QuickGrid<TGridItem> : Microsoft.AspNetCore.Components.ComponentBase, IAsyncDisposable

[<Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")>]
type QuickGrid<'GridItem> = class
    inherit ComponentBase
    interface IAsyncDisposable

[<Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")>]
[<Microsoft.AspNetCore.Components.CacheBehavior(Microsoft.AspNetCore.Components.CacheBehavior.Throw)>]
[<Microsoft.AspNetCore.Components.CacheCondition(Microsoft.AspNetCore.Components.CacheVaryBy.Query)>]
type QuickGrid<'GridItem> = class
    inherit ComponentBase
    interface IAsyncDisposable

Public Class QuickGrid(Of TGridItem)
Inherits ComponentBase
Implements IAsyncDisposable

型パラメーター

TGridItem

グリッド内の各行によって表されるデータの種類。

継承: Object

ComponentBase
QuickGrid<TGridItem>

属性: CascadingTypeParameterAttribute CacheBehaviorAttribute CacheConditionAttribute

実装: IAsyncDisposable

コンストラクター

Name	説明
QuickGrid<TGridItem>()	QuickGrid<TGridItem>のインスタンスを構築します。

プロパティ

Name	説明
AdditionalAttributes	作成された要素に適用される追加の属性のコレクションを取得または設定します。
AnchorMode	仮想化中に新しい項目が到着したときのリストの端でのビューポートの動作を制御するアンカーモードを取得または設定します。既定値は Start です。これは、 Virtualize が `true`されている場合にのみ有効です。値が等しいセマンティクスを持たない参照型を使用して信頼性の高いアンカーを作成するには、項目が先頭に追加されたか追加されたかをグリッドが検出できるように、 ItemComparer を指定します。
Assets	アプリケーションの ResourceAssetCollection を取得します。 (継承元 ComponentBase)
AssignedRenderMode	このコンポーネントに割り当てられている IComponentRenderMode を取得します。 (継承元 ComponentBase)
ChildContent	このインスタンスの子コンポーネントを定義します。たとえば、 ColumnBase<TGridItem> 基底クラスから派生したコンポーネントを追加することで、列を定義できます。
Class	オプションの CSS クラス名。指定した場合、これはレンダリングされたテーブルのクラス属性に含まれます。
InitialItemIndex	これは、 Virtualizeを使用する場合にのみ適用されます。最初の対話型レンダリング時にスクロールする行の 0 から始まるインデックスを取得または設定します。グリッドが最初にその項目数を認識し、後続の再レンダリングで無視されたときに 1 回適用されます。後でプログラムでスクロールするには、 ScrollToItemAsync(Int32, CancellationToken)を呼び出します。範囲外の値はクランプされます。既定値の `0`は、初期スクロールがないことを意味します。
ItemComparer	データ読み込みの前に項目が追加されたか追加されたかを検出するために仮想化中に使用される比較子を取得または設定します。プロバイダーウィンドウが重なると、比較子は、以前にレンダリングされた項目が同じグローバルインデックスで変更されたかどうかを判断します。これは、アイテムが現在のビューポートの上に挿入されたことを示し、グリッドがビューポートのアンカーを維持できるようにします。アイテムを安定した一意識別子 (主キーなど) で比較する比較子を提供します。既定値は Default です。 IEquatable<T>を実装するレコードと型の場合、既定値は自動的に機能します (値の等価性)。値が等しいセマンティクスを持たない参照型の場合、既定値は参照の等価性にフォールバックします。これは、データソースが読み込み間の新しいインスタンスを返すときに誤検知の先頭に検出を生成します。これは、 Virtualize が `true`されている場合にのみ有効です。
ItemKey	必要に応じて、レンダリングされた各行の @key の値を定義します。通常、これは、データ項目ごとに主キー値などの一意の識別子を指定するために使用する必要があります。これにより、TGridItem インスタンスが新しいコピーに置き換えられた場合 (たとえば、基になるデータストアに対する新しいクエリの後など) でも、行要素とデータ項目の間の関連付けを一意の識別子に基づいて保持できます。設定されていない場合、 @key は TGridItem インスタンス自体になります。
Items	グリッドのクエリ可能なデータソース。これは、 AsQueryable(IEnumerable) 拡張メソッド、EntityFramework DataSet、またはそこから派生した IQueryable を使用して、メモリ内データをクエリ可能に変換できます。 ItemsまたはItemsProviderを指定する必要がありますが、両方は指定しないでください。
ItemSize	これは、 Virtualizeを使用する場合にのみ適用されます。各行の予想される高さをピクセル単位で定義します。これにより、仮想化メカニズムは、表示サイズに合わせて正しい数の項目をフェッチし、正確なスクロールを確保できます。
ItemsProvider	グリッドのデータを提供するコールバック。 ItemsまたはItemsProviderを指定する必要がありますが、両方は指定しないでください。
OnRowClick	オプション。行がクリックされたときに呼び出されるコールバック。
OverscanCount	これは、 Virtualizeを使用する場合にのみ適用されます。スクロール中のレンダリング頻度を減らすために、表示領域の前後にレンダリングされる追加項目の数を定義します。値を大きくすると、画面外に表示する項目が多くなり、スクロールのスムーズさが向上しますが、初期読み込み時間も長くなる可能性があります。データセットのサイズとユーザーエクスペリエンスの要件に基づいてバランスを見つけることをお勧めします。既定値は 3 です。
Pagination	必要に応じて、この QuickGrid<TGridItem> インスタンスを PaginationState モデルにリンクすることで、グリッドは現在のデータページのみをフェッチしてレンダリングします。これは通常、Paginator コンポーネントや、指定された PaginationState インスタンスを表示および更新する他の UI ロジックと組み合わせて使います。
QueryParameterNameOptions	URL でのページの保持、列の並べ替え、並べ替えの方向に使用する QueryParameterNameOptions を指定します。既定では、クエリパラメーターの名前が "page"、"sort"、および "direction" であるインスタンスです。
RendererInfo	コンポーネントが実行されている RendererInfo を取得します。 (継承元 ComponentBase)
RowClass	オプション。 CSS クラスを指定するためにレンダリングされた行ごとに呼び出されるコールバック。
Theme	テーマ名。既定値は "default" です。これは、テーブルに一致するスタイルルールに影響します。
Virtualize	true の場合、グリッドは仮想化でレンダリングされます。通常、これはスクロールと組み合わせて使用され、グリッドは現在のスクロールビューポートの周りのデータのみをフェッチしてレンダリングします。これにより、大規模なデータセットをスクロールするときのパフォーマンスが大幅に向上します。 Virtualizeを使用する場合は、ItemSizeの値を指定し、すべての行が同じ高さでレンダリングされるようにする必要があります。一般に、レンダリングされるデータの量が少ない場合、または改ページ位置を使用している場合は、 Virtualize を使用しないことをお勧めしています。

メソッド

Name	説明
BuildRenderTree(RenderTreeBuilder)	グリッドを表示するコンポーネント。
DispatchExceptionAsync(Exception)	指定された `exception` を、このコンポーネントによってスローされるものとして扱います。これにより、外側の ErrorBoundary が失敗状態に遷移します。外側の ErrorBoundary がない場合は、外側のレンダラーからの例外と見なされます。これは、コンポーネントライフサイクルメソッドの外部で例外が発生したが、コンポーネントライフサイクルメソッドからの例外と同じように処理する場合に便利です。 (継承元 ComponentBase)
DisposeAsync()	グリッドを表示するコンポーネント。
HideColumnOptionsAsync()	以前に表示された ColumnOptions UI を閉じます。
InvokeAsync(Action)	関連付けられたレンダラーの同期コンテキストで、指定された作業項目を実行します。 (継承元 ComponentBase)
InvokeAsync(Func<Task>)	関連付けられたレンダラーの同期コンテキストで、指定された作業項目を実行します。 (継承元 ComponentBase)
OnAfterRender(Boolean)	コンポーネントが対話形式でレンダリングされ、UI の更新が完了するたびに呼び出されるメソッド (たとえば、ブラウザー DOM に要素が追加された後)。 ElementReferenceフィールドは、この実行時までに設定されます。これらのプロセスはライブブラウザー DOM にアタッチされておらず、DOM が更新される前に既に完了しているため、プリレンダリング中またはサーバー側のレンダリング中にこのメソッドは呼び出されません。 (継承元 ComponentBase)
OnAfterRenderAsync(Boolean)	コンポーネントが対話形式でレンダリングされ、UI の更新が完了するたびに呼び出されるメソッド (たとえば、要素がブラウザー DOM に追加された後)。 ElementReferenceフィールドは、この実行時までに設定されます。これらのプロセスはライブブラウザー DOM にアタッチされておらず、DOM が更新される前に既に完了しているため、プリレンダリング中またはサーバー側のレンダリング中にこのメソッドは呼び出されません。コンポーネントは、返された Taskが完了した後に自動的に再レンダリングされないことに注意してください。これは、無限のレンダリングループが発生するためです。
OnInitialized()	コンポーネントを起動する準備ができたときに呼び出されるメソッド。レンダーツリー内の親から初期パラメーターを受け取りました。
OnInitialized()	コンポーネントを起動する準備ができたときに呼び出されるメソッド。レンダーツリー内の親から初期パラメーターを受け取りました。 (継承元 ComponentBase)
OnInitializedAsync()	コンポーネントを起動する準備ができたときに呼び出されるメソッド。レンダーツリー内の親から初期パラメーターを受け取りました。非同期操作を実行し、その操作が完了したときにコンポーネントを更新する場合は、このメソッドをオーバーライドします。 (継承元 ComponentBase)
OnParametersSet()	コンポーネントがレンダーツリー内の親からパラメーターを受け取り、受信値がプロパティに割り当てられているときに呼び出されるメソッド。 (継承元 ComponentBase)
OnParametersSetAsync()	コンポーネントがレンダーツリー内の親からパラメーターを受け取り、受信値がプロパティに割り当てられているときに呼び出されるメソッド。
RefreshDataAsync()	指定されたデータソース ( Items または ItemsProvider) から現在のデータを再フェッチしてレンダリングするようにグリッドに指示します。
ScrollToItemAsync(Int32, CancellationToken)	仮想化されたグリッドをスクロールし、 `itemIndex` の行がスクロール可能領域の一番上に配置されるようにします。 Virtualizeが`true`されている場合にのみ効果があります。
SetParametersAsync(ParameterView)	レンダーツリー内のコンポーネントの親によって提供されるパラメーターを設定します。 (継承元 ComponentBase)
ShouldRender()	コンポーネントをレンダリングするかどうかを示すフラグを返します。 (継承元 ComponentBase)
ShowColumnOptionsAsync(ColumnBase<TGridItem>)	指定した列の ColumnOptions UI を表示し、以前に表示されていたその他の列オプション UI を閉じます。
SortByColumnAsync(ColumnBase<TGridItem>, SortDirection)	グリッドの現在の並べ替え列を、指定した `column`に設定します。
StateHasChanged()	状態が変更されたことをコンポーネントに通知します。該当する場合は、コンポーネントが再レンダリングされます。 (継承元 ComponentBase)

明示的なインターフェイスの実装

Name	説明
IComponent.Attach(RenderHandle)	グリッドを表示するコンポーネント。 (継承元 ComponentBase)
IHandleAfterRender.OnAfterRenderAsync()	グリッドを表示するコンポーネント。 (継承元 ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)	グリッドを表示するコンポーネント。 (継承元 ComponentBase)

適用対象

フィードバック

このページはお役に立ちましたか?