w2grid.getRangeData

getRangeData(range, [extra])

指定した範囲のrange(範囲)オブジェクトを返します。 戻り値は二次元配列です。

range: object

rangeオブジェクト。

extra: boolean

付加情報を含めるかどうかを指定します。オプションです。

説明

第1引数のrangeは範囲として定義された二次元配列です。 構造は以下のとおりです。

var range = [{
    recid    : 1,
    column    : 0
},{
    recid    : 5,
    column    : 2    
}]

第2引数のextraは、 プレーンなrangeオブジェクトを返すか、 それ以外の付加情報(recid、index、column_index、record)を含めるかを指定します。

グリッドを以下のように定義すると

$('#grid').w2grid({
    name    : 'grid',
    columns: [                
        { field: 'recid', caption: 'ID', size: '50px' },
        { field: 'lname', caption: 'Last Name', size: '30%' },
        { field: 'fname', caption: 'First Name', size: '30%' },
        { field: 'email', caption: 'Email', size: '40%' },
        { field: 'sdate', caption: 'Start Date', size: '120px' },
        { field: 'sdate', caption: 'End Date', size: '120px' }
    ],
    records: [
        { recid: 1, fname: 'John', lname: 'doe', email: 'vitali@gmail.com', sdate: '1/3/2012' },
        { recid: 2, fname: 'Stuart', lname: 'Motzart', email: 'jdoe@gmail.com', sdate: '2/4/2012' },
        { recid: 3, fname: 'Jin', lname: 'Franson', email: '--', sdate: '4/23/2012' },
        { recid: 4, fname: 'Susan', lname: 'Ottie', email: 'jdoe@gmail.com', sdate: '5/3/2012' },
        { recid: 5, fname: 'Kelly', lname: 'Silver', email: 'jdoe@gmail.com', sdate: '4/3/2012' },
        { recid: 6, fname: 'Francis', lname: 'Gatos', email: 'vitali@gmail.com', sdate: '2/5/2012' }
    ]
});

以下でHTMLを取得することができます。

JavaScript

var rangeData = w2ui['grid'].getRangeData([{ recid: 1, column: 3}, { recid: 3, column: 5}]);
console.log(rangeData);

デモ

グリッドをクリックすると、ID1～3の"Email"～"End Date"の範囲データを付加情報を含めてconsole.logに出力します。

JavaScript

$('#grid').w2grid({
    name    : 'mygrid',
    columns : [
        { field: 'recid', caption: 'ID', size: '50px' },
        { field: 'lname', caption: 'Last Name', size: '30%' },
        { field: 'fname', caption: 'First Name', size: '30%' },
        { field: 'email', caption: 'Email', size: '40%' },
        { field: 'sdate', caption: 'Start Date', size: '120px' },
        { field: 'sdate', caption: 'End Date', size: '120px' }
    ],
    records: [
        { recid: 1, fname: 'John', lname: 'doe', email: 'vitali@gmail.com', sdate: '1/3/2012' },
        { recid: 2, fname: 'Stuart', lname: 'Motzart', email: 'jdoe@gmail.com', sdate: '2/4/2012' },
        { recid: 3, fname: 'Jin', lname: 'Franson', email: '--', sdate: '4/23/2012' },
        { recid: 4, fname: 'Susan', lname: 'Ottie', email: 'jdoe@gmail.com', sdate: '5/3/2012' },
        { recid: 5, fname: 'Kelly', lname: 'Silver', email: 'jdoe@gmail.com', sdate: '4/3/2012' },
        { recid: 6, fname: 'Francis', lname: 'Gatos', email: 'vitali@gmail.com', sdate: '2/5/2012' }
    ],
});
w2ui['mygrid'].on('click', function(event) {
    var rangeData = w2ui['mygrid'].getRangeData([{ recid: 1, column: 3}, { recid: 3, column: 5}], true);
    console.log(rangeData);
});