Wijmo UI for the Web
refresh メソッド
ロードの前に適用するフィルタリング、ソート、およびページングの設定。IDataView の filter/sort プロパティとは異なり、shape パラメーターの各プロパティの形式は IDataView で定義された仕様に従う必要はありません。たとえば、BreezeDataView は shape.filter として Breeze.Predicate を受け入れます。ただし、IDataView のプロパティは IDataView の仕様に違反してはなりません。カスタムフィルタの形式を IDataView の仕様に合わせられない場合は、プロパティの値を関数または null にする必要があります。
サーバーにリクエストが送信されないようにし、ソース配列のフィルタリング/ソート/ページングをクライアント側で適用します。
データビューを再ロードします。
シンタックス
Javascript (Usage) 
var instance; //タイプ:wijmo.data.IEditableDataView;
var value; // Type: IRefreshResult

// パラメータ
var shape; //タイプ: IShape
var local; //タイプ: bool

value = instance.refresh(shape, local);
Javascript (Specification) 
function refresh( 
   shape : IShape,
   local : bool
) : IRefreshResult;

パラメータ

shape
ロードの前に適用するフィルタリング、ソート、およびページングの設定。IDataView の filter/sort プロパティとは異なり、shape パラメーターの各プロパティの形式は IDataView で定義された仕様に従う必要はありません。たとえば、BreezeDataView は shape.filter として Breeze.Predicate を受け入れます。ただし、IDataView のプロパティは IDataView の仕様に違反してはなりません。カスタムフィルタの形式を IDataView の仕様に合わせられない場合は、プロパティの値を関数または null にする必要があります。
local
サーバーにリクエストが送信されないようにし、ソース配列のフィルタリング/ソート/ページングをクライアント側で適用します。

戻り値の型

非同期更新の完了または失敗の通知の受信に使用できる promise オブジェクト。
解説
実装に応じて、データはローカルまたはリモートデータソースからロードできます。 実装によって、IDataView で定義されたフィルタリング/ソート/ページングがデータプロバイダーに固有の形式に変換されます。可能な場合、データはクライアント側で再形成されます。オプションの shape パラメーターを使用して、複数のフィルタリング/ソート/ページング設定を一度に変更して不要な更新を避けることができます。更新の間、isLoading プロパティは true を返す必要があります。更新が成功した後、isLoaded プロパティは true を返す必要があります。このメソッドを呼び出すと、保留中の更新(存在する場合)がキャンセルされます。

関連トピック

参照

IEditableDataView インターフェース

 

 


Copyright © GrapeCity inc. All rights reserved.