TableFilter用法
- 格式：doc
- 大小：43.00 KB
- 文档页数：7
Getting StartedThe easiest way to get started is to download the release and have a look at the demo.htm included in the release.To use this plugin you need to add a scripts reference to:∙jquery (1.3, 1.4)∙picnet.table.filter.jsExample:<script type="text/javascript" src="Scripts/jquery-1.4.2.min.js"></script><script type="text/javascript" src="Scripts/picnet.table.filter.js"></script>Or (For Production Code - Packed)<script src="/ajax/jquery/jquery-1.4.2.min.js" type="text/javascript"></script><script type="text/javascript" src="Scripts/picnet.table.filter.min.js"></script>This plugin will then create the filters in a row in the THEAD element of the table so add this if it is not already there.<table id='demotable'><thead><tr><th>Col1</th><th>Col2</th><th>Col3</th></tr></thead><tbody><tr><td>Value 1</th><th>Value 2</th><th>Value 3</th></tr>....</tbody></table>Hook in your table when the document is loaded.$(document).ready(function() {$('#demotable).tableFilter();});Search FeaturesThe Quick Find feature supports the following features.Name Example AND Expressions red AND blueOR Expressions red OR blueQuotes (Phrases) "red and blue"Groups red AND (blue OR green) NOT Expressions red AND NOT (blue OR green)Numeric Expressions EqualsNot EqualsGreater Than Greater Than or Equals Less ThanLess Than or Equals (Only works on numeric values) = 150!= 150> 150>= 150< 150<= 150Filter TypesCurrently the picnet.table.filter.js only supports two kinds of filters. The first and default is 'text' which just produces a text box for context sensitive text matches. The second is 'ddl', this produces a drop down list that allows the selection of a single item in that list. To specify the filter type simply add filter-type='ddl' in the header cell of the required column. I.e.<table id='demotable'><thead><tr><th>Col1</th><th>Col2</th><th filter-type='ddl'>Col3</th></tr></thead><tbody><tr><td>Value 1</th><th>Value 2</th><th>Value 3</th></tr>....</tbody></table>OptionsWe can also pass an options object to control some basic behaviours of the tableFilter. The current supported options are.∙additionalFilterTriggers:These are additional input controls that will be hooked in to the filter code. Currently only type='text' and type='checkbox' controls are supported.∙clearFiltersControls:Controls that onclick will clear all of the filter values (including additionalFilterTriggers).∙filterDelay (Default 200ms): The delay (in milliseconds) from the moment a key down event occurs that filtering begins.∙selectOptionLabel (Default 'Select...'):The select text in drop down lists that is displayed.∙matchingRow:function(state, tr, textTokens) { ... } These event will allow you to determine wether a matching row is actually correctly matching. This event will be called when a row is considered to have matched the filter, returning false will override this assumtion and hide the row from the results.∙matchingCell: function(state, td, textTokens) { ... } This event behaves the same as the one above but allows more granular overriding capabilities. Returning false will again override the default match logic.∙filteringRows:function(filterStates) { ... } This event is called before filtering begins.Note: Filtering cannot be cancelled with this event;∙filteredRows: function(filterStates) { ... } This event is called after filtering is completed.∙enableCookies saves the filter states between browser sessions. Default state is 'true'. Example 1: Adding an additional whole row filterLets suppose that appart from having column filters we also want to have a quick find style filter that matches any cell in a row. To do this simply add the textbox to the additionalFilterTriggers array.<head>...<script type="text/javascript">$(document).ready(function() {// Initialise Pluginvar options = {additionalFilterTriggers: [$('#quickfind')]};$('#demotable).tableFilter(options);});</script></head><body>Quick Find: <input type="text" id="quickfind"/><table id='demotable'><thead><tr><th>Col1</th><th>Col2</th><th>Col3</th></tr></thead><tbody><tr><td>Value 1</th><th>Value 2</th><th>V alue 3</th></tr>...</tbody>...Example 2: Adding an additional checkbox filterLet’s suppose that we have a Boolean column that we want to filter. The best way to do this will be to add a check box filter so let’s do this. We will keep the quick find filter to show how to have multiple additional filters.<head>...<script type="text/javascript">$(document).ready(function() {// Initialise Pluginvar options = {additionalFilterTriggers: [$('#onlyyes'), $('#quickfind')],matchingRow: function(state, tr, textTokens) {if (!state || state.id != 'onlyyes') { return true; }return state.value != true || tr.children('td:eq(2)').text() == 'yes';}};$('#demotable').tableFilter(options);});</script></head><body>Only Show Yes: <input type="checkbox" id="onlyyes"/>Quick Find: <input type="text" id="quickfind"/><table id='demotable'><thead><tr><th>Col1</th><th>Col2</th><th>Boolean Col3</th></tr></thead><tbody><tr><td>Value 1</th><th>Value 2</th><th>yes</th></tr>...</tbody></table>...Example 3: Clear filtersHaving a clear filters button comes in very handy, especially when you have a table with a larger number of columns. To add this functionality simply add your clickable control to the clearFiltersControls array.<head>...<script type="text/javascript">$(document).ready(function() {// Initialise Pluginvar options = {clearFiltersControls: [$('#cleanfilters')],};$('#demotable').tableFilter(options);});</script></head><body><a id="cleanfilters" href="#">Clear Filters</a><br/><table id='demotable'><thead><tr><th>Col1</th><th>Col2</th><th>Col3</th></tr> </thead><tbody><tr><td>Value 1</th><th>Value 2</th><th>Value 3</th></tr>...</tbody></table>...。
