w2grid.removeRange

Removes a range or ranges from the grid.

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

range_name

string, field name of the column

Returns integer.

Description

Removes a range or ranges from the .ranges array. The range is identified by the name, which you provide when you add a range with .addRange() method. The method returns the number of ranges it removes.

If you have grid defined as:

​x
 
let grid = new w2grid({
    name : 'grid',
    selectionType : 'cell',
    columns: [
        { field: 'recid', text: 'ID', size: '50px' },
        { field: 'lname', text: 'Last Name', size: '30%', searchable: true },
        { field: 'fname', text: 'First Name', size: '30%', searchable: true },
        { field: 'email', text: 'Email', size: '40%', searchable: true },
        { field: 'sdate', text: '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' }
    ]
});
​

You can add a range by:

xxxxxxxxxx
 
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'
});
​

And remove this range by:

xxxxxxxxxx
 
w2ui.grid.removeRange('range_name');
​

w2grid.removeRange

Description

User Comments