w2grid.columnOnOff

columnOnOff(el, event, field, value)

擬似的に(ツールバーの)「Show/hide columns」を開き、 その中からカラムをクリックします。 戻り値はundefinedです。

el: DOM Element

関連要素。ほとんどの場合チェックボックスです。

event: object

DOMイベント。オプションです。

field: string

チェックボックスに関連付けられたカラム名。

value: integer

レコードを何件スキップするか。

説明

この関数は「Show/hide columns」を開き、その中からカラムをクリックした時に呼び出されます。 通常、カラムの表示/非表示だけでなく、レコードのスキップや、カラム幅リセットも行われます。 この関数は.onColumnOnOffイベントを発生させます。

グリッドを以下のように定義します。

$('#grid').w2grid({
    name : 'grid',
    show : { toolbar: true },
    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' }
    ],
    onColumnOnOff: function (event) {
        console.log(event);
    },
    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['grid'].columnOnOff();

デモ

チェックボックスをクリックするたびに、"First Name"の表示/非表示を切り替えます。

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' }
    ],
});
$("#onoff").on('click', function(event) {
    w2ui['mygrid'].columnOnOff($(this), 'fname');
});