w2grid.removeRange

removeRange(range_name, [range_name], ...)

範囲指定を削除します。 戻り値はintegerです。

range_name: string

rangeオブジェクト名。

説明

.ranges配列から指定の範囲を削除します。 削除する範囲オブジェクトは、.addRange()メソッドで追加された、range_nameを指定します。 削除した範囲の数を返します。

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

$('#grid').w2grid({
    name : 'grid',
    selectionType : 'cell',
    columns: [                
        { field: 'recid', caption: 'ID', size: '50px' },
        { field: 'lname', caption: 'Last Name', size: '30%', searchable: true },
        { field: 'fname', caption: 'First Name', size: '30%', searchable: true },
        { field: 'email', caption: 'Email', size: '40%', searchable: true },
        { 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' }
    ]
});

範囲を以下のように指定します。

w2ui.grid.addRange({ 
    name    : 'range_name', 
    range    : [{ recid: 1, column: 3 }, { recid: 5, column: 5 }], 
    style    : 'background-color: rgba(0, 140, 0, 0.1); border: 2px solid green'
});

そして指定範囲を削除します。

w2ui['grid'].removeRange('range_name');

デモ

グリッドをクリックすると、ID:1～5、"Email"～"End Date"の範囲指定を削除します。

$('#grid').w2grid({
    name    : 'mygrid',
    selectType : 'cell',
    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'].addRange({ 
    name    : 'range', 
    range    : [{ recid: 1, column: 3 }, { recid: 5, column: 5 }], 
    style    : 'background-color: rgba(0, 140, 0, 0.1); border: 2px solid green'
});
w2ui['mygrid'].on('click', function(event) {
    w2ui['mygrid'].removeRange('range');
});