オブジェクトのキーはフィールド名を表し、値はそのデータをどのように型変換するかを示すDataType 値を表します。以下のサンプルコードは、 ODataCollectionView を作成した後、（データベースに文字列として格納されている）'Freight'の値を数値に変換し、さらに3つの日付フィールドを日付に変換します。

import { ODataCollectionView } from '@grapecity/wijmo.odata';
import { DataType } from '@grapecity/wijmo';
const url = 'http://services.odata.org/V4/Northwind/Northwind.svc/';
const orders = new ODataCollectionView(url, 'Orders', {
  dataTypes: {
    Freight: DataType.Number
    OrderDate: DataType.Date,
    RequiredDate: DataType.Date,
    ShippedDate: DataType.Date,
  }
});

このプロパティは、データベースに格納されているデータの書式が一般的な用法に適合していない場合に役立ちます。 inferDataTypes プロパティによってDate値の変換が自動的に処理されるため、ほとんどの場合、データ型に関する情報を提供する必要はありません。 明示的に型情報を提供した場合、inferDataTypes プロパティは適用されません。 そのため、データ型の情報を提供する場合は、Date型のフィールドも含め、 すべてのフィールドの型情報を提供する必要があります。

このプロパティのデフォルト値は falseです。これにより、 データへの変更はデータベースにすぐにコミットされます。

このプロパティを trueに設定すると、 自動的に trackChanges プロパティがtrueに設定されます。 この後、データへの変更（編集、追加、削除など）は追跡されますが、 commitChanges メソッドを呼び出して変更をコミットするか、 cancelChanges メソッドを呼び出して保留中の変更を破棄するまで、 データベースにコミットされません。

以下に例を示します。

import { ODataCollectionView } from '@grapecity/wijmo.odata';

// データソースを作成します
let url = 'https://services.odata.org/...';
let view = new ODataCollectionView(url, 'Categories', {
    keys: [ 'ID' ]
});

// コミットされたコンテンツを延期します
view.deferCommits = true;

// コミット/キャンセル変更ボタンを処理します
let btnCommit = document.getElementById('btn-commit') as HTMLButtonElement,
    btnCancel = document.getElementById('btn-cancel') as HTMLButtonElement;
btnCommit.addEventListener('click', () => view.commitChanges());
btnCancel.addEventListener('click', () => view.cancelChanges());
view.hasPendingChangesChanged.addHandler((s, e) => {
   btnCommit.disabled = btnCancel.disabled = !view.hasPendingChanges;
});

一部のODataサービスでデータを更新する必要があります。詳細について、以下のリンクを参照してください。 http://docs.oasis-open.org/odata/odata-json-format/v4.0/cs01/odata-json-format-v4.0-cs01.html#_Toc365464687。

このプロパティは直接ODataの$expandオプションにマップされます。

たとえば、次のコードは、すべての顧客とその注文をデータベースから取得します。 各顧客エンティティには、注文オブジェクトの配列を含む[Orders]フィールドが含まれています。

import { ODataCollectionView } from '@grapecity/wijmo.odata';
const url = 'http://services.odata.org/V4/Northwind/Northwind.svc/';
const customersOrders = new ODataCollectionView(url, 'Customers', {
  expand: 'Orders'
});

このプロパティがnullまたは空の配列に設定されている場合は、 すべてのフィールドが 取得されます。

たとえば、以下のコードは、データベースの'Categories'テーブルから3つの フィールドのみを取得する ODataCollectionView を作成します。

import { ODataCollectionView } from '@grapecity/wijmo.odata';
const url = 'http://services.odata.org/V4/Northwind/Northwind.svc/';
const categories = new ODataCollectionView(url, 'Categories', {
  fields: ['CategoryID', 'CategoryName', 'Description']
});

フィルタ定義構文については、ODataドキュメントを参照してください。たとえば、以下のコードでは、 'CompanyName'フィールドが'A'で始まり'S'で終わるレコードがサーバーから返されます。

view.filterDefinition = "startswith(CompanyName, 'A') and endswith(CompanyName, 'B')";

フィルタ定義は自動生成することができます。 たとえば、FlexGridFilter コンポーネントは、データソースがODataCollectionView かどうかを検出し、 ODataCollectionView.filter プロパティとODataCollectionView.filterDefinition プロパティの両方を自動的に更新します。 ODataCollectionView.filterDefinition プロパティは、ODataCollectionView.filterOnServer プロパティがfalseに設定されている場合でも 適用されることに注意してください。 これにより、同じコレクションに対してサーバーフィルタとクライアントフィルタの両方を適用でき、 さまざまなシナリオで役立ちます。 たとえば、次のコードは、ODataCollectionView.filterDefinition プロパティを使用してサーバーでフィルタ処理を実行し、 ODataCollectionView.filter プロパティを使用してクライアントでさらにフィルタ処理を実行します。 結果のコレクションには、名前が'C'で始まり、単価が20より大きい項目が表示されます。

import { ODataCollectionView } from '@grapecity/wijmo.odata';
const url = 'http://services.odata.org/V4/Northwind/Northwind.svc/';
const data = new ODataCollectionView(url, 'Products', {
  oDataVersion: 4,
  filterDefinition: 'startswith(ProductName, \'C\')', // server filter
  filterOnServer: false, // client filter
  filter: function(product) {
    return product.UnitPrice > 20;
  },
});

フィルタリングをクライアント側で実行する場合はfilter プロパティを使用し、 サーバー側で実行する場合はfilterDefinition プロパティを使用します。 場合によっては、クライアント側とサーバー側の両方で個別にフィルタを適用したいことがあります。 そのために、（1）filterOnServer プロパティをfalseに設定してfilter プロパティにフィルタ関数を 設定し（これでクライアント側フィルタリングが有効になります）、 （2）filterDefinition プロパティにフィルタ文字列を設定します （これでサーバー側フィルタリングが有効になります）。

このプロパティのデフォルト値は trueです。

詳細については、deferCommits プロパティ、commitChanges および cancelChanges メソッドも参照してください。

ODataCollectionView クラスは、DateオブジェクトをサポートしていないJSON形式を 使用するため、 このプロパティはデフォルトでtrueに設定されます。

dataTypes プロパティを使用して特定のタイプ情報を指定する場合、このプロパティは無効になります。

このプロパティを使用して、進捗状況インジケータを提供できます。

提供されている場合、関数は2つのパラメータ（キーおよび値）があり、 解析された値（元の値と同じ値の場合があります）を返さなければなりません。

reviver関数の詳細については、JSON.parse methodを参照してください。

更新操作（追加/削除/完全削除）にはキーフィールドが必要です。

現在、ODataサービスには1.0～4.0の4つのバージョンがあります。 最新サービスではバージョン4.0が使用されていますが、 レガシーサービスも依然として数多く運用されています。

利用するサービスが実装しているODataのバージョンがわかっている場合は、 ODataCollectionView を作成するときに、 oDataVersion プロパティを適切な値（1～4）に設定します（以下の例を参照）。

import { ODataCollectionView } from '@grapecity/wijmo.odata';
let url = 'https://services.odata.org/Northwind/Northwind.svc';
let categories = new ODataCollectionView(url, 'Categories', {
  oDataVersion: 1.0, // legacy OData source
  fields: ['CategoryID', 'CategoryName', 'Description'],
  sortOnServer: false
});

利用するサービスが実装しているODataのバージョンがわからない場合 （おそらく、 ODataエクスプローラアプリケーションを記述している場合）には、 バージョンは指定しないでください。 その場合、 ODataCollectionView この情報をサーバーから取得します。この操作には追加のリクエストが必要ですが、 サービスURLあたり1回だけなので、オーバーヘッドは大きくありません。

ページングを有効にするには、 pageSize プロパティを使用します。

このプロパティのデフォルト値は true です。

このプロパティは、認証が必要なシナリオでよく使用されます。 次に例を示します。

import { ODataCollectionView } from '@grapecity/wijmo.odata';
const url = 'http://services.odata.org/V4/Northwind/Northwind.svc/';
const categories = new ODataCollectionView(serviceUrl, 'Categories', {
  fields: ['Category_ID', 'Category_Name'],
  requestHeaders: { Authorization: db.token }
});

データのソート方法は sortDescriptions プロパティによって指定します。

このプロパティのデフォルト値は true です。