w2grid.addRange

addRange(range)

指定した範囲のセルを可視化します。 戻り値はintegerです。

range: object, array

可視化する範囲。

説明

この関数は.selectTypeプロパティにcellを指定して、Excelのようなグリッドの場合のみ使うことができます。.rangesプロパティに範囲を追加し、.refreshRanges()メソッドを実行します。

第1引数のrangeは追加するデータの範囲オブジェクトか、 範囲オブジェクトの配列を指定します。 戻り値は追加した範囲の個数です。1つの範囲が1個になります。

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

$('#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', 
    range    : [{ recid: 1, column: 3 }, { recid: 5, column: 5 }], 
    style    : 'background-color: rgba(0, 140, 0, 0.1); border: 2px solid green'
});

一度に複数追加する場合

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

rangeの構造は.rangesプロパティを参照してください。

デモ

グリッドをクリックすると、ID1～5の"Email"～"End Date"の範囲が可視化されます。

JavaScript

$('#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'].on('click', function(){
  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'
  });
});