w2grid.onStateRestore

onStateRestore = function(event)

ツールバーの「|||(カラム選択)」内の「Restore Default State」(初期状態に戻す)をクリックした時に呼び出されます。

オブジェクト作成時にイベントリスナーとして指定します。

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

または、w2gridオブジェクト生成後に指定します。

w2ui['grid'].on('stateRestore', function(event) {
    console.log(event);
});

このイベントハンドラはデフォルトのアクションの前に呼び出されます。 デフォルトアクションを取り消すにはevent.preventDefault()を使います。 このイベントが完全に終わった後にデフォルトアクションを走らせるには、event.onCompleteを使います。 より詳しく知りたい場合はw2utils:eventsを参照して下さい。

デモ

ツールバーの「|||(カラム選択)」内の「Restore Default State」をクリックすると、console.logが出力されます。

* 「Restore Default State」はカラムの表示状態を初期状態に戻します。フィールドの値や、ソートの並び順は初期状態には戻りません。

* 「Save Grid State」した後は、「Restore Default State」をクリックして、元の状態に戻してください。 そのままでは他のプロパティに影響が出てしまう場合があります。

JavaScript

$('#grid').w2grid({
    name : 'mygrid',
    show : {
        toolbar    : true,
        toolbarAdd : true
    },
    columns: [
        { field: 'recid', caption: 'ID', size: '50px' },
        { field: 'lname', caption: 'Last Name', size: '30%', editable: { type: 'text' } },
        { field: 'fname', caption: 'First Name', size: '30%', editable: { type: 'text' } },
        { field: 'email', caption: 'Email', size: '40%', editable: { type: 'email' } },
        { field: 'sdate', caption: 'End Date', size: '120px', editable: { type: 'date' } }
    ],
    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' }
    ],
    onStateRestore: function(event) {
        console.log(event);
    }
});