examples/docs/output/Ext.ux.grid.GridFilters.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.ux.grid.GridFilters-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.ux.grid.GridFilters-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.ux.grid.GridFilters-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.ux.grid.GridFilters-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.ux.grid.GridFilters"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/GridFilters.html#cls-Ext.ux.grid.GridFilters">Ext.ux.grid.GridFilters</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.ux.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/GridFilters.html#cls-Ext.ux.grid.GridFilters">GridFilters.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/GridFilters.html#cls-Ext.ux.grid.GridFilters">GridFilters</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"><p>GridFilter is a plugin (<code>ptype=<em>'gridfilters'</em></code>) for grids that
   2 allow for a slightly more robust representation of filtering than what is
   3 provided by the default store.</p>
   4 <p>Filtering is adjusted by the user using the grid's column header menu
   5 (this menu can be disabled through configuration). Through this menu users
   6 can configure, enable, and disable filters for each column.</p>
   7 <p><b><u>Features:</u></b></p>
   8 <div class="mdetail-params"><ul>
   9 <li><b>Filtering implementations</b> :
  10 <div class="sub-desc">
  11 Default filtering for Strings, Numeric Ranges, Date Ranges, Lists (which can
  12 be backed by a Ext.data.Store), and Boolean. Additional custom filter types
  13 and menus are easily created by extending Ext.ux.grid.filter.Filter.
  14 </div></li>
  15 <li><b>Graphical indicators</b> :
  16 <div class="sub-desc">
  17 Columns that are filtered have <a href="output/Ext.ux.grid.GridFilters.html#Ext.ux.grid.GridFilters-filterCls" ext:member="filterCls" ext:cls="Ext.ux.grid.GridFilters">a configurable css class</a>
  18 applied to the column headers.
  19 </div></li>
  20 <li><b>Paging</b> :
  21 <div class="sub-desc">
  22 If specified as a plugin to the grid's configured PagingToolbar, the current page
  23 will be reset to page 1 whenever you update the filters.
  24 </div></li>
  25 <li><b>Automatic Reconfiguration</b> :
  26 <div class="sub-desc">
  27 Filters automatically reconfigure when the grid 'reconfigure' event fires.
  28 </div></li>
  29 <li><b>Stateful</b> :
  30 Filter information will be persisted across page loads by specifying a
  31 <code>stateId</code> in the Grid configuration.
  32 <div class="sub-desc">
  33 The filter collection binds to the
  34 <code><a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-beforestaterestore" ext:member="beforestaterestore" ext:cls="Ext.grid.GridPanel">beforestaterestore</a></code>
  35 and <code><a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-beforestatesave" ext:member="beforestatesave" ext:cls="Ext.grid.GridPanel">beforestatesave</a></code>
  36 events in order to be stateful.
  37 </div></li>
  38 <li><b>Grid Changes</b> :
  39 <div class="sub-desc"><ul>
  40 <li>A <code>filters</code> <i>property</i> is added to the grid pointing to
  41 this plugin.</li>
  42 <li>A <code>filterupdate</code> <i>event</i> is added to the grid and is
  43 fired upon onStateChange completion.</li>
  44 </ul></div></li>
  45 <li><b>Server side code examples</b> :
  46 <div class="sub-desc"><ul>
  47 <li><a href="http://www.vinylfox.com/extjs/grid-filter-php-backend-code.php">PHP</a> - (Thanks VinylFox)</li>
  48 <li><a href="http://extjs.com/forum/showthread.php?p=77326#post77326">Ruby on Rails</a> - (Thanks Zyclops)</li>
  49 <li><a href="http://extjs.com/forum/showthread.php?p=176596#post176596">Ruby on Rails</a> - (Thanks Rotomaul)</li>
  50 <li><a href="http://www.debatablybeta.com/posts/using-extjss-grid-filtering-with-django/">Python</a> - (Thanks Matt)</li>
  51 <li><a href="http://mcantrell.wordpress.com/2008/08/22/extjs-grids-and-grails/">Grails</a> - (Thanks Mike)</li>
  52 </ul></div></li>
  53 </ul></div>
  54 <p><b><u>Example usage:</u></b></p>
  55 <pre><code><b>var</b> store = <b>new</b> Ext.data.GroupingStore({
  56     ...
  57 });
  58
  59 <b>var</b> filters = <b>new</b> Ext.ux.grid.GridFilters({
  60     autoReload: false, <i>//don&#39;t reload automatically</i>
  61     local: true, <i>//only filter locally</i>
  62     <i>// filters may be configured through the plugin,</i>
  63     <i>// or <b>in</b> the column definition within the column model configuration</i>
  64     filters: [{
  65         type: <em>'numeric'</em>,
  66         dataIndex: <em>'id'</em>
  67     }, {
  68         type: <em>'string'</em>,
  69         dataIndex: <em>'name'</em>
  70     }, {
  71         type: <em>'numeric'</em>,
  72         dataIndex: <em>'price'</em>
  73     }, {
  74         type: <em>'date'</em>,
  75         dataIndex: <em>'dateAdded'</em>
  76     }, {
  77         type: <em>'list'</em>,
  78         dataIndex: <em>'size'</em>,
  79         options: [<em>'extra small'</em>, <em>'small'</em>, <em>'medium'</em>, <em>'large'</em>, <em>'extra large'</em>],
  80         phpMode: true
  81     }, {
  82         type: <em>'boolean'</em>,
  83         dataIndex: <em>'visible'</em>
  84     }]
  85 });
  86 <b>var</b> cm = <b>new</b> Ext.grid.ColumnModel([{
  87     ...
  88 }]);
  89
  90 <b>var</b> grid = <b>new</b> Ext.grid.GridPanel({
  91      ds: store,
  92      cm: cm,
  93      view: <b>new</b> Ext.grid.GroupingView(),
  94      plugins: [filters],
  95      height: 400,
  96      width: 700,
  97      bbar: <b>new</b> Ext.PagingToolbar({
  98          store: store,
  99          pageSize: 15,
 100          plugins: [filters] <i>//reset page to page 1 <b>if</b> filters change</i>
 101      })
 102  });
 103
 104 store.load({params: {start: 0, limit: 15}});
 105
 106 <i>// a filters property is added to the grid</i>
 107 grid.filters</code></pre></div><div class="hr"></div><a id="Ext.ux.grid.GridFilters-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-autoReload"></a><b><a href="source/GridFilters.html#cfg-Ext.ux.grid.GridFilters-autoReload">autoReload</a></b> : Boolean<div class="mdesc"><div class="short">Defaults to true, reloading the datasource when a filter change happens.
 108 Set this to false to prevent the datastore f...</div><div class="long">Defaults to true, reloading the datasource when a filter change happens.
 109 Set this to false to prevent the datastore from being reloaded if there
 110 are changes to the filters.  See <code><a href="output/updateBuffer.html" ext:cls="updateBuffer">updateBuffer</a></code>.</div></div></td><td class="msource">GridFilters</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-autoReload"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.grid.GridFilters-autoReload">autoReload</a></b> : Boolean<div class="mdesc"><div class="short">Defaults to true, reloading the datasource when a filter change happens.
 111 Set this to false to prevent the datastore f...</div><div class="long">Defaults to true, reloading the datasource when a filter change happens.
 112 Set this to false to prevent the datastore from being reloaded if there
 113 are changes to the filters.  See <code><a href="output/updateBuffer.html" ext:cls="updateBuffer">updateBuffer</a></code>.</div></div></td><td class="msource">GridFilters</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-encode"></a><b><a href="source/GridFilters.html#cfg-Ext.ux.grid.GridFilters-encode">encode</a></b> : Boolean<div class="mdesc"><div class="short">Specify true for buildQuery to use Ext.util.JSON.encode to
 114 encode the filter query parameter sent with a remote reque...</div><div class="long">Specify true for <a href="output/Ext.ux.grid.GridFilters.html#Ext.ux.grid.GridFilters-buildQuery" ext:member="buildQuery" ext:cls="Ext.ux.grid.GridFilters">buildQuery</a> to use Ext.util.JSON.encode to
 115 encode the filter query parameter sent with a remote request.
 116 Defaults to false.</div></div></td><td class="msource">GridFilters</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-encode"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.grid.GridFilters-encode">encode</a></b> : Boolean<div class="mdesc"><div class="short">Specify true for buildQuery to use Ext.util.JSON.encode to
 117 encode the filter query parameter sent with a remote reque...</div><div class="long">Specify true for <a href="output/Ext.ux.grid.GridFilters.html#Ext.ux.grid.GridFilters-buildQuery" ext:member="buildQuery" ext:cls="Ext.ux.grid.GridFilters">buildQuery</a> to use Ext.util.JSON.encode to
 118 encode the filter query parameter sent with a remote request.
 119 Defaults to false.</div></div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-filterCls"></a><b><a href="source/GridFilters.html#cfg-Ext.ux.grid.GridFilters-filterCls">filterCls</a></b> : String<div class="mdesc">The css class to be applied to column headers with active filters.
 120 Defaults to <tt>'ux-filterd-column'</tt>.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-filterCls"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.grid.GridFilters-filterCls">filterCls</a></b> : String<div class="mdesc">The css class to be applied to column headers with active filters.
 121 Defaults to <tt>'ux-filterd-column'</tt>.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-filters"></a><b><a href="source/GridFilters.html#cfg-Ext.ux.grid.GridFilters-filters">filters</a></b> : Array<div class="mdesc"><div class="short">An Array of filters config objects. Refer to each filter type class for
 122 configuration details specific to each filter...</div><div class="long">An Array of filters config objects. Refer to each filter type class for
 123 configuration details specific to each filter type. Filters for Strings,
 124 Numeric Ranges, Date Ranges, Lists, and Boolean are the standard filters
 125 available.</div></div></td><td class="msource">GridFilters</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-filters"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.grid.GridFilters-filters">filters</a></b> : Array<div class="mdesc"><div class="short">An Array of filters config objects. Refer to each filter type class for
 126 configuration details specific to each filter...</div><div class="long">An Array of filters config objects. Refer to each filter type class for
 127 configuration details specific to each filter type. Filters for Strings,
 128 Numeric Ranges, Date Ranges, Lists, and Boolean are the standard filters
 129 available.</div></div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-local"></a><b><a href="source/GridFilters.html#cfg-Ext.ux.grid.GridFilters-local">local</a></b> : Boolean<div class="mdesc"><tt>true</tt> to use Ext.data.Store filter functions (local filtering)
 130 instead of the default (<tt>false</tt>) server side filtering.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-local"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.grid.GridFilters-local">local</a></b> : Boolean<div class="mdesc"><tt>true</tt> to use Ext.data.Store filter functions (local filtering)
 131 instead of the default (<tt>false</tt>) server side filtering.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-menuFilterText"></a><b><a href="source/GridFilters.html#cfg-Ext.ux.grid.GridFilters-menuFilterText">menuFilterText</a></b> : String<div class="mdesc">defaults to <tt>'Filters'</tt>.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-menuFilterText"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.grid.GridFilters-menuFilterText">menuFilterText</a></b> : String<div class="mdesc">defaults to <tt>'Filters'</tt>.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-paramPrefix"></a><b><a href="source/GridFilters.html#cfg-Ext.ux.grid.GridFilters-paramPrefix">paramPrefix</a></b> : String<div class="mdesc">The url parameter prefix for the filters.
 132 Defaults to <tt>'filter'</tt>.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-paramPrefix"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.grid.GridFilters-paramPrefix">paramPrefix</a></b> : String<div class="mdesc">The url parameter prefix for the filters.
 133 Defaults to <tt>'filter'</tt>.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-showMenu"></a><b><a href="source/GridFilters.html#cfg-Ext.ux.grid.GridFilters-showMenu">showMenu</a></b> : Boolean<div class="mdesc">Defaults to true, including a filter submenu in the default header menu.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-showMenu"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.grid.GridFilters-showMenu">showMenu</a></b> : Boolean<div class="mdesc">Defaults to true, including a filter submenu in the default header menu.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-stateId"></a><b><a href="source/GridFilters.html#cfg-Ext.ux.grid.GridFilters-stateId">stateId</a></b> : String<div class="mdesc">Name of the value to be used to store state information.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-stateId"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.grid.GridFilters-stateId">stateId</a></b> : String<div class="mdesc">Name of the value to be used to store state information.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-updateBuffer"></a><b><a href="source/GridFilters.html#cfg-Ext.ux.grid.GridFilters-updateBuffer">updateBuffer</a></b> : Integer<div class="mdesc">Number of milliseconds to defer store updates since the last filter change.</div></td><td class="msource">GridFilters</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-updateBuffer"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.grid.GridFilters-updateBuffer">updateBuffer</a></b> : Integer<div class="mdesc">Number of milliseconds to defer store updates since the last filter change.</div></td><td class="msource">GridFilters</td></tr></tbody></table><a id="Ext.ux.grid.GridFilters-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.ux.grid.GridFilters-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-addFilter"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-addFilter">addFilter</a></b>(&nbsp;<code>Object/Ext.ux.grid.filter.Filter&nbsp;config</code>&nbsp;)
 134     :
 135                                         Ext.ux.grid.filter.Filter<div class="mdesc"><div class="short">Adds a filter to the collection and observes it for state change.</div><div class="long">Adds a filter to the collection and observes it for state change.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object/Ext.ux.grid.filter.Filter<div class="sub-desc">A filter configuration or a filter object.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.ux.grid.filter.Filter</code><div class="sub-desc">The existing or newly created filter object.</div></li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-addFilters"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-addFilters">addFilters</a></b>(&nbsp;<code>Array/Ext.grid.ColumnModel&nbsp;filters</code>&nbsp;)
 136     :
 137                                         void<div class="mdesc"><div class="short">Adds filters to the collection.</div><div class="long">Adds filters to the collection.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>filters</code> : Array/Ext.grid.ColumnModel<div class="sub-desc">Either an Array of
 138 filter configuration objects or an Ext.grid.ColumnModel.  The columns
 139 of a passed Ext.grid.ColumnModel will be examined for a <code>filter</code>
 140 property and, if present, will be used as the filter configuration object.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-bindStore"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-bindStore">bindStore</a></b>(&nbsp;<code>Store&nbsp;store</code>&nbsp;)
 141     :
 142                                         void<div class="mdesc"><div class="short">Changes the data store bound to this view and refreshes it.</div><div class="long">Changes the data store bound to this view and refreshes it.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>store</code> : Store<div class="sub-desc">The store to bind to this view</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-buildQuery"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-buildQuery">buildQuery</a></b>(&nbsp;<code>Array&nbsp;filters</code>&nbsp;)
 143     :
 144                                         Object<div class="mdesc"><div class="short">Function to take the active filters data and build it into a query.
 145 The format of the query depends on the encode
 146 con...</div><div class="long">Function to take the active filters data and build it into a query.
 147 The format of the query depends on the <code><a href="output/Ext.ux.grid.GridFilters.html#Ext.ux.grid.GridFilters-encode" ext:member="encode" ext:cls="Ext.ux.grid.GridFilters">encode</a></code>
 148 configuration:
 149 <div class="mdetail-params"><ul>
 150 <li><b><tt>false</tt></b> : <i>Default</i>
 151 <div class="sub-desc">
 152 Flatten into query string of the form (assuming <code><a href="output/Ext.ux.grid.GridFilters.html#Ext.ux.grid.GridFilters-paramPrefix" ext:member="paramPrefix" ext:cls="Ext.ux.grid.GridFilters">paramPrefix</a>=<em>'filters'</em></code>:
 153 <pre><code>filters[0][field]=<em>"someDataIndex"</em>&
 154 filters[0][data][comparison]=<em>"someValue1"</em>&
 155 filters[0][data][type]=<em>"someValue2"</em>&
 156 filters[0][data][value]=<em>"someValue3"</em>&</code></pre>
 157 </div></li>
 158 <li><b><tt>true</tt></b> :
 159 <div class="sub-desc">
 160 JSON encode the filter data
 161 <pre><code>filters[0][field]=<em>"someDataIndex"</em>&
 162 filters[0][data][comparison]=<em>"someValue1"</em>&
 163 filters[0][data][type]=<em>"someValue2"</em>&
 164 filters[0][data][value]=<em>"someValue3"</em>&</code></pre>
 165 </div></li>
 166 </ul></div>
 167 Override this method to customize the format of the filter query for remote requests.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>filters</code> : Array<div class="sub-desc">A collection of objects representing active filters and their configuration.
 168 Each element will take the form of {field: dataIndex, data: filterConf}. dataIndex is not assured
 169 to be unique as any one filter may be a composite of more basic filters for the same dataIndex.</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">Query keys and values</div></li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-cleanParams"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-cleanParams">cleanParams</a></b>(&nbsp;<code>Object&nbsp;p</code>&nbsp;)
 170     :
 171                                         void<div class="mdesc"><div class="short">Removes filter related query parameters from the provided object.</div><div class="long">Removes filter related query parameters from the provided object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>p</code> : Object<div class="sub-desc">Query parameters that may contain filter related fields.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-clearFilters"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-clearFilters">clearFilters</a></b>()
 172     :
 173                                         void<div class="mdesc"><div class="short">Turns all filters off. This does not clear the configuration information
 174 (see removeAll).</div><div class="long">Turns all filters off. This does not clear the configuration information
 175 (see <a href="output/Ext.ux.grid.GridFilters.html#Ext.ux.grid.GridFilters-removeAll" ext:member="removeAll" ext:cls="Ext.ux.grid.GridFilters">removeAll</a>).<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-getFilter"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-getFilter">getFilter</a></b>(&nbsp;<code>String&nbsp;dataIndex</code>&nbsp;)
 176     :
 177                                         Ext.ux.grid.filter.Filter<div class="mdesc"><div class="short">Returns a filter for the given dataIndex, if one exists.</div><div class="long">Returns a filter for the given dataIndex, if one exists.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>dataIndex</code> : String<div class="sub-desc">The dataIndex of the desired filter object.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.ux.grid.filter.Filter</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-getFilterClass"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-getFilterClass">getFilterClass</a></b>(&nbsp;<code>String&nbsp;type</code>&nbsp;)
 178     :
 179                                         Class<div class="mdesc"><div class="short">Function for locating filter classes, overwrite this with your favorite
 180 loader to provide dynamic filter loading.</div><div class="long">Function for locating filter classes, overwrite this with your favorite
 181 loader to provide dynamic filter loading.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>type</code> : String<div class="sub-desc">The type of filter to load ('Filter' is automatically
 182 appended to the passed type; eg, 'string' becomes 'StringFilter').</div></li></ul><strong>Returns:</strong><ul><li><code>Class</code><div class="sub-desc">The Ext.ux.grid.filter.Class</div></li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-getFilterData"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-getFilterData">getFilterData</a></b>()
 183     :
 184                                         Array<div class="mdesc"><div class="short">Returns an Array of the currently active filters.</div><div class="long">Returns an Array of the currently active filters.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">filters Array of the currently active filters.</div></li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-removeAll"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-removeAll">removeAll</a></b>()
 185     :
 186                                         void<div class="mdesc"><div class="short">Remove all filters, permanently destroying them.</div><div class="long">Remove all filters, permanently destroying them.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-saveState"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-saveState">saveState</a></b>(&nbsp;<code>Object&nbsp;grid</code>,&nbsp;<code>Object&nbsp;state</code>&nbsp;)
 187     :
 188                                         Boolean<div class="mdesc"><div class="short">Saves the state of all active filters</div><div class="long">Saves the state of all active filters<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>grid</code> : Object<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">GridFilters</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.GridFilters-updateColumnHeadings"></a><b><a href="source/ux-all-debug.html#method-Ext.ux.grid.GridFilters-updateColumnHeadings">updateColumnHeadings</a></b>()
 189     :
 190                                         void<div class="mdesc"><div class="short">Update the styles for the header row based on the active filters</div><div class="long">Update the styles for the header row based on the active filters<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">GridFilters</td></tr></tbody></table><a id="Ext.ux.grid.GridFilters-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>