Ignite UI™ API ヘルプ

ig.RemoteDataSource

RemoteDataSource は DataSource クラスを拡張したものであり、デフォルトで、タイプオプションを「remoteUrl」に設定します。RemoteDataSource コンポーネントの API の詳細については、基本 DataSource コンポーネントの API マニュアルを参照してください。この API のクラス、オプション、イベント、メソッドおよびテーマの詳細については、上記の関連するタブを参照してください。

以下のコードは、RemoteDataSource コントロールの初期化方法を示します。

この API を使用した作業方法の詳細についてはここをクリックしてください。RemoteDataSource コントロールの必要なスクリプトおよびテーマを参照する方法については、「Ignite UI で JavaScript リソースを使用する」および Ignite UI のスタイル設定とテーマを参照してください。

コードサンプル

<!doctype html>
<html>
<head>
    <!-- Infragistics Combined CSS -->
    <link href="css/themes/infragistics/infragistics.theme.css" rel="stylesheet" type="text/css" />
    <link href="css/structure/infragistics.css" rel="stylesheet" type="text/css" />
    <!-- jQuery Core -->
    <script src="js/jquery.js" type="text/javascript"></script>
    <!-- jQuery UI -->
    <script src="js/jquery-ui.js" type="text/javascript"></script>
    <!-- Infragistics Combined Scripts -->
    <script src="js/infragistics.core.js" type="text/javascript"></script>
 
    <script type="text/javascript">
    $(function () {
        var remoteDataSource = new $.ig.RemoteDataSource({
            responseDataType: "jsonp",
            dataSource: 'http://services.odata.org/OData/OData.svc/Categories?$expand=Products&$format=json&$callback=?',
            responseDataKey: "value"
        });
 
        $("#gridRemoteJSON").igHierarchicalGrid({
            odata: false,
            initialDataBindDepth: 1,
            dataSource: remoteDataSource,
            responseDataKey: 'value',
 
            autoGenerateColumns: false,
            primaryKey: "ID",
            columns: [
                { headerText: "ID", key: "ID", width: "50px", dataType: "number" },
                { headerText: "Name", key: "Name", width: "130px", dataType: "string" }
            ],
            autoGenerateLayouts: false,
            defaultChildrenDataProperty: "Products",
            columnLayouts: [
                {
                    key: "Products",
                    autoGenerateColumns: false,
                    primaryKey: "ID",
                    columns: [
                        { key: "ID", headerText: "ID", width: "25px" },
                        { key: "Name", headerText: "Product Name", width: "90px" },
                        { key: "Price", headerText: "Price", dataType: "number", width: "55px" }
                    ]
                }
            ]
        });
    });
    </script>
</head>
<body>
    <table id="gridRemoteJSON"></table>
</body>
</html>

settings
継承

タイプ:: object
デフォルト:: {}

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

コードサンプル

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.RemoteDataSource({
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"
    }]
},
paging: {
    enabled: true,
    pageSize: 3,
    type: "local"
}
});
 
ds.dataBind();
});

aggregateTransactions

タイプ:

bool

デフォルト:

false

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

コードサンプル

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

タイプ:

bool

デフォルト:

false

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

コードサンプル

var ds = new $.ig.RemoteDataSource({
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.RemoteDataSource({
        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.RemoteDataSource({
        dataSource: products,
        callee: Bob,
        callback: Bob.greet
    });
 
    ds.dataBind();
});

data

タイプ:

array

デフォルト:

[]

要素タイプ:

object

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

コードサンプル

var ds = new $.ig.RemoteDataSource({
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.RemoteDataSource({
        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.RemoteDataSource({
        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.RemoteDataSource({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.RemoteDataSource({
        dataSource: products,
        fields: [{
            name: "ProductID",
            type: "number"
        }, {
            name: "Name",
            type: "string"
        }, {
            name: "ProductNumber",
            type: "string"
        }]
    });
 
    ds.dataBind();
});

filtering

タイプ:: object
デフォルト:: {}

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

コードサンプル

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

applyToAllData

タイプ:: bool
デフォルト:: true

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

コードサンプル

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

caseSensitive

タイプ:: bool
デフォルト:: false

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

コードサンプル

jsonDs = new $.ig.RemoteDataSource( {
    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.RemoteDataSource({
        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.RemoteDataSource({
        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.RemoteDataSource({
    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.RemoteDataSource({
        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.RemoteDataSource({
        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.RemoteDataSource({
        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.RemoteDataSource({
    filtering: { 
        type: "local",
        caseSensitive: true,
        applyToAllData: true
    }, 
    dataSource: 'http://services.odata.org/OData/OData.svc/Categories?$expand=Products&$format=json&$callback=?',
    responseDataKey : "d.results", 
    responseDataType: "jsonp"          
}).dataBind();

groupby

タイプ:: object
デフォルト:: {}

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

コードサンプル

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

defaultCollapseState

タイプ:

bool

デフォルト:

false

デフォルトの縮小状態。

コードサンプル

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

タイプ:

string

デフォルト:

"__gbRecord"

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

コードサンプル

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

タイプ:

string

デフォルト:

"__gbSummaryRecord"

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

コードサンプル

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

タイプ:

enumeration

デフォルト:

allRecords
グループ化された列が 1 つ以上ある場合、ページングの適用方法を指定します。
メンバー
- allRecords
- タイプ:string
- ページングは、データおよびグループ化レコードなどのデータ以外のレコードを含むすべてのレコードに適用されます。
- dataRecordsOnly
- タイプ:string
- ページングがデータレコードのみに適用されます。データ以外のレコードはページング計算で無視されます。
コードサンプル

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

summaries

タイプ:: array
デフォルト:: []
要素タイプ:: object

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

コードサンプル

    ds = new $.ig.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
        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.RemoteDataSource({
        type: "json",
        dataSource: adventureWorks,
        responseDataKey: "Records",
        paging: {
            enabled : true,
            pageSize:10,
            type: "local"
        }
    });
 
    ds.dataBind();
});

appendPage

タイプ:

bool

デフォルト:

false

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

コードサンプル

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

enabled

タイプ:: bool
デフォルト:: false

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

コードサンプル

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

pageIndex

タイプ:: number
デフォルト:: 0

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

コードサンプル

ds = new $.ig.RemoteDataSource({
    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.RemoteDataSource({
    type: "json",
    dataSource: adventureWorks,
    responseDataKey: "Records",
    paging: {
        enabled: true,
        pageSize: 10,
        pageIndex: 2,
        pageIndexUrlKey: "myPageIndexUrlKey",
        type: "local"
    }
});

pageSize

タイプ:: number
デフォルト:: 5

各ページのレコード数。

コードサンプル

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

pageSizeUrlKey

タイプ:: string
デフォルト:: null

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

コードサンプル

var ds = new $.ig.RemoteDataSource({
    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.RemoteDataSource( {
    filtering: {
        type: "local",
        caseSensitive: true,
        applyToAllData: true
    },
    dataSource: jsonData
}).dataBind();

primaryKey

タイプ:: string
デフォルト:: null

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

コードサンプル

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

requestType

タイプ:: string
デフォルト:: "GET"

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

コードサンプル

$(window).load(function () {
    ds = new $.ig.RemoteDataSource({
        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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
        type: "remoteUrl",
        callback: render,
        dataSource: url,
        schema: oDataSchema,
        responseDataKey: "d.results",
        responseDataType: "jsonp",
    });
    ds.dataBind();
});

responseTotalRecCountKey

タイプ:

string

デフォルト:

null

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

コードサンプル

var ds = new $.ig.RemoteDataSource({
    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.RemoteDataSource({
    type: "json",
    dataSource: jsonData,
    schema: jsonSchema
});
ds.dataBind();

serializeTransactionLog

タイプ:

bool

デフォルト:

true

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

コードサンプル

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

sorting

タイプ:: object
デフォルト:: {}

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

コードサンプル

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

applyToAllData

タイプ:

bool

デフォルト:

true

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

コードサンプル

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

caseSensitive

タイプ:: bool
デフォルト:: false

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

コードサンプル

$(window).load(function () {
    ds = new $.ig.RemoteDataSource({
        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.RemoteDataSource({
        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.RemoteDataSource({
            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.RemoteDataSource({
        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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
        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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
    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.RemoteDataSource({
        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.RemoteDataSource({
    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.RemoteDataSource({
        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.RemoteDataSource({
        callback: render,
        dataSource: url,
        schema: {
            fields: [{
                name: "Name"
            }, {
                name: "Price"
            }, {
                name: "Rating"
            }],
            searchField: "d"
        },
        responseDataKey: "d",
        responseDataType: "jsonp",
        urlParamsEncoding: myUrlParamsEncoding
    });
    ds.dataBind();
});

詳細の表示

ig.RemoteDataSource
コンストラクター

new $.ig.RemoteDataSource( options:object );

options
タイプ:object

コードサンプル

var remoteDataSource = new $.ig.RemoteDataSource({
                       responseDataType: "jsonp",
                       dataSource: 'http://services.odata.org/OData/OData.svc/Categories?$expand=Products&$format=json&$callback=?',
                       responseDataKey: "d"
                   });

addNode
継承

.addNode( data:object );
ツリーデータソースに新しいノードを追加します。コミットまたはロールバックできるトランザクションを作成します。
- data
- タイプ:object
- トランザクションデータ。

addRow
継承

.addRow( rowId:object, rowObject:object, autoCommit:bool );
返却型:: object
返却型の説明:: 作成されたトランザクションオブジェクト。

データソースに新しい行を追加します。コミットまたはロールバックできるトランザクションを作成します。

rowId
タイプ:object
レコードキー - primaryKey (文字列) またはインデックス (数) です。
rowObject
タイプ:object
新しいレコードデータ。
autoCommit
タイプ:bool
autoCommit が True の場合、データソースは自動的に更新され、トランザクションは蓄積されたトランザクションログにそのまま格納されます。

コードサンプル

var ds;
 
var render = function (success, error) {
    if (success) {
    ds.addRow(123, {Name : "CD Player", Price : "40", Rating : "4"}, 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);
    }
}
 
$(window).load(function () {
    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";
    ds = new $.ig.RemoteDataSource({
        callback: render,
        dataSource: url,
        schema: {
            fields: [
                {name: "Name"},
                {name: "Price"},
                {name: "Rating"}
            ],
            searchField: "d"
        },
        responseDataKey: "d",
        responseDataType: "jsonp"
    });
    ds.dataBind();
 
});

allTransactions
継承

.allTransactions( );
返却型:: array

保留されているまたはデータソースにコミットされたすべてのトランザクションオブジェクトのリストを返します。

コードサンプル

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

analyzeDataSource
継承

.analyzeDataSource( );
返却型:: string

dataSource 設定を解析し、データソースのタイプを自動的に決定します。データソースのタイプを返します。settings.type を参照してください。

コードサンプル

var ds;
 
var render = function (success, error) {
    if (success) {
    console.log(ds.analyzeDataSource());
        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);
    }
}
 
$(window).load(function () {
var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";
ds = new $.ig.RemoteDataSource({
    callback: render,
    dataSource: url,
    schema: {
        fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }],
        searchField: "d"
    },
    responseDataKey: "d",
    responseDataType: "jsonp"
    });
    ds.dataBind();
});

clearLocalFilter
継承

.clearLocalFilter( );
元のデータにリセットしてページングを適用すると、データビューに適用されるローカルフィルターをクリアします。
コードサンプル

ds.clearLocalFilter();
clearLocalSorting
継承

.clearLocalSorting( );
元のデータにリセットしてページングを適用すると、データビューに適用されるローカル並べ替えをクリアします。
コードサンプル

ds.clearLocalSorting();

commit
継承

.commit( [id:number] );

ログにあるすべてのトランザクションについてデータソースを更新します。

id
タイプ:number
オプション
コミットするトランザクションの ID。ID が指定されていない場合、すべてのトランザクションをデータソースにコミットします。

コードサンプル

var ds;
 
var render = function (success, error) {
    if (success) {
        ds.addRow(123, {
            Name: "CD Player",
            Price: "40",
            Rating: "4"
        });
        ds.commit();
 
            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);
    }
}
 
$(window).load(function () {
    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";
    ds = new $.ig.RemoteDataSource({
        callback: render,
        dataSource: url,
        schema: {
            fields: [{
                name: "Name"
            }, {
                name: "Price"
            }, {
                name: "Rating"
            }],
            searchField: "d"
        },
        responseDataKey: "d",
        responseDataType: "jsonp"
    });
 
    ds.dataBind();
});

data
継承

.data( );
返却型:: object

ローカルのページング、並べ替え、フィルタリングなどを考慮せずに、すべてのバインドされたデータを返します。

コードサンプル

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

dataBind
継承

.dataBind( [callback:string], [callee:object] );

現在のデータソースに対するデータバインド。
databinding は次のワークフローで機能します。
1. databinding イベントが発生します。
2. データソースタイプに応じて (analyzeDataSource() を参照)、以下を実行します。
3. タイプが HtmlTable の場合、テーブルを解析して、データと dataView をそれぞれ設定します。
タイプが Function の場合、それを呼び出し、Paging/Filtering/Sorting を適用し、この _dataView を設定します。デベロッパーが独自のページング、フィルタリング、または並べ替えを実行したい場合。
その場合、PageIndexChanging や DataFiltering や ColumnSorting のクライアント側イベントを処理し、それらをキャンセルします。
ページング、並べ替え、フィルタリングが無効の場合、この _data を使用して領域を節約します。
データソースのタイプが RemoteUrl の場合、jQuery の $.ajax API を使用して、サービスに対するリモート要求をトリガーします。param() API を使用して、URL をエンコードします。
データソースが無効な場合、例外をスローします。
解析された実行時のデータソースタイプ、つまり、analyzeDataSource() の結果が Unknown の場合、
settings.type の値は XML または JSON に設定されます。文字列の場合、JSON を評価し、XML を解析してオブジェクトツリーを作成します。
4. ここで、スキーマが提供されている場合、データを正規化または変換します。これは、追加のデータ型変換を意味します。
5. 次に、OpType が Local の場合、データのページング、並べ替え、フィルタリングのいずれか、またはすべてを実行して結果をこの _dataView に格納します。
6. databound イベントが発生します。

callback
タイプ:string
オプション
コールバック関数。
callee
タイプ:object
オプション
コールバックが実行される呼び出し先オブジェクト。何も指定しない場合、グローバル実行コンテキストを仮定します。

コードサンプル

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.RemoteDataSource({type: "json", dataSource: jsonData, schema: jsonSchema});
ds.dataBind();

dataSource
継承

.dataSource( [ds:object] );
返却型:: object

dataSource 設定を取得または設定します。指定したパラメーターがない場合、settings.dataSource を返します。

ds
タイプ:object
オプション
.

コードサンプル

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

dataSummaries
継承

.dataSummaries( );
返却型:: object
返却型の説明:: *.

集計データを返します。

コードサンプル

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

dataView
継承

.dataView( );

返却型:

array

返却型の説明:

データレコードの配列。
現在の正規化または変換され、ページング、フィルタリング、または並べ替えされたデータ、つまり dataView を返します。
コードサンプル

function numberOfRows () {
return $("#grid1").data("igGrid").dataSource.dataView().length;
}

deleteRow
継承

.deleteRow( rowId:object, autoCommit:bool );
返却型:: object
返却型の説明:: 作成されたトランザクションオブジェクト。

データソースから行を削除します。

rowId
タイプ:object
レコードキー - primaryKey (文字列) またはインデックス (数) です。
autoCommit
タイプ:bool
autoCommit が True の場合、データソースは自動的に更新され、トランザクションは蓄積されたトランザクションログにそのまま格納されます。

コードサンプル

var ds;
 
var render = function (success, error) {
    if (success) {
 
    ds.deleteRow(0, 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);
    }
}
 
$(window).load(function () {
var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";
ds = new $.ig.RemoteDataSource({
    callback: render,
    dataSource: url,
    schema: {
        fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }],
        searchField: "d"
    },
    responseDataKey: "d",
    responseDataType: "jsonp"
    });
    ds.dataBind();
 
});

fields
継承

.fields( [fields:object] );
返却型:: object
返却型の説明:: パラメーターが何も指定されていない場合、既存のフィールドのリストを返します。

フィールドのリストをデータソースに設定します。パラメーターが何も指定されていない場合、既存のフィールドのリストを単に返します。

fields
タイプ:object
オプション
フィールドは次の形式です: {key: 'fieldKey', dataType: 'string/number/date' }。

コードサンプル

var ds;
 
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);
    }
}
 
$(window).load(function () {
    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";
    ds = new $.ig.RemoteDataSource({
        callback: render,
        dataSource: url,
        schema: {
            fields: [{
                name: "Name"
            }, {
                name: "Price"
            }, {
                name: "Rating"
            }],
            searchField: "d"
        },
        responseDataKey: "d",
        responseDataType: "jsonp",
        fields: [{
            key: "Name",
            dataType: "string"
        }, {
            key: "Price",
            dataType: "number"
        }, {
            key: "Rating",
            dataType: "number"
        }]
    });
    ds.dataBind();
    var fields = ds.fields();
});

filter
継承

.filter( fieldExpressions:object, boolLogic:object, keepFilterState:bool, fieldExpressionsOnStrings:object );

データソースをローカルでフィルタリングします。リモートのフィルタリングは、dataBind() を呼び出し、settings.filtering.expressions を設定するだけで実行できます。結果 (フィルタリングされたデータ) を取得するには、dataView() を呼び出します。
例: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}]。
例 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}]。
例 3: [{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]
expr は、"abc" などのフィルター用の式テキストまたは *test* などの正規表現です。
cond は、startsWith、endsWith、contains、equals、doesNotEqual、doesNotContain などのフィルタリング条件です。
expr が正規表現であることを検出すると、"cond" の部分は無視されます。
テキストによってフィルターするには、"fieldExpressions" に以下のスキーマを持つ単一のオブジェクトが必要です。
{filterAllFields: <type="bool" true に設定してください。>, expr: <type="string" 検索するテキスト。>, fields: <type="array" 検索する fields の配列。>}

fieldExpressions
タイプ:object
フィールド式定義のリスト。
boolLogic
タイプ:object
ブールロジック。許される値は、AND および OR です。
keepFilterState
タイプ:bool
keepFilterState を True に設定すると、前のフィルタリングの式を破棄しません。
fieldExpressionsOnStrings
タイプ:object
フィールド式定義 (または AND/OR 演算子により分割される条件を持つ文字列 - "ID = 1 OR ID = 2" など) のリスト。適用されると、関連フィールドを文字列として使用し、文字列型に有効な条件のみを適用できます。

コードサンプル

ds = new $.ig.RemoteDataSource({
    type: "json",
    dataSource: adventureWorks,
    schema: jsonSchema
});
ds.dataBind();
 
ds.filter([{fieldName : "Color", expr: "Red", cond: "Equals"}], "AND", true);
 
// Filter by text
ds.filter([{filterAllFields: true, expr: "abc", fields: [name: "Description", type: "string"]}]);

filterByText
継承

.filterByText( expression:string, [fields:array] );

データソースをテキストによってローカルでフィルタリングします。"fields" パラメーターが設定される場合、検索がリストされているフィールドのみで実行されます。それ以外の場合、すべてのフィールドが検索されます。

expression
タイプ:string
検索するテキスト。複数の検索テキストはスペースで区切ります。複数の検索テキストが提供されている場合、検索フィールドですべてのテキストが必要です (ブール AND ロジックを適用)。
fields
タイプ:array
オプション
検索するフィールドの配列。

コードサンプル

ds = new $.ig.RemoteDataSource({
    type: "json",
    dataSource: adventureWorks,
    schema: {
        fields: [{
            name: "ID", type: "number"
        }, {
            name: "Name", type: "string"
        }, {
            name: "Description", type: "string"
        }, {
            name: "ReleaseDate", type: "date"
        }]
});
ds.dataBind();
 
// Search in all fields
ds.filterByText("Apples");
// Search only in "Name" field
ds.filterByText("Apples", [{name: "Name", type: "string"}]);

filteredData
継承

.filteredData( );
返却型:: array
返却型の説明:: フィルター済みのデータレコードの配列。

ローカルフィルタリングが適用される場合、フィルター済みのデータを返します。フィルタリングが適用されないか、フィルター型が remote の場合、undefined を返します。

コードサンプル

ds = new $.ig.RemoteDataSource({
    dataSource: products,
    primaryKey: "ProductID",
    filtering: {
        type: "local",
        caseSensitive: true,
        applyToAllData: true
    }
});
 
ds.dataBind();
//Get
var filteredData = ds.filteredData();

filterSettings
継承

.filterSettings( [f:object] );

フィルタリング設定のリストを取得または設定します。

f
タイプ:object
オプション
すべてのフィルタリング設定を保持するオブジェクト。settings.filtering を参照してください。

コードサンプル

var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";
var ds = new $.ig.RemoteDataSource({
    callback: render,
    dataSource: url,
    schema: {
        fields: [
            {name : "Name"},
            {name : "Price"},
            {name: "Rating"}
        ],
        searchField: "d"
    },
    responseDataKey: "d",
    responseDataType: "jsonp"
});
 
var myFilterSettings = {
    type: "remote",
    expressions: [
    {
        fieldName: "Name",
        cond:"Contains",
        expr: "Cr",
        logic: "OR"
    }
]
};
 
// Set
ds.filterSettings(myFilterSettings);
 
// Get
var filterSettings= ds.filterSettings();

findRecordByKey
継承

.findRecordByKey( key:object, [ds:string], [objPath:string] );
返却型:: object
返却型の説明:: 検索したレコードを指定する JavaScript オブジェクト。レコードが検索されていない場合は null。

指定されたキーによってレコードを返します (設定の中で primaryKey が設定されている必要があります)。

key
タイプ:object
レコードのプライマリキー。
ds
タイプ:string
オプション
レコードを検索する先のデータソース。設定されていない場合、現在のデータソースが使用されます。
objPath
タイプ:string
オプション
$.ig.DataSource で使用されません。

コードサンプル

var ds;
 
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);
        var myObj = ds.findRecordByKey("Milk");
    } else {
        alert(error);
    }
}
 
$(window).load(function () {
    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";
    ds = new $.ig.RemoteDataSource({
        callback: render,
        dataSource: url,
        schema: {
            fields: [{
                name: "Name"
            }, {
                name: "Price"
            }, {
                name: "Rating"
            }],
            searchField: "d"
        },
        responseDataKey: "d",
        responseDataType: "jsonp",
        primaryKey: "Name"
    });
    ds.dataBind();
});

getCellValue
継承

.getCellValue( fieldName:string, record:object );
返却型:: object
返却型の説明:: セルの値。

指定した fieldName でレコードからセル値を取得します。フィールドに定義されたマッパーがある場合、マッパー値による解決済みが返されます。

fieldName
タイプ:string
fieldName - フィールドの名前。
record
タイプ:object
取得元のレコード。

コードサンプル

ds = new $.ig.RemoteDataSource({
    dataSource: products,
    primaryKey: "ProductID"
});
 
ds.dataBind();
//Get
var value = ds.getCellValue("Name", {ProductID: 1, Name: "Adjustable Race", ProductNumber: "AR-5381"});

getDetachedRecord
継承

.getDetachedRecord( t:object );
返却型:: object
返却型の説明:: データソースからのレコードのコピー。

コミットされ、ただしデータソースからデタッチされたトランザクションを表すスタンドアローンオブジェクト (copy) を返します。

t
タイプ:object
トランザクションオブジェクト。

コードサンプル

var ds;
 
$(window).load(function () {
    ds = new $.ig.RemoteDataSource({
        schema: {
        fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }],
        }
    });
 
    var transactionObject = ds.addRow(123, {
        Name: "CD Player",
        Price: "40",
        Rating: "4"
    }, true);
    var detachedObject = ds.getDetachedRecord(transactionObject);
    });

groupByData
継承

.groupByData( );
返却型:: array
返却型の説明:: レコードの配列。

データおよびデータ以外のグループ化されたレコードのコレクションを返します。階層データのフラット表現。

コードサンプル

ds = new $.ig.RemoteDataSource({
    dataSource: products,
    primaryKey: "ProductID",
    groupby: {
        defaultCollapseState: true
    }
});
 
ds.dataBind();
 
var groupedData = ds.groupByData();

groupByDataView
継承

.groupByDataView( );
返却型:: array
返却型の説明:: データおよびデータ以外のグループ化されたレコードの配列。

現在の正規化または変換され、ページング、フィルタリング、または並べ替えされたグループ化データを返します。

コードサンプル

ds = new $.ig.RemoteDataSource({
    dataSource: products,
    primaryKey: "ProductID",
    groupby: {
        defaultCollapseState: true
    }
});
 
ds.dataBind();
 
var groupByDataView = ds.groupByDataView();

hasTotalRecordsCount
継承

.hasTotalRecordsCount( hasCount:bool );

サーバー側バックエンド内のレコードの総数を指定するプロパティを含むサーバーからの応答を取得または設定します。

hasCount
タイプ:bool
サーバー側バックエンド内のレコードの総数を示すプロパティがデータソースに含まれるかどうか指定します。

コードサンプル

var ds;
$(window).load(function () {
    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";
    ds = new $.ig.RemoteDataSource({
        callback: render,
        dataSource: url,
        schema: {
            fields: [{
                name: "Name"
            }, {
                name: "Price"
            }, {
                name: "Rating"
            }],
            searchField: "d"
        },
        responseDataKey: "d",
        responseDataType: "jsonp",
        primaryKey: "Name"
    });
    ds.dataBind();
    // Get
    var hasTotalRecords = ds.hasTotalRecordsCount();
 
    // Set
    ds.hasTotalRecordsCount(true);
});

insertRow
継承

.insertRow( rowId:object, rowObject:object, rowIndex:number, autoCommit:bool, parentRowId:object );
返却型:: object
返却型の説明:: 作成されたトランザクションオブジェクト。

データソースに新しい行を追加します。コミットまたはロールバックできるトランザクションを作成します。

rowId
タイプ:object
レコードキー - primaryKey (文字列) またはインデックス (数) です。
rowObject
タイプ:object
新しいレコードデータ。
rowIndex
タイプ:number
新しい行を挿入する行インデックス。
autoCommit
タイプ:bool
autoCommit が True の場合、データソースは自動的に更新され、トランザクションは蓄積されたトランザクションログにそのまま格納されます。
parentRowId
タイプ:object
$.ig.DataSource で使用されません。

コードサンプル

var ds;
 
var render = function (success, error) {
    if (success) {
        ds.insertRow(123, {
            Name: "CD Player",
            Price: "40",
            Rating: "4"
        }, 1, 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);
    }
}
 
$(window).load(function () {
    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";
    ds = new $.ig.RemoteDataSource({
        callback: render,
        dataSource: url,
        schema: {
            fields: [{
                name: "Name"
            }, {
                name: "Price"
            }, {
                name: "Rating"
            }],
            searchField: "d"
        },
        responseDataKey: "d",
        responseDataType: "jsonp"
    });
ds.dataBind();
 
});

isGroupByApplied
継承

.isGroupByApplied( [exprs:array] );
返却型:: bool
返却型の説明:: グループ化が適用される場合は True を返します。

グループ化が指定した並べ替え式で適用されるかどうかを確認します。

exprs
タイプ:array
オプション
並べ替え式の配列。設定されていない場合、並べ替え設定で定義される式を確認します。

コードサンプル

ds = new $.ig.RemoteDataSource({
    dataSource: products,
    primaryKey: "ProductID",
    groupby: {
        defaultCollapseState: true
    },
    sorting: {
        expressions:[
            {
                fieldName: "Name",
                dir: "desc"
            }
    ]}
});
 
ds.dataBind();
 
var sortingExprArray = ds.settings.sorting.expressions;
var isApplied = ds.isGroupByApplied(sortingExprArray);

isGroupByRecordCollapsed
継承

.isGroupByRecordCollapsed( gbRec:object );
返却型:: bool
返却型の説明:: True の場合、グループ化されたレコードが縮小されます。

指定したグループ化レコードが縮小されたかどうかを確認します。

gbRec
タイプ:object
グループ化されたレコードの ID、またはグループ化されたレコード。

コードサンプル

ds = new $.ig.RemoteDataSource({
    dataSource: products,
    primaryKey: "ProductID",
    groupby: {
        defaultCollapseState: true
    }
});
 
ds.dataBind();
 
var isCollapsed = ds.isGroupByRecordCollapsed({id:"ProductID:49"});

metadata
継承

.metadata( key:string );
返却型:: object
返却型の説明:: メタデータオブジェクト。

指定したキーに対するメタデータオブジェクトを返します。

key
タイプ:string
レコードのプライマリキー。

コードサンプル

var ds;
 
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);
    }
}
 
$(window).load(function () {
    var url = "http://services.odata.org/OData/OData.svc/Products?$format=json&$callback=?";
    ds = new $.ig.RemoteDataSource({
        callback: render,
        dataSource: url,
        schema: {
            fields: [{
                name: "Name"
            }, {
                name: "Price"
            }, {
                name: "Rating"
            }],
            searchField: "d"
        },
        responseDataKey: "d",
        responseDataType: "jsonp",
        primaryKey: "Name"
    });
    ds.dataBind();
 
    var metadata = ds.metadata();
 
});

nextPage
継承

.nextPage( );

ページインデックスを次のページインデックスに等しくなるように設定し、データソースを再バインドします。

コードサンプル

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

pageCount
継承

.pageCount( );
返却型:: number
返却型の説明:: ページ総数。

合計ページ数を返します。

コードサンプル

ds = new $.ig.RemoteDataSource({
    type: "json",
    dataSource: adventureWorks,
    paging: {
        enabled : true,
        pageSize:10,
        type: "local"
    }
});
 
var count = ds.pageCount();

pageIndex
継承

.pageIndex( [index:number] );
返却型:: number
返却型の説明:: 現在のページインデックス。

現在のページインデックスを取得または設定します。インデックスがパラメーターとして渡される場合、データソースを再バインドします。

index
タイプ:number
オプション
ページインデックス。指定していない場合、現在のページインデックスを返します。

コードサンプル

ds = new $.ig.RemoteDataSource({
    type: "json",
    dataSource: adventureWorks,
    paging: {
        enabled : true,
        pageSize:10,
        type: "local"
    }
});
 
//Get
var currentIndex = ds.pageIndex();
 
//Set
ds.pageIndex(5);

pageSize
継承

.pageSize( [s:number] );
返却型:: number
返却型の説明:: getter で現在のページサイズを返します。setter で $.ig.DataSource の現在インスタンスを返します。

ページサイズを取得または設定します。パラメーターが指定した場合にデータソースを再バインドします。渡されたパラメーターがない場合、現在のページサイズを返します。

s
タイプ:number
オプション
ページサイズ。

コードサンプル

ds = new $.ig.RemoteDataSource({
    type: "json",
    dataSource: adventureWorks,
    paging: {
        enabled : true,
        pageSize:10,
        type: "local"
    }
});
 
//Get
var size = ds.pageSize();
 
//Set
ds.pageSize(25);

pageSizeDirty
継承

.pageSizeDirty( );

内部使用。

コードサンプル

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

pagingSettings
継承

.pagingSettings( [p:object] );
返却型:: object
返却型の説明:: getter で現在のページング設定を持つオブジェクトを返します。setter で $.ig.DataSource の現在インスタンスを返します。

ページング設定のリストを取得または設定します。

p
タイプ:object
オプション
すべてのページング設定を保持するオブジェクト。settings.paging を参照してください。

コードサンプル

var ds = new $.ig.RemoteDataSource({
    type: "json",
    dataSource: adventureWorks,
    paging: {
        enabled: true,
        pageSize: 10,
        type: "local"
    }
});
 
var myPagingSettings = {
    enabled: true,
    pageSize: 10,
    pageIndex: 2,
    pageIndexUrlKey: "myPageIndexUrlKey",
    type: "local"
};
 
// Set
ds.pagingSettings(myPagingSettings);
 
// Get
var pagingSettings = ds.pagingSettings();

pendingTransactions
継承

.pendingTransactions( );
返却型:: array

データソースへのコミットまたはロールバックが保留されているすべてのトランザクションオブジェクトのリストを返します。

コードサンプル

var ds = new $.ig.RemoteDataSource({
    schema: {
    fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }],
        searchField: "d"
    },
    responseDataKey: "d",
    responseDataType: "jsonp"
    });
 
    ds.addRow(123, {
        Name: "CD Player",
        Price: "40",
        Rating: "4"
});
var pendingTransactions = ds.pendingTransactions());

persistedPageIndex
継承

.persistedPageIndex( [value:number] );

返却型:

number

返却型の説明:

保持される現在のページインデックス。
保持されるページインデックスを取得または設定します。フィルタリングが適用され、明示的に DataBind を呼び出す場合のみ実行します。
- value
- タイプ:number
- オプション
- 保持されるページインデックス。指定していない場合、保持する現在のページインデックスを返します。

prevPage
継承

.prevPage( );

ページインデックスを前のページインデックスに等しくなるように設定し、データソースを再バインドします。

コードサンプル

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

recordsForPage
継承

.recordsForPage( p:number );

指定したページのレコードのリストを返します。ページングが有効です。

p
タイプ:number
レコードが返されるページインデックス。

コードサンプル

var ds = new $.ig.RemoteDataSource({
    type: "json",
    dataSource: adventureWorks,
    paging: {
        enabled: true,
        pageSize: 10,
        type: "local"
    }
});
 
var recordsForPage = ds.recordsForPage(2);

removeNode
継承

.removeNode( data:object );
ツリーデータソースからノードを削除します。コミットまたはロールバックできるトランザクションを作成します。
- data
- タイプ:object
- トランザクションデータ。

removeRecordByIndex
継承

.removeRecordByIndex( index:number, origDs:object );

特定のインデックスのデータソースからレコードを削除します。

index
タイプ:number
レコードのインデックス。
origDs
タイプ:object

コードサンプル

var ds = new $.ig.RemoteDataSource({
    schema: {
        fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }],
        searchField: "d"
    },
    responseDataKey: "d",
    responseDataType: "jsonp"
});
ds.addRow(0, {
    Name: "CD Player",
    Price: "40",
    Rating: "4"
}, true);
ds.addRow(1, {
    Name: "CD Player1",
    Price: "40",
    Rating: "4"
}, true);
ds.addRow(2, {
    Name: "CD Player2",
    Price: "40",
    Rating: "4"
}, true);
 
ds.removeRecordByIndex(0);

removeRecordByKey
継承

.removeRecordByKey( key:object, origDs:object );

渡されたキーパラメーターの primaryKey で指定された特定のレコードをデータソースから削除します。

key
タイプ:object
レコードのプライマリキー。
origDs
タイプ:object

コードサンプル

var ds = new $.ig.RemoteDataSource({
    schema: {
        fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }],
        searchField: "d"
    },
    responseDataKey: "d",
    responseDataType: "jsonp",
    primaryKey: "Name"
});
ds.addRow(0, {
    Name: "CD Player",
    Price: "40",
    Rating: "4"
}, true);
ds.addRow(1, {
    Name: "CD Player1",
    Price: "40",
    Rating: "4"
}, true);
ds.addRow(2, {
    Name: "CD Player2",
    Price: "40",
    Rating: "4"
}, true);
 
ds.removeRecordByKey("CD Player2");

rollback
継承

.rollback( [id:object] );

データソースをまったく更新せずに、トランザクションログをクリアします。

id
タイプ:object
オプション
トランザクションを検索するレコード ID。ID が指定されていない場合、すべてのトランザクションをデータソースにロールバックします。

コードサンプル

var ds = new $.ig.RemoteDataSource({
    schema: {
        fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }],
        searchField: "d"
    },
    responseDataKey: "d",
    responseDataType: "jsonp",
    primaryKey: "Name"
});
 
ds.addRow(0, {
    Name: "CD Player",
    Price: "40",
    Rating: "4"
});
ds.addRow(1, {
    Name: "CD Player1",
    Price: "40",
    Rating: "4"
});
ds.addRow(2, {
    Name: "CD Player2",
    Price: "40",
    Rating: "4"
});
 
ds.rollback();

saveChanges
継承

.saveChanges( success:function, error:function );

変更を URL としてシリアル化することで、$.ajax を使用して settings.updateUrl にポストします。

success
タイプ:function
updateUrl オプションへの AJAX リクエストに成功したときに呼び出すカスタム関数を指定します (オプション)。
error
タイプ:function
updateUrl オプションへの AJAX リクエストに失敗したときに呼び出すカスタム関数を指定します (オプション)。

コードサンプル

var ds = new $.ig.RemoteDataSource({
    schema: {
        fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }]
    },
    updateUrl: "http://example.com/myUpdateUrl/"
});
 
ds.addRow(0, {
    Name: "CD Player",
    Price: "40",
    Rating: "4"
}, true);
ds.addRow(1, {
    Name: "CD Player1",
    Price: "40",
    Rating: "4"
}, true);
ds.addRow(2, {
    Name: "CD Player2",
    Price: "40",
    Rating: "4"
}, true);
 
// Option 1: Save changes without callbacks
ds.saveChanges();
 
// Option 2: Save changes with success and error callbacks
ds.saveChanges(function (data) {
    $("#message").text("Changes were saved successfully").fadeIn(3000).fadeOut(5000);
},
function(jqXHR, textStatus, errorThrown) {
    $("#message").text("An error occurred while saving the changes. Error details: " + textStatus).fadeIn(3000).fadeOut(5000);
});

schema
継承

.schema( [s:object], [t:string] );

スキーマ定義を取得または設定します。

s
タイプ:object
オプション
スキーマオブジェクト。
t
タイプ:string
オプション
データソースのタイプ。settings.type を参照してください。

コードサンプル

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.RemoteDataSource();
 
// Set
ds.schema(jsonSchema);
 
// Get
var myJsonSchema = ds.schema();

setCellValue
継承

.setCellValue( rowId:object, colId:object, val:object, autoCommit:bool );
返却型:: object
返却型の説明:: 作成されたトランザクションオブジェクト。

rowId と colId で指定されたセルのセル値を設定します。更新操作のトランザクションを作成して返します。

rowId
タイプ:object
rowId - 行キー (文字列) またはインデックス (数) です。
colId
タイプ:object
column id - 列キー (文字列) またはインデックス (数) です。
val
タイプ:object
新しい値。
autoCommit
タイプ:bool
autoCommit が True の場合、データソースを自動的に更新し、トランザクションは蓄積されたトランザクションログにそのまま格納されます。

コードサンプル

var ds = new $.ig.RemoteDataSource({
    schema: {
        fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }]
    },
    updateUrl: "http://example.com/myUpdateUrl/"
});
 
ds.addRow(0, {
    Name: "CD Player",
    Price: "40",
    Rating: "4"
}, true);
ds.addRow(1, {
    Name: "CD Player1",
    Price: "40",
    Rating: "4"
}, true);
ds.addRow(2, {
    Name: "CD Player2",
    Price: "40",
    Rating: "4"
}, true);
 
ds.setCellValue(1, "Name", "DVD Player", true);

sort
継承

.sort( fields:object, direction:string );

データソースをローカルで並べ替えます。結果 (フィルタリングされたデータ) を取得するには、dataView() を呼び出します。リモートのフィルタリングは、dataBind() を呼び出し、settings.filtering.expressions を設定するだけで実行できます。
複数列の並べ替えを有効にするには、keepSortState を True に設定します。
fields => フィールドオブジェクト定義の配列:
例: [{fieldName : "firstName"}, {fieldName : "lastName"}]。
例 2: [{fieldIndex : 1} , {fieldIndex : 2}]。

fields
タイプ:object
フィールドオブジェクト定義の配列。
direction
タイプ:string
asc / desc 方向。

コードサンプル

var ds = new $.ig.RemoteDataSource({
    schema: {
        fields:[
            { name : "col1" },
            {
                name : "col2",
                type: "number"
            }
        ]
    },
    sorting: { type: "local"},
    dataSource: $("#t1")[0]
}).dataBind();
 
ds.sort([{fieldName : "col2"}], "desc", false);

sortSettings
継承

.sortSettings( [s:object] );
返却型:: object
返却型の説明:: getter で現在の並べ替え設定を持つオブジェクトを返します。setter で $.ig.DataSource の現在インスタンスを返します。

ページング設定のリストを取得または設定します。

s
タイプ:object
オプション
すべての並べ替え設定を保持するオブジェクト。settings.sorting を参照してください。

コードサンプル

var ds = new $.ig.RemoteDataSource({
    schema: {
        fields: [{
            name: "col1"
        }, {
            name: "col2",
            type: "number"
        }]
    }
}).dataBind();
 
var sortSettings = {
    type: "local",
    defaultFields: [{
        fieldName: "col2"
    }],
    defaultDirection: "desc"
};
 
// Set
ds.sortSettings(sortSettings);
 
// Get
var mySortSettings = ds.sortSettings();

stringToJSONObject
継承

.stringToJSONObject( s:string );
文字列を解析し、評価した JSON オブジェクトを返します。
- s
- タイプ:string
- 文字列の JSON。
コードサンプル

ds = new $.ig.RemoteDataSource();
var jsonObj = ds.stringToJSONObject('[{"Name":"CD Player","Price":10.90,"Rating":3}]');
stringToXmlObject
継承

.stringToXmlObject( s:string );
文字列を解析し、XML 文書を返します。
- s
- タイプ:string
- 文字列で表現した XML。
コードサンプル

ds = new $.ig.RemoteDataSource();
var xmlObj = ds.stringToXmlObject("<Element><Name>CD Player</Name><Price>10.90</Price><Rating>3</Rating></Element>");

summariesResponse
継承

.summariesResponse( [key:string], [dsObj:object] );
返却型:: object
返却型の説明:: データ集計のオブジェクト。つまり、データソースに ID および Name の 2 つの列がある場合、データ集計の予期された書式は {max: 1, min: 0, count: 2}, Name: {count: 1}} です。

データソースがリモートデータにバインドされる場合のみ利用できます。
集計データを取得または設定します。
key または dsObj が設定されていない場合、集計データを返します。
key 引数を使用して dsObj 渡された引数から集計データを取得します。

key
タイプ:string
オプション
集計データを取得する応答キー (例: Metadata.Summaries)。
dsObj
タイプ:object
オプション
データソースオブジェクト - データレコードおよびメタデータについての情報を含みます (集計の情報を保存します)。

コードサンプル

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

summariesSettings
継承

.summariesSettings( [s:object] );

集計設定のリストを取得または設定します。

s
タイプ:object
オプション
すべての集計設定を含むオブジェクト。settings.summaries を参照してください。

コードサンプル

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

tableToObject
継承

.tableToObject( tableDOM:domelement );
返却型:: object

HTML TABLE DOM 要素を、レコードデータを含むオブジェクトの JavaScript 配列に変換します。

tableDOM
タイプ:domelement
変換する TABLE DOM 要素。

コードサンプル

ds = new $.ig.RemoteDataSource();
var tableObj = ds.tableToObject("<table><tr><td>CD Player</td><td>10.90</td><td>3</td></tr><tr><td>CD Player 1</td><td>10.90</td><td>3</td></tr><tr><td>CD Player 2</td><td>10.90</td><td>3</td></tr></table>");

toggleGroupByRecord
継承

.toggleGroupByRecord( id:string, collapsed:bool );

指定した ID のグループ化されたレコードを切り替え、コレクションの表示されているグループ化データおよびデータビューを更新します。

id
タイプ:string
DOM の各グループ行の data-id 属性。
collapsed
タイプ:bool
True の場合、レコードが縮小されます。それ以外の場合、展開されます。

コードサンプル

ds = new $.ig.RemoteDataSource({
    dataSource: products,
    primaryKey: "ProductID",
    groupby: {
        defaultCollapseState: true
    }
});
 
ds.dataBind();
//Set
ds.toggleGroupByRecord("ProductID:49", true);

totalLocalRecordsCount
継承

.totalLocalRecordsCount( );

返却型:

number

返却型の説明:

ローカルにバインド/存在されるレコードの総数。
ローカルデータソース内のレコードの総数を返します。
コードサンプル

ds = new $.ig.RemoteDataSource({
    callback:render,
    dataSource: "/demos/server/server.php",
    responseDataKey: "records",
}).dataBind();

var count = ds.totalLocalRecordsCount();

totalRecordsCount
継承

.totalRecordsCount( [count:number], key:object, dsObj:object, context:object );
返却型:: number
返却型の説明:: 現在データソースインスタンスのレコード数を返します。

データソースがリモートデータにバインドされる場合のみ利用できます。データソース内のレコードの総数を取得または設定します。データバインドがリモートで、ページングまたはフィルタリングが有効な場合、実際のレコードの総数は
クライアントに存在するレコード数に一致しない場合があります。

count
タイプ:number
オプション
レコードの総数。
key
タイプ:object
dsObj
タイプ:object
context
タイプ:object

コードサンプル

ds = new $.ig.RemoteDataSource({
    callback:render,
    dataSource: "/demos/server/server.php",
    responseDataKey: "records",
}).dataBind();
 
//Get
var count = ds.totalRecordsCount();
 
//Set
ds.totalRecordsCount(42);

transactionsAsString
継承

.transactionsAsString( );
返却型:: string

蓄積されたトランザクションログを文字列として返します。URL に渡す場合など有効に利用するのが目的です。

コードサンプル

var ds = new $.ig.RemoteDataSource({
    schema: {
        fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }],
        searchField: "d"
    },
    responseDataKey: "d",
    responseDataType: "jsonp"
});
ds.addRow(123, {
Name: "CD Player",
Price: "40",
Rating: "4"
});
var transactionsAsString = ds.transactionsAsString();

transformedData
継承

.transformedData( transformedExecution:object );
返却型:: object

変換された実行に従って、変換されたデータを返します:
1.ページングおよびフィルタリング前
2.フィルタリング後、ページング前
3.フィルタリングおよびページング後
.

transformedExecution
タイプ:object

コードサンプル

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

type
継承

.type( [t:object] );

返却型:

enumeration

返却型の説明:

'json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty' を返します。
dataSource のタイプを取得または設定します。指定したパラメーターがない場合、settings.type を返します。
- t
- タイプ:object
- オプション
- .
コードサンプル

ds = new $.ig.RemoteDataSource();

// Set
ds.type("json");

// Get
var myType = ds.type();

updateRow
継承

.updateRow( rowId:object, rowObject:object, autoCommit:bool );
返却型:: object
返却型の説明:: 作成されたトランザクションオブジェクト。

データソース内のレコードを更新します。コミットまたはロールバックできるトランザクションを作成します。

rowId
タイプ:object
レコードキー - primaryKey (文字列) またはインデックス (数) です。
rowObject
タイプ:object
更新するキー/値のペアを含むレコードオブジェクト。スキーマ内または (スキーマが定義されていない場合は) データソース内で定義されたすべてのフィールドのキー/値のペアを含む必要はありません。
autoCommit
タイプ:bool
autoCommit が True の場合、データソースは自動的に更新され、トランザクションは蓄積されたトランザクションログにそのまま格納されます。

コードサンプル

var ds = new $.ig.RemoteDataSource({
    schema: {
        fields: [{
            name: "Name"
        }, {
            name: "Price"
        }, {
            name: "Rating"
        }],
        searchField: "d"
    },
    responseDataKey: "d",
    responseDataType: "jsonp"
});
ds.addRow(0, {
    Name: "CD Player",
    Price: "40",
    Rating: "4"
}, true);
ds.addRow(1, {
    Name: "CD Player1",
    Price: "40",
    Rating: "4"
}, true);
ds.addRow(2, {
    Name: "CD Player2",
    Price: "40",
    Rating: "4"
}, true);
 
 
ds.updateRow(1, {
    Name: "DVD Player1",
    Price: "10",
    Rating: "5"
}, true);

visibleGroupByData
継承

.visibleGroupByData( );
返却型:: array
返却型の説明:: レコードの配列。

データおよびデータ以外のグループ化されたレコードのコレクションを返します。表示されているレコードのみを返します (縮小されているグループ化されたレコードの子がコレクションに含まれていません)。

コードサンプル

ds = new $.ig.RemoteDataSource({
    dataSource: products,
    callback: render,
    groupby: {
        defaultCollapseState: true
    }
});
 
ds.dataBind();
//Get
var visibleGroupByData = ds.visibleGroupByData();

Ignite UI for jQuery | API リファレンス

ig.RemoteDataSource

コード サンプル

関連サンプル

関連トピック

依存関係

コードサンプル