w2grid.searchData

検索項目の配列を指定します。 (検索のフィルタ内容を送信します。)

Array, default = []

検索を実行すると、グリッドは検索項目の配列を生成します。 ユーザーは、 「検索フィールドに入力する」、「カラムを選択して検索する」、 「"Search..."ボタンをクリックして複数フィールドを検索する」 といった方法でグリッド内を検索することができます。 どの方法であっても検索配列を生成します。

オブジェクト作成時に指定する場合

$('#grid').w2grid({
    name    : 'grid',
    url     : 'server/side/path/to/records',
    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: 'jdoe@gmail.com', 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' }
    ],
    searchData : [
        { field : 'fname', value : 'j', operator : 'contains', type: 'text' }
    ]
});

上記のように検索配列を初期化したとしても、あとから変更・上書きすることができます。 ユーザーが混乱しないように、検索対象の項目を隠したり、.postDataプロパティに検索させない為のデータを追加することもできます。

検索配列の構造は以下のとおりです。

search = {
    field    : '',    // 検索フィールド名
    value    : '',    // 文字列か、文字と値の入った配列
    operator : 'is',  // 検索オペレータ [is, in, between, begins with, contains, ends with]
    type     : ''     // データタイプ [text, int, float, date]
}

.search()メソッドを使って検索内容を送信することができます。

デモ

JavaScript

$('#grid').w2grid({
    name    : 'mygrid',
    url     : '../json/data.json',
    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' }
    ],
    searchData : [
        { field : 'fname', value : 'j', operator : 'contains', type: 'text' }
    ]
});