w2grid.getSearch

getSearch(field, [returnIndex])

searchesプロパティを検索し、オブジェクトか、インデックスを返します。 戻り値はobject、またはinteger、またはnullです。

field: string

searchesのフィールド名。

returnIndex: boolean

searchesオブジェクトを返すか、searchesのインデックスを返すかを指定します。

説明

検索項目は、検索項目定義に必要な.fieldプロパティで識別されます。 この関数は.searches配列からループ処理で該当の検索項目を探し出します。

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

$('#grid').w2grid({
    name    : 'grid',
    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' }
    ],
    searches: [
        { field: 'recid', caption: 'ID', type: 'int', hidden: true },
        { field: 'fname', caption: 'First Name', type: 'text', hidden: true },
        { field: 'lname', caption: 'Last Name', type: 'text' }
    ]    
});

以下で検索することができます。

console.log( w2ui['grid'].getSearch('recid') );

デモ

グリッドをクリックすると、recidの検索項目をconsole.logに出力します。

JavaScript

$('#grid').w2grid({
    name    : 'mygrid',
    url     : '../json/data.json',
    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' }
    ],
    searches: [
        { field: 'recid', caption: 'ID', type: 'int', hidden: true },
        { field: 'fname', caption: 'First Name', type: 'text', hidden: true },
        { field: 'lname', caption: 'Last Name', type: 'text' }
    ]
});
w2ui['mygrid'].on('click', function(event) {
    console.log( w2ui['mygrid'].getSearch('recid') );
});