Infragistics データ ソースのクライアント側コンポーネントはクラスとして実装され、ページング、並べ替え、フィルタリングをサポートします。
JSON、XML、HTML テーブル、WCF/REST サービス、JSONP、JSONP および結合した OData など、各種のデータ ソースに対するバインドをサポートしています。

• aggregateTransactions

  タイプ:

  bool

  デフォルト:

  false

  true に設定した場合、次の動作を実行します:
  新しい行が追加された後に削除された場合、トランザクションはログに追加されません。
  行またはセルが編集された場合、値は元の値に戻され、トランザクションも削除されます。
  注: このオプションは、autoCommit が false に設定される場合のみに適用されます。

  コード サンプル

  var ds = new $.ig.XmlDataSource({     aggregateTransactions: true,     dataSource: arrayOfObjects });

• autoCommit

  タイプ:

  bool

  デフォルト:

  false

  自動コミットが True の場合、saveChanges() によって値または値の組が更新されると、データは自動的にデータ ソースにコミットされます。

  コード サンプル

  var ds = new $.ig.XmlDataSource({     autoCommit: true });

• callback

  タイプ:

  function

  デフォルト:

  null

  データ バインドの完了時に呼び出すコールバック関数。

  コード サンプル

  var render = function (success, error) {     if (success) {         alert("success");     } else {         alert(error);     } }   $(window).load(function () {     var url = "http://odata.netflix.com/Catalog/Titles?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         type: "remoteUrl",         callback: render,         dataSource: url,         schema: oDataSchema,         responseDataKey : "d.results",         responseDataType: "jsonp",     });     ds.dataBind(); });

• callee

  タイプ:

  object

  デフォルト:

  null

  コールバック関数を呼び出す対象となるオブジェクト。

  コード サンプル

  var Bob = {     name: "Bob",     greet: function () {         alert("Hi, I'm " + this.name);     } };   var products = []; products[0] = {     "ProductID": 1,     "Name": "Adjustable Race",     "ProductNumber": "AR-5381" }; products[1] = {     "ProductID": 2,     "Name": "Bearing Ball",     "ProductNumber": "BA-8327" };   var ds;   $(document).ready(function () {     ds = new $.ig.XmlDataSource({         dataSource: products,         callee: Bob,         callback: Bob.greet     });       ds.dataBind(); });

• data

  タイプ:

  array

  デフォルト:

  []

  要素タイプ:

  object

  これは、データ ソースからフェッチされた後の正規化された (変換された) 結果データです。

  コード サンプル

  var ds = new $.ig.XmlDataSource({     data: normalizedArrayOfObjects });

• dataBinding

  タイプ:

  object

  デフォルト:

  null

  クライアント側の dataBinding イベント。関数名を指す文字列または関数を指すオブジェクトが可能です。

  コード サンプル

  var myDataBinding = function () {     alert("myDataBinding"); }   var products = []; products[0] = {     "ProductID": 1,     "Name": "Adjustable Race",     "ProductNumber": "AR-5381" }; products[1] = {     "ProductID": 2,     "Name": "Bearing Ball",     "ProductNumber": "BA-8327" };   var ds;   $(window).ready(function () {     ds = new $.ig.XmlDataSource({         dataBinding: myDataBinding,         dataSource: products     }); });

• dataBound

  タイプ:

  object

  デフォルト:

  null

  クライアント側の dataBound イベント。関数名を指す文字列または関数を指すオブジェクトが可能です。

  コード サンプル

  var myDataBound = function () {     alert("myDataBound"); }   var products = []; products[0] = {     "ProductID": 1,     "Name": "Adjustable Race",     "ProductNumber": "AR-5381" }; products[1] = {     "ProductID": 2,     "Name": "Bearing Ball",     "ProductNumber": "BA-8327" };   var ds;   $(window).ready(function () {     ds = new $.ig.XmlDataSource({         dataBound: myDataBound     });       ds.dataBind();   });

• dataSource

  タイプ:

  object

  デフォルト:

  null

  これはデータのソースです。正規化されていません。配列、JSON オブジェクトへの参照、HTML テーブルの DOM 要素、または関数が可能です。

  コード サンプル

  var jsonSchema = new $.ig.DataSchema("json", {fields:[     {name: "ProductID", type: "number"},     {name: "Name", type: "string"},     {name: "ProductNumber", type: "string"},     {name: "Color", type: "string"},     {name: "StandardCost", type: "string"}],     searchField:"Records" });   ds = new $.ig.XmlDataSource({type: "json", dataSource: jsonData, schema: jsonSchema}); ds.dataBind();

• fields

  非推奨

  タイプ:

  array

  デフォルト:

  []

  要素タイプ:

  object

  *** 重要な注意: オプションは非推奨です ***
  データ ソースのスキーマを指定するフィールド定義のリスト。
  フィールド オブジェクトの説明: {name, [type], [xpath]}。

  コード サンプル

  var products = []; products[0] = {     "ProductID": 1,     "Name": "Adjustable Race",     "ProductNumber": "AR-5381" }; products[1] = {     "ProductID": 2,     "Name": "Bearing Ball",     "ProductNumber": "BA-8327" };   var ds; $(window).ready(function () {       ds = new $.ig.XmlDataSource({         dataSource: products,         fields: [{             name: "ProductID",             type: "number"         }, {             name: "Name",             type: "string"         }, {             name: "ProductNumber",             type: "string"         }]     });       ds.dataBind(); });

• filtering

  タイプ:

  object

  デフォルト:

  {}

  組み込みのフィルタリング機能に関連する設定。

  コード サンプル

  jsonDs = new $.ig.XmlDataSource( {     filtering: {         type: "local",         caseSensitive: true,         applyToAllData: true     },     dataSource: jsonData }).dataBind();

  • applyToAllData

    タイプ:

    bool

    デフォルト:

    true

    ページング、並べ替え、またはフィルタリングのタイプがローカルの場合、applyToAllData が True であると、ローカルに存在するデータ ソース全体に対してフィルタリングが実行されます。そうでない場合は、現在の dataView に対してのみ実行されます。タイプがリモートの場合、この設定は効果がありません。

    コード サンプル

    jsonDs = new $.ig.XmlDataSource( {     filtering: {         type: "local",         caseSensitive: true,         applyToAllData: true     },     dataSource: jsonData }).dataBind();

  • caseSensitive

    タイプ:

    bool

    デフォルト:

    false

    データの大文字と小文字を区別するフィルタリングを有効または無効にします。ローカルのフィルタリングでのみ機能します。

    コード サンプル

    jsonDs = new $.ig.XmlDataSource( {     filtering: {         type: "local",         caseSensitive: true,         applyToAllData: true     },     dataSource: jsonData }).dataBind();

  • customConditions

    タイプ:

    object

    デフォルト:

    null

    定義されるカスタム フィルター条件をオブジェクトとして含むオブジェクト。

    コード サンプル

    jsonDs = new $.ig.DataSource( {     filtering: {         type: "local",         caseSensitive: true,         applyToAllData: true,         customConditions: [             BE: {             labelText: "BE",             expressionText: "BE-####",             requireExpr: false,             filterFunc: filterProductNumber             },             CA: {                 labelText: "CA",                 expressionText: "CA-####",                 requireExpr: false,                 filterFunc: filterProductNumber1             }         ]     },     dataSource: jsonData }).dataBind() function filterProductNumber(value, expression, dataType, ignoreCase, preciseDateFormat) {     return value.startsWith("BE"); } function filterProductNumber1(value, expression, dataType, ignoreCase, preciseDateFormat) {     return value.startsWith("CA"); }

  • customFunc

    タイプ:

    object

    デフォルト:

    null

    文字列または関数オブジェクトを指すことができます。渡されるパラメーターは、1) フィルタリングされるデータ配列、2) フィルタリングの式定義です。フィルターされたデータの配列を返します。

    コード サンプル

    var ds;   var render = function (success, error) {     if (success) {         var expr = "Cr";         cond = "startsWith";           ds.filter([{             fieldName: "Name",             expr: expr,             cond: cond         }], true);           var template = "<tr><td>${Name}</td><td>${Price}</td><td>${Rating}</td></tr>",         resultHtml = $.ig.tmpl(template, ds.dataView());         $("#table").html(resultHtml);     } else {         alert(error);     } }     var myCustomFunc = function (fieldExpression, data) {     var result = [];     result[0] = data[0];     return result; }   $(window).load(function () {     var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         callback: render,         dataSource: url,         schema: {             fields: [{                 name: "Name"             }, {                 name: "Price"             }, {                 name: "Rating"             }],             searchField: "d"         },         responseDataKey: "d",         responseDataType: "jsonp",         filtering: {             type: "remote",             customFunc: myCustomFunc         }     });     ds.dataBind();   });

  • defaultFields

    タイプ:

    array

    デフォルト:

    []

    要素タイプ:

    object

    データは dataBind() のすぐ後で予めフィルターされます。

    コード サンプル

    $(window).load(function () {     var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         callback: render,         dataSource: url,         schema: {             fields: [{                 name: "Name"             }, {                 name: "Price"             }, {                 name: "Rating"             }],             searchField: "d"         },         responseDataKey: "d",         responseDataType: "jsonp",         filtering: {             type: "remote",             defaultFields: [{                 fieldName: "Price",                 cond:"GreaterThan",                 expr: 20             }]         }     });     ds.dataBind(); });

  • expressions

    タイプ:

    array

    デフォルト:

    []

    要素タイプ:

    object

    式オブジェクトのリスト。以下のキーと値のペアが含まれます: fieldName、式 (検索文字列)、条件、ロジック (AND/OR)。

    コード サンプル

    var url = "/demos/server/proxy.php?url=http://services.odata.org/OData/OData.svc/Products?$format=json"; ds = new $.ig.XmlDataSource({     callback:render,     dataSource: url,     localSchemaTransform: false,     responseDataKey: "d",     filtering: {         expressions:[             {                 fieldName: "Price",                 cond:"GreaterThan",                 expr: 20             }         ]     },     schema: {         fields: [             {name : "Price"},             {name : "Name"},             {name: "Rating"}         ],         searchField: "d"     } });   ds.dataBind();

  • exprString

    タイプ:

    string

    デフォルト:

    ""

    SQL のようなエンコードされた式文字列。「expressions」より優先があります。例: col2 > 100; col2 LIKE %test%。

    コード サンプル

    var render = function (success, error) {     if (success) {         var template = "<tr><td>${Name}</td><td>${Price}</td><td>${Rating}</td></tr>",         resultHtml = $.ig.tmpl(template, ds.dataView());         $("#table").html(resultHtml);     } else {         alert(error);     } }   var ds;   $(window).load(function () {     var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         callback: render,         dataSource: url,         schema: {             fields: [{                 name: "Name"             }, {                 name: "Price"             }, {                 name: "Rating"             }],             searchField: "d"         },         responseDataKey: "d",         responseDataType: "jsonp",         filtering: {             type: "remote",             exprString: "Name LIKE Cr%"         }     });     ds.dataBind(); });

  • filterExprUrlKey

    タイプ:

    string

    デフォルト:

    null

    リモート フィルタリングが実行される場合に、要求の中でエンコードされる URL キー。デフォルト null は OData スタイルの URL エンコードを意味します。詳細は http://www.odata.org/developers/protocols/uri-conventions を参照してください。

    コード サンプル

    var render = function (success, error) {     if (success) {         var template = "<tr><td>${Name}</td><td>${Price}</td><td>${Rating}</td></tr>",         resultHtml = $.ig.tmpl(template, ds.dataView());         $("#table").html(resultHtml);     } else {         alert(error);     } }   var ds;   $(window).load(function () {     var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         callback: render,         dataSource: url,         schema: {             fields: [{                 name: "Name"             }, {                 name: "Price"             }, {                 name: "Rating"             }],             searchField: "d"         },         responseDataKey: "d",         responseDataType: "jsonp",         filtering: {             type: "remote",             filterExprUrlKey: "filter",             expressions: [{                 fieldName: "Name",                 cond: "Contains",                 expr: "Cr"             }]         }     });     ds.dataBind(); });

  • filterLogicUrlKey

    タイプ:

    string

    デフォルト:

    "filterLogic"

    フィルタリング ロジックが AND か OR かどうかを示す、要求の中でエンコードされる URL キー。

    コード サンプル

    var render = function (success, error) {     if (success) {         var template = "<tr><td>${Name}</td><td>${Price}</td><td>${Rating}</td></tr>",         resultHtml = $.ig.tmpl(template, ds.dataView());         $("#table").html(resultHtml);     } else {         alert(error);     } }   var ds;   $(window).load(function () {     var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         callback: render,         dataSource: url,         schema: {             fields: [{                 name: "Name"             }, {                 name: "Price"             }, {                 name: "Rating"             }],             searchField: "d"         },         responseDataKey: "d",         responseDataType: "jsonp",         filtering: {             type: "remote",             filterLogicUrlKey: "testFilterLogicUrlKey",             expressions: [{                 fieldName: "Name",                 cond: "Contains",                 expr: "Cr",                 logic: "OR"             }]         }     });     ds.dataBind(); });

  • type

    タイプ:

    enumeration

    デフォルト:

    remote

    フィルタリング タイプ。

    メンバー

    • remote
    • タイプ:string
    • パラメーターはエンコードされ、バックエンド次第で応答から解釈されます。
    • local
    • タイプ:string
    • データは自動的にクライアント側でフィルターされます。

    コード サンプル

    jsonDs = new $.ig.XmlDataSource( {                filtering: {                    type: "local",                    caseSensitive: true,                    applyToAllData: true                },                dataSource: jsonData                       }).dataBind();

• groupby

  タイプ:

  object

  デフォルト:

  {}

  組み込みのグループ化機能に関連する設定。

  コード サンプル

  ds = new $.ig.XmlDataSource({     dataSource: products,     groupby: {         defaultCollapseState: true     } });   ds.dataBind();

  • defaultCollapseState

    タイプ:

    bool

    デフォルト:

    false

    デフォルトの縮小状態。

    コード サンプル

    ds = new $.ig.XmlDataSource({     dataSource: products,     groupby: {         defaultCollapseState: true     } });

  • groupRecordKey

    タイプ:

    string

    デフォルト:

    "__gbRecord"

    グループ データ ビューからのレコードがグループ レコードかどうかを決定するプロパティの名前。

    コード サンプル

    ds = new $.ig.XmlDataSource({     dataSource: products,     groupby: {         groupRecordKey: "__gbRecord"     } });

  • groupSummaryRecordKey

    タイプ:

    string

    デフォルト:

    "__gbSummaryRecord"

    グループ データ ビューからのレコードが集計グループ レコードかどうかを決定するプロパティの名前。

    コード サンプル

    ds = new $.ig.XmlDataSource({     dataSource: products,     groupby: {         groupRecordKey: "__gbRecord"     } });

  • pagingMode

    タイプ:

    enumeration

    デフォルト:

    allRecords

    グループ化された列が 1 つ以上ある場合、ページングの適用方法を指定します。

    メンバー

    • allRecords
    • タイプ:string
    • ページングは、データおよびグループ化レコードなどのデータ以外のレコードを含むすべてのレコードに適用されます。
    • dataRecordsOnly
    • タイプ:string
    • ページングがデータ レコードのみに適用されます。データ以外のレコードはページング計算で無視されます。

    コード サンプル

    ds = new $.ig.XmlDataSource({     dataSource: products,     groupby: {         pagingMode: "allRecords"     } });

  • summaries

    タイプ:

    array

    デフォルト:

    []

    要素タイプ:

    object

    各フィールドの集計を含むオブジェクトの配列。
    各集計オブジェクトに次の形式があります。{ field:"fieldName", summaryFunctions: [] }。summaryFunctions 配列が集計名 (avg、sum、count など) を含む、またはカスタム集計を計算するためのカスタム関数を含みます。

    コード サンプル

    ds = new $.ig.XmlDataSource({     dataSource: data,     groupby: {         summaries: [         {             field:"Age",             summaryFunctions: ["avg","sum"]         },         {             field: "Name",             summaryFunctions: ["count", customFunc]         }]     } });

  • summariesPosition

    タイプ:

    enumeration

    デフォルト:

    bottom

    各グループで各フィールドの集計位置を指定します。

    メンバー

    • top
    • タイプ:string
    • 各グループの上部に集計行が 1 行表示されます。
    • bottom
    • タイプ:string
    • 各グループの下部に集計行が 1 行表示されます。
    • both
    • タイプ:string
    • 各グループに集計行が 2 行表示されます。上部および下部にも表示されます。

    コード サンプル

    ds = new $.ig.XmlDataSource({     dataSource: data,     groupby: {         summariesPosition: "top",         summaries: [         {             field:"Age",             summaryFunctions: ["avg","sum"]         },         {             field: "Name",             summaryFunctions: ["count", customFunc]         }]     } });

• id

  タイプ:

  string

  デフォルト:

  "ds"

  これを設定する必要があるのは、データ ソースが文字列形式でテーブルに設定される場合だけです。非表示のダミー データ コンテナーを本文中に作成し、テーブル データをそれに追加する必要があります。

  コード サンプル

  var ds = $.ig.DataSource({     id: "myId" });

• localSchemaTransform

  タイプ:

  bool

  デフォルト:

  true

  False に設定すると、JavaScript コード内でローカルに定義されている場合でもスキーマの変換が無効になります。

  コード サンプル

  var url = "/demos/server/proxy.php?url=http://services.odata.org/OData/OData.svc/Products?$format=json"; ds = new $.ig.XmlDataSource({     callback:render,     dataSource: url,     localSchemaTransform: false,     responseDataKey: "d",     schema: {fields: [         {name : "Price"},         {name : "Name"},         {name: "Rating"}     ]} });   ds.dataBind();

• outputResultsName

  タイプ:

  string

  デフォルト:

  null

  これは、実際の結果レコードが配置される dataView 内のプロパティです。(つまり、これが定義される場合、dataView は配列ではなくオブジェクトです)、潜在的なデータ ソース変換の後。

  コード サンプル

  var render = function (success, error) {     if (success) {         var template = "<tr><td>${Name}</td><td>${Price}</td><td>${Rating}</td></tr>",         resultHtml = $.ig.tmpl(template, ds.dataView());         $("#table").html(resultHtml);     } else {         alert(error);     } } var ds; $(window).load(function () {     var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         callback: render,         dataSource: url,         schema: {             fields: [{                 name: "Name"             }, {                 name: "Price"             }, {                 name: "Rating"             }],             searchField: "d"         },         responseDataKey: "d",         responseDataType: "jsonp",         outputResultsName: "myOutputResultsName"     });     ds.dataBind(); });

• paging

  タイプ:

  object

  デフォルト:

  {}

  組み込みのページング機能に関連する設定。

  コード サンプル

  $(window).load(function () {     ds = new $.ig.XmlDataSource({         type: "json",         dataSource: adventureWorks,         responseDataKey: "Records",         paging: {             enabled : true,             pageSize:10,             type: "local"         }     });       ds.dataBind(); });

  • appendPage

    タイプ:

    bool

    デフォルト:

    false

    データの新しいページが要求される場合、新しいデータを依存のデータに追加するかどうかを決定します。

    コード サンプル

    var ds = new $.ig.XmlDataSource({     dataSource: products,     paging: {         enabled: true,         appendPage : true     } });

  • enabled

    タイプ:

    bool

    デフォルト:

    false

    ページングはデフォルトで有効ではありません。

    コード サンプル

    ds = new $.ig.XmlDataSource({     type: "json",     dataSource: adventureWorks,     responseDataKey: "Records",     paging: {         enabled : true,         pageSize:10,         type: "local"     } });

  • pageIndex

    タイプ:

    number

    デフォルト:

    0

    現在のページのインデックスです。

    コード サンプル

    ds = new $.ig.XmlDataSource({     type: "json",     dataSource: adventureWorks,     responseDataKey: "Records",     schema: jsonSchema,     paging:     {         enabled : true,         pageSize:10,         type: "local",         pageIndex: 2     } }); ds.dataBind();

  • pageIndexUrlKey

    タイプ:

    string

    デフォルト:

    null

    現在要求されているページ インデックスを説明するエンコードされた URL パラメーターの名前を示します。

    コード サンプル

    var ds = new $.ig.XmlDataSource({     type: "json",     dataSource: adventureWorks,     responseDataKey: "Records",     paging: {         enabled: true,         pageSize: 10,         pageIndex: 2,         pageIndexUrlKey: "myPageIndexUrlKey",         type: "local"     } });

  • pageSize

    タイプ:

    number

    デフォルト:

    5

    各ページのレコード数。

    コード サンプル

    ds = new $.ig.XmlDataSource({     type: "json",     dataSource: adventureWorks,     responseDataKey: "Records",     paging: {         enabled : true,         pageSize:10,         type: "local"     } });

  • pageSizeUrlKey

    タイプ:

    string

    デフォルト:

    null

    現在要求されているページ サイズを説明するエンコードされた URL パラメーターの名前を示します。

    コード サンプル

    var ds = new $.ig.XmlDataSource({     type: "json",     dataSource: adventureWorks,     responseDataKey: "Records",     paging: {         enabled: true,         pageSize: 10,         pageSizeUrlKey: "myPageSizeUrlKey",         type: "local"     } });

  • type

    タイプ:

    enumeration

    デフォルト:

    remote

    ページング操作のタイプ。

    メンバー

    • local
    • タイプ:string
    • データはクライアント側でページングされます。
    • remote
    • タイプ:string
    • リモート要求が完了し、URL パラメーターがエンコードされました。

    コード サンプル

    jsonDs = new $.ig.XmlDataSource( {     filtering: {         type: "local",         caseSensitive: true,         applyToAllData: true     },     dataSource: jsonData }).dataBind();

• primaryKey

  タイプ:

  string

  デフォルト:

  null

  一意のフィールド識別子。

  コード サンプル

  $(window).load(function () {     ds = new $.ig.XmlDataSource({         primaryKey: "CustomerID",         type: "json",         dataSource: adventureWorks,         responseDataKey: "Records",     });       ds.dataBind(); });

• requestType

  タイプ:

  string

  デフォルト:

  "GET"

  要求を送信する HTTP 動詞を指定します。

  コード サンプル

  $(window).load(function () {     ds = new $.ig.XmlDataSource({         primaryKey: "CustomerID",         requestType: "get",         dataSource: "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?",         responseDataKey: "Records",     });       ds.dataBind(); });

• responseContentType

  タイプ:

  string

  デフォルト:

  null

  応答のコンテンツ タイプ。http://api.jquery.com/jQuery.ajax/ => contentType を参照してください。

  コード サンプル

  var ds = new $.ig.XmlDataSource({     type: "json",     dataSource: adventureWorks,     responseDataKey: "Records",     responseContentType: "application/x-www-form-urlencoded; charset=UTF8;" });

• responseDataKey

  タイプ:

  string

  デフォルト:

  null

  データ レコード配列を保持する場所を指定する応答内のプロパティ (応答がラップされる場合)。

  コード サンプル

  var url = "http://odata.netflix.com/Catalog/Titles?$format=json&$callback=?"; var jsonp = new $.ig.XmlDataSource({     type: "json",     dataSource: url,     responseDataKey: "d.results" });

• responseDataType

  タイプ:

  enumeration

  デフォルト:

  null

  URL がデータ ソースとして設定された場合の応答タイプ。http://api.jquery.com/jQuery.ajax/ => dataType を参照してください。

  メンバー

  • json
  • タイプ:string
  • xml
  • タイプ:string
  • html
  • タイプ:string
  • script
  • タイプ:string
  • jsonp
  • タイプ:string
  • text
  • タイプ:string

  コード サンプル

  var render = function (success, error) {     if (success) {         alert("success");     } else {         alert(error);     } } $(window).load(function () {     var url = "http://odata.netflix.com/Catalog/Titles?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         type: "remoteUrl",         callback: render,         dataSource: url,         schema: oDataSchema,         responseDataKey: "d.results",         responseDataType: "jsonp",     });     ds.dataBind(); });

• responseTotalRecCountKey

  タイプ:

  string

  デフォルト:

  null

  バックエンド内のレコードの総数を指定する応答内のプロパティ (ページングに必要です)。

  コード サンプル

  var ds = new $.ig.XmlDataSource({     type: "json",     dataSource: adventureWorks,     responseDataKey: "Records",     responseTotalRecCountKey: "1024" });

• rowAdded

  タイプ:

  function

  デフォルト:

  null

  行が追加されたときに呼び出される関数。
  関数は最初の引数に項目を、2 番目の引数に dataSource を取ります。
  item.row を使用して、追加された行への参照を取得します。
  item.rowId を使用して、行 ID を取得します。
  dataSource を使用して、$.ig.DataSource への参照を取得します。

  コード サンプル

  $.ig.DataSource({     rowAdded: function (item, dataSource) {…} });

• rowDeleted

  タイプ:

  function

  デフォルト:

  null

  行が削除されたときに呼び出される関数。
  item.row を使用して、削除された行への参照を取得します。
  item.rowId を使用して、行 ID を取得します。
  item.rowIndex を使用して、行インデックスを取得します。
  dataSource を使用して、$.ig.DataSource への参照を取得します。

  コード サンプル

  $.ig.DataSource({     rowDeleted: function (item, dataSource) {…} });

• rowInserted

  タイプ:

  function

  デフォルト:

  null

  行が挿入されたときに呼び出される関数。
  関数は最初の引数に項目を、2 番目の引数に dataSource を取ります。
  item.row を使用して、挿入された行への参照を取得します。
  item.rowId を使用して、行 ID を取得します。
  item.rowIndex を使用して、行インデックスを取得します。
  dataSource を使用して、$.ig.DataSource への参照を取得します。

  コード サンプル

  $.ig.DataSource({     rowInserted: function (item, dataSource) {…} });

• rowUpdated

  タイプ:

  function

  デフォルト:

  null

  行が更新 (編集) されたときに呼び出される関数。
  関数は最初の引数に項目を、2 番目の引数に dataSource を取ります。
  item.rowIndex を使用して、行インデックスを取得します。
  item.newRow を使用して、更新された行への参照を取得します。
  item.oldRow を使用して、更新された行への参照を取得します。
  dataSource を使用して、$.ig.DataSource への参照を取得します。

  コード サンプル

  $.ig.DataSource({     rowUpdated: function (item, dataSource) {…} });

• schema

  タイプ:

  object

  デフォルト:

  null

  データのどのフィールドにバインドするかを定義するスキーマ オブジェクト。

  コード サンプル

  var jsonSchema = new $.ig.DataSchema("json", {fields:[     {name: "ProductID", type: "number"},     {name: "Name", type: "string"},     {name: "ProductNumber", type: "string"},     {name: "Color", type: "string"},     {name: "StandardCost", type: "string"}],     searchField:"Records" });   ds = new $.ig.XmlDataSource({     type: "json",     dataSource: jsonData,     schema: jsonSchema }); ds.dataBind();

• serializeTransactionLog

  タイプ:

  bool

  デフォルト:

  true

  True の場合、リモート要求によってコミットが実行されると、更新された値のトランザクション ログ (もしあれば) を必ずシリアル化します。

  コード サンプル

  $.ig.DataSource({     serializeTransactionLog: false });

• sorting

  タイプ:

  object

  デフォルト:

  {}

  組み込みの並べ替え機能に関連する設定。

  コード サンプル

  $(window).load(function () {     ds = new $.ig.XmlDataSource({         type: "json",         dataSource: adventureWorks,         sorting: {             type: "local",             caseSensitive: true         }     });       ds.dataBind(); });

  • applyToAllData

    タイプ:

    bool

    デフォルト:

    true

    並べ替えタイプがローカルの場合、applyToAllData が True であると、並べ替えは、ローカルに存在するデータ ソース全体に対して実行されます。そうでない場合は、現在の dataView に対して実行されます。並べ替えのタイプがリモートの場合、この設定は効果がありません。

    コード サンプル

    jsonDs = new $.ig.XmlDataSource({     sorting: {         type: "local",         applyToAllData: true     },     dataSource: jsonData }).dataBind();

  • caseSensitive

    タイプ:

    bool

    デフォルト:

    false

    並べ替えが大文字と小文字を区別するかどうかを指定します。ローカルの並べ替えでのみ操作します。

    コード サンプル

    $(window).load(function () {     ds = new $.ig.XmlDataSource({         type: "json",         dataSource: adventureWorks,         sorting: {             type: "local",             caseSensitive: true         }     });       ds.dataBind(); });

  • compareFunc

    タイプ:

    object

    デフォルト:

    null

    カスタムの比較並べ替え関数。次の引数を受けとります: フィールド、スキーマ、並べ替えが昇順かどうかを示すブール値、変換関数 (customConvertFunc オプションを確認する必要があります)。値が等しい場合、値 0 を返します。val1 > val2 の場合、値 0 を返します。val1 < val2 の場合、値 -1 を返します。

    コード サンプル

    var render = function (success, error) {     if (success) {         var template = "<tr><td>${Name}</td><td>${Price}</td><td>${Rating}</td></tr>",         resultHtml = $.ig.tmpl(template, ds.dataView());         $("#table").html(resultHtml);     } else {         alert(error);     } }   var myCompareFunc = function (fields, schema, reverse, convertf) {     return function (val1, val2) {         if (val1.Price > val2.Price) {             return 1;         }           if (val1.Price < val2.Price) {             return -1;         }           return 0;     } }   var ds; $(window).load(function () {     var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         callback: render,         dataSource: url,         schema: {             fields: [{                 name: "Name"             }, {                 name: "Price"             }, {                 name: "Rating"             }],             searchField: "d"         },         responseDataKey: "d",         responseDataType: "jsonp",         sorting: {             type: "local",             compareFunc: myCompareFunc,             defaultFields: [{                 fieldName: "Price"             }]         }     });     ds.dataBind(); });

  • customConvertFunc

    タイプ:

    object

    デフォルト:

    null

    カスタム データ値の変換関数 (並べ替え関数から呼び出されます)。データ セルの値および列キーを受け取り、変換された値を返します。

    コード サンプル

    var render = function (success, error) {         if (success) {             var template = "<tr><td>${Name}</td><td>${Price}</td><td>${Rating}</td></tr>",             resultHtml = $.ig.tmpl(template, ds.dataView());             $("#table").html(resultHtml);         } else {             alert(error);         }     }       var myCompareFunc = function (fields, schema, reverse, convertf) {         return function (obj1, obj2) {             a = convertf(obj1);             b = convertf(obj2);               if (a > b) {                 return 1;             }               if (a < b) {                 return -1;             }               return 0;         }     }   var myCustomConvertFunc = function (obj) {         return obj.Price;     }       var ds;     $(window).load(function () {         var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";         ds = new $.ig.XmlDataSource({             callback: render,             dataSource: url,             schema: {                 fields: [{                     name: "Name"                 }, {                     name: "Price"                 }, {                     name: "Rating"                 }],                 searchField: "d"             },             responseDataKey: "d",             responseDataType: "jsonp",             sorting: {                 type: "local",                 compareFunc: myCompareFunc,                 customConvertFunc: myCustomConvertFunc,                 defaultFields: [{                     fieldName: "Price"                 }]             }         });         ds.dataBind();     });

  • customFunc

    タイプ:

    object

    デフォルト:

    null

    文字列または関数オブジェクトを指すことができるカスタムの並べ替え関数。関数が呼び出されると、次の引数が渡されます: データ配列、フィールド (フィールド定義の配列)、方向 ("asc" または "desc")。関数は並べ替えられたデータ配列を返す必要があります。

    コード サンプル

    var render = function (success, error) {     if (success) {         var template = "<tr><td>${Name}</td><td>${Price}</td><td>${Rating}</td></tr>",         resultHtml = $.ig.tmpl(template, ds.dataView());         $("#table").html(resultHtml);     } else {         alert(error);     } }   var myCustomFunc = function (data, fields, direction) {     function myCompareFunc(obj1, obj2) {         if (direction == "desc") {             return obj2[fields[0].fieldName] - obj1[fields[0].fieldName];         }           return obj1[fields[0].fieldName] - obj2[fields[0].fieldName];     }     var result = data.sort(myCompareFunc);     return result; }   var ds; $(window).load(function () {     var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         callback: render,         dataSource: url,         schema: {             fields: [{                 name: "Name"             }, {                 name: "Price"             }, {                 name: "Rating"             }],             searchField: "d"         },         responseDataKey: "d",         responseDataType: "jsonp",         sorting: {             type: "local",             customFunc: myCustomFunc,             defaultFields: [{                 fieldName: "Price"             }],             defaultDirection: "desc"         }     });     ds.dataBind(); });

  • defaultDirection

    タイプ:

    enumeration

    デフォルト:

    none

    並べ替えの方向。

    メンバー

    • none
    • タイプ:string
    • asc
    • タイプ:string
    • desc
    • タイプ:string

    コード サンプル

    jsonDs = new $.ig.XmlDataSource({     sorting: {         type: "local",         defaultDirection: "asc"     },     dataSource: jsonData }).dataBind();

  • defaultFields

    タイプ:

    array

    デフォルト:

    []

    要素タイプ:

    object

    defaultDirection が "none" でなく、defaultFields が指定されている場合、dataBind() のすぐ後に、データは最初に適宜並べ替えられます。

    コード サンプル

    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [{             name: "Name"         }, {             name: "Price"         }, {             name: "Rating"         }],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     sorting: {         type: "local",         defaultFields: [{         fieldName: "Price"         }]     } });

  • expressions

    タイプ:

    array

    デフォルト:

    []

    要素タイプ:

    object

    並べ替えの式のリスト。次のキー (およびそれぞれの値) で構成されます: fieldName、direction、および compareFunc (オプション)。

    コード サンプル

    ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     localSchemaTransform: false,     responseDataKey: "d",     sorting: {         expressions:[             {                 fieldName:"Rating",                 dir:"asc"             },             {                 fieldName:"Price", dir:"asc"             }         ]     } });

  • exprString

    タイプ:

    string

    デフォルト:

    ""

    式よりも優先される「SQL ライクな」エンコードされた式の文字列です。sort() を参照してください。例: col2 > 100 ORDER BY asc。

    コード サンプル

    function sortRemote() {     ds.settings.sorting.type = "remote";       // remote sort     ds.settings.sorting.exprString = "GNP " + dir;     ds.dataBind(); }

  • sortUrlAscValueKey

    タイプ:

    string

    デフォルト:

    null

    昇順の並べ替えの URL パラメーター値。デフォルトは null で、OData 規則を使用します。

    コード サンプル

    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [{             name: "Name"         }, {             name: "Price"         }, {             name: "Rating"         }],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     sorting: {         type: "local",         sortUrlAscValueKey: "mySortUrlAscValueKey"     } });

  • sortUrlDescValueKey

    タイプ:

    string

    デフォルト:

    null

    降順の並べ替えの URL パラメーター値。デフォルトは null で、OData 規則を使用します。

    コード サンプル

    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [             {name: "Name"},             {name: "Price"},             {name: "Rating"}         ],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     sorting: {         type: "local",         sortUrlDescValueKey: "mySortUrlDescValueKey"     } });

  • sortUrlKey

    タイプ:

    string

    デフォルト:

    null

    並べ替えの式を URL 内でエンコードする方法を指定する URL パラメーター名。デフォルトは null で、OData 規則を使用します。

    コード サンプル

    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [             {name: "Name"},             {name: "Price"},             {name: "Rating"}         ],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     sorting: {         type: "local",         sortUrlKey: "mySortUrlKey"     } });

  • type

    タイプ:

    enumeration

    デフォルト:

    remote

    並べ替えをローカルで適用するかリモートで (リモート要求によって) 適用するかを指定します。

    メンバー

    • remote
    • タイプ:string
    • local
    • タイプ:string

    コード サンプル

    $(window).load(function () {     ds = new $.ig.XmlDataSource({         type: "json",         dataSource: adventureWorks,         sorting: {             type: "local",             caseSensitive: true         }     });     ds.dataBind(); });

• summaries

  タイプ:

  object

  デフォルト:

  {}

  組み込みの集計機能に関連する設定。

  コード サンプル

  var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [{             name: "Name"         }, {             name: "Price"         }, {             name: "Rating"         }],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     summaries: {         type: "remote",         columnSettings: [{             columnKey: "Price",             allowSummaries: false,             summaryOperands: [{                 type: "count",                 active: true,                 order: 0             }]         }],         summariesResponseKey: "d"     } });

  • columnSettings

    タイプ:

    array

    デフォルト:

    []

    要素タイプ:

    object

    カスタム集計オプションを列ごとに指定する列設定のリスト。

    コード サンプル

    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [{             name: "Name"         }, {             name: "Price"         }, {             name: "Rating"         }],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     summaries: {         columnSettings: [{             columnKey: "Price",             allowSummaries: false,             summaryOperands: [{                 type: "count",                 active: true,                 order: 0             }]         }]     }   });

  • summariesResponseKey

    タイプ:

    string

    デフォルト:

    "summaries"

    集計の応答からデータを取得するキー。集計がリモートの場合のみに使用されます。

    コード サンプル

    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [{             name: "Name"         }, {             name: "Price"         }, {             name: "Rating"         }],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     summaries: {         summariesResponseKey: "d"     } });

  • summaryExecution

    タイプ:

    enumeration

    デフォルト:

    afterfilteringandpaging

    いつ集計値を計算するかを決定します。

    メンバー

    • priortofilteringandpaging
    • タイプ:string
    • afterfilteringbeforepaging
    • タイプ:string
    • afterfilteringandpaging
    • タイプ:string

    コード サンプル

    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [{             name: "Name"         }, {             name: "Price"         }, {             name: "Rating"         }],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     summaries: {         summaryExecution: "priortofilteringandpaging"     } });

  • summaryExprUrlKey

    タイプ:

    string

    デフォルト:

    "summaries"

    応答からデータを取得する URL キー。集計がリモートの場合のみに使用されます。

    コード サンプル

    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [{             name: "Name"         }, {             name: "Price"         }, {             name: "Rating"         }],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     summaries: {         summaryExprUrlKey: "mySummaries"     } });

  • type

    タイプ:

    enumeration

    デフォルト:

    remote

    集計をローカルまたはリモートで (リモート要求によって) 適用するかを指定します。

    メンバー

    • remote
    • タイプ:string
    • リモート要求が完了し、URL パラメーターがエンコードされました。
    • local
    • タイプ:string
    • データはクライアント側でページングされます。

    コード サンプル

    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [{             name: "Name"         }, {             name: "Price"         }, {             name: "Rating"         }],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     summaries: {         type: "remote"     } });

• type

  タイプ:

  enumeration

  デフォルト:

  unknown

  データ ソースのタイプ。

  メンバー

  • json
  • タイプ:string
  • データソースが、既に評価済みの JSON (JavaScript オブジェクト/配列) であるか、または JSON に対して評価できる文字列であるかを指定します。
  • xml
  • タイプ:string
  • データソースが、XML Document オブジェクト、または XML に対して評価できる文字列であるかを指定します。
  • unknown
  • タイプ:string
  • データ ソースが不明なタイプであることを指定します。その場合、それは分析され、可能な場合は自動的に検出されます。
  • array
  • タイプ:string
  • データ ソースがオブジェクトのシンプルな配列であることを指定します。
  • function
  • タイプ:string
  • データ ソースが関数を指していることを指定します。データ バインド中、関数が呼び出され、結果はオブジェクトの配列であると見なされます。
  • htmlTableString
  • タイプ:string
  • データ ソースが HTML テーブルを表す文字列を指していることを指定します。
  • htmlTableId
  • タイプ:string
  • データ ソースが、ページに読み込まれた HTML Table 要素の ID を指していることを指定します。
  • htmlTableDom
  • タイプ:string
  • データ ソースは TABLE タイプの DOM オブジェクトを指しています。
  • invalid
  • タイプ:string
  • データ ソースが分析され (タイプが不明な場合)、タイプを検出できない場合は常に設定します。
  • remoteUrl
  • タイプ:string
  • データ ソースが、そこから AJAX コール ($.ajax) を使ってデータが検索される、リモート URL を指していることを指定します。
  • htmlListDom
  • タイプ:string
  • データ ソースは UL/OL タイプの DOM オブジェクトを指しています。
  • htmlSelectDom
  • タイプ:string
  • データ ソースは SELECT タイプの DOM オブジェクトを指しています。
  • empty
  • タイプ:string

  コード サンプル

  $(window).load(function () {     var url = "http://odata.netflix.com/Catalog/Titles?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         type: "remoteUrl",         callback: render,         dataSource: url,         schema: oDataSchema,         responseDataKey : "d.results",         responseDataType: "jsonp",     });     ds.dataBind(); });

• updateUrl

  タイプ:

  string

  デフォルト:

  null

  更新するリモート URL を指定します。saveChages() が呼び出されると、これに対してすぐにAJAX リクエストが実行されます。

  コード サンプル

  var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?"; var ds = new $.ig.XmlDataSource({     callback: render,     dataSource: url,     schema: {         fields: [{             name: "Name"         }, {             name: "Price"         }, {             name: "Rating"         }],         searchField: "d"     },     responseDataKey: "d",     responseDataType: "jsonp",     updateUrl: "http://example.com/myUpdateUrl/"   });

• urlParamsEncoded

  タイプ:

  object

  デフォルト:

  null

  URL パラメーターがエンコードされた後に発生するイベント (リモート要求が実行されたとき)。関数名または関数オブジェクト自体を指すことができます。

  コード サンプル

  var render = function (success, error) {     if (success) {         var template = "<tr><td>${Name}</td><td>${Price}</td><td>${Rating}</td></tr>",         resultHtml = $.ig.tmpl(template, ds.dataView());         $("#table").html(resultHtml);     } else {         alert(error);     } }   var myUrlParamsEncoded = function (item, params) {     alert("myUrlParamsEncoded"); }   var ds; $(window).load(function () {     var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         callback: render,         dataSource: url,         schema: {             fields: [{                 name: "Name"             }, {                 name: "Price"             }, {                 name: "Rating"             }],             searchField: "d"         },         responseDataKey: "d",         responseDataType: "jsonp",         urlParamsEncoded: myUrlParamsEncoded     });     ds.dataBind(); });

• urlParamsEncoding

  タイプ:

  object

  デフォルト:

  null

  URL パラメーターがエンコードされる前に発生するイベント。関数名または関数オブジェクト自体を指すことができます。

  コード サンプル

  var render = function (success, error) {     if (success) {         var template = "<tr><td>${Name}</td><td>${Price}</td><td>${Rating}</td></tr>",         resultHtml = $.ig.tmpl(template, ds.dataView());         $("#table").html(resultHtml);     } else {         alert(error);     } }   var myUrlParamsEncoding = function (item, params) {     alert("myUrlParamsEncoding"); }   var ds; $(window).load(function () {     var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";     ds = new $.ig.XmlDataSource({         callback: render,         dataSource: url,         schema: {             fields: [{                 name: "Name"             }, {                 name: "Price"             }, {                 name: "Rating"             }],             searchField: "d"         },         responseDataKey: "d",         responseDataType: "jsonp",         urlParamsEncoding: myUrlParamsEncoding     });     ds.dataBind(); });