Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.grid.property.Store.html
1 <!DOCTYPE html><html><head><title>Ext.grid.property.Store | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.grid.property.Store',
13         docClass: 'Ext.grid.property.Store',
14         docReq: 'Ext.grid.property.Store',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Store.html#Ext-grid.property.Store';
33     clsInfo = {"methods":["Store","add","addEvents","addListener","addManagedListener","aggregate","average","capture","clearFilter","clearGrouping","clearListeners","clearManagedListeners","collect","count","each","enableBubble","filter","filterBy","find","findBy","findExact","findRecord","fireEvent","first","getAt","getById","getCount","getGroupString","getGroups","getNewRecords","getPageFromRecordIndex","getProxy","getRange","getSortState","getTotalCount","getUpdatedRecords","group","guaranteeRange","hasListener","hasPendingRequests","indexOf","indexOfId","indexOfTotal","initSortable","insert","isFiltered","isGrouped","isLoading","last","load","loadData","loadPage","loadRecords","max","min","nextPage","observe","on","prefetch","prefetchPage","previousPage","purgeRecords","queryBy","relayEvents","releaseCapture","remove","removeAll","removeAt","removeListener","removeManagedListener","resumeEvents","setProxy","sort","sum","suspendEvents","sync","un"],"cfgs":["autoLoad","autoSync","buffered","clearOnPageLoad","data","fields","listeners","model","proxy","purgePageCount","remoteFilter","remoteGroup","remoteSort","sortOnFilter","storeId"],"properties":["","batchUpdateMode","currentPage","data","defaultProxyType","defaultSortDirection","filterOnLoad","filters","groupDir","groupField","groupers","isDestroyed","isSortable","pageSize","removeAll","snapshot","sortOnLoad","sortRoot","sorters"],"events":["add","beforeload","beforeprefetch","beforesync","clear","datachanged","groupchange","load","remove","update"],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Store.html#Ext-grid.property.Store" target="_blank">Ext.grid.property.Store</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.data.AbstractStore.html" rel="Ext.data.AbstractStore" class="cls docClass">Ext.data.AbstractStore</a><div class="subclass"><a href="Ext.data.Store.html" rel="Ext.data.Store" class="cls docClass">Ext.data.Store</a><div class="subclass"><strong>Ext.grid.property.Store</strong></div></div></div><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div><div class="mixin"><a href="Ext.util.Sortable.html" rel="Ext.util.Sortable" class="cls docClass">Ext.util.Sortable</a></div></pre><p>A custom <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Ext.data.Store</a> for the <a href="Ext.grid.property.Grid.html" rel="Ext.grid.property.Grid" class="docClass">Ext.grid.property.Grid</a>. This class handles the mapping
38 between the custom data source objects supported by the grid and the <a href="Ext.grid.property.Property.html" rel="Ext.grid.property.Property" class="docClass">Ext.grid.property.Property</a> format
39 used by the <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Ext.data.Store</a> base class.</p>
40 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-autoLoad" class="member f inherited"><a href="Ext.grid.property.Store.html#config-autoLoad" rel="config-autoLoad" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-cfg-autoLoad" class="viewSource">view source</a></div><a name="autoLoad"></a><a name="config-autoLoad"></a><a href="Ext.grid.property.Store.html#" rel="config-autoLoad" class="cls expand">autoLoad</a><span> : Boolean/Object</span></div><div class="description"><div class="short">If data is not specified, and if autoLoad is true or an Object, this store's load method
41 is automatically called afte...</div><div class="long"><p>If data is not specified, and if autoLoad is true or an Object, this store's load method
42 is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's
43 load method. Defaults to false.</p>
44 </div></div></div><div id="config-autoSync" class="member inherited"><a href="Ext.grid.property.Store.html#config-autoSync" rel="config-autoSync" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-cfg-autoSync" class="viewSource">view source</a></div><a name="autoSync"></a><a name="config-autoSync"></a><a href="Ext.grid.property.Store.html#" rel="config-autoSync" class="cls expand">autoSync</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to automatically sync the Store with its Proxy after every edit to one of its Records.
45 Defaults to false.</p>
46 </div><div class="long"><p>True to automatically sync the Store with its Proxy after every edit to one of its Records.
47 Defaults to false.</p>
48 </div></div></div><div id="config-buffered" class="member inherited"><a href="Ext.grid.property.Store.html#config-buffered" rel="config-buffered" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-cfg-buffered" class="viewSource">view source</a></div><a name="buffered"></a><a name="config-buffered"></a><a href="Ext.grid.property.Store.html#" rel="config-buffered" class="cls expand">buffered</a><span> : Boolean</span></div><div class="description"><div class="short">Allow the store to buffer and pre-fetch pages of records. This is to be used in conjunction with a view will
49 tell the...</div><div class="long"><p>Allow the store to buffer and pre-fetch pages of records. This is to be used in conjunction with a view will
50 tell the store to pre-fetch records ahead of a time.</p>
51 </div></div></div><div id="config-clearOnPageLoad" class="member inherited"><a href="Ext.grid.property.Store.html#config-clearOnPageLoad" rel="config-clearOnPageLoad" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-cfg-clearOnPageLoad" class="viewSource">view source</a></div><a name="clearOnPageLoad"></a><a name="config-clearOnPageLoad"></a><a href="Ext.grid.property.Store.html#" rel="config-clearOnPageLoad" class="cls expand">clearOnPageLoad</a><span> : Boolean</span></div><div class="description"><div class="short">True to empty the store when loading another page via loadPage,
52 nextPage or previousPage (defaults to true). Setting ...</div><div class="long"><p>True to empty the store when loading another page via <a href="Ext.grid.property.Store.html#loadPage" rel="Ext.grid.property.Store#loadPage" class="docClass">loadPage</a>,
53 <a href="Ext.grid.property.Store.html#nextPage" rel="Ext.grid.property.Store#nextPage" class="docClass">nextPage</a> or <a href="Ext.grid.property.Store.html#previousPage" rel="Ext.grid.property.Store#previousPage" class="docClass">previousPage</a> (defaults to true). Setting to false keeps existing records, allowing
54 large data sets to be loaded one page at a time but rendered all together.</p>
55 </div></div></div><div id="config-data" class="member inherited"><a href="Ext.grid.property.Store.html#config-data" rel="config-data" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-cfg-data" class="viewSource">view source</a></div><a name="data"></a><a name="config-data"></a><a href="Ext.grid.property.Store.html#" rel="config-data" class="cls expand">data</a><span> : Array</span></div><div class="description"><div class="short"><p>Optional array of Model instances or data objects to load locally. See "Inline data" above for details.</p>
56 </div><div class="long"><p>Optional array of Model instances or data objects to load locally. See "Inline data" above for details.</p>
57 </div></div></div><div id="config-fields" class="member inherited"><a href="Ext.grid.property.Store.html#config-fields" rel="config-fields" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-cfg-fields" class="viewSource">view source</a></div><a name="fields"></a><a name="config-fields"></a><a href="Ext.grid.property.Store.html#" rel="config-fields" class="cls expand">fields</a><span> : Array</span></div><div class="description"><div class="short">This may be used in place of specifying a model configuration. The fields should be a
58 set of Ext.data.Field configura...</div><div class="long"><p>This may be used in place of specifying a <a href="Ext.grid.property.Store.html#model" rel="Ext.grid.property.Store#model" class="docClass">model</a> configuration. The fields should be a
59 set of <a href="Ext.data.Field.html" rel="Ext.data.Field" class="docClass">Ext.data.Field</a> configuration objects. The store will automatically create a <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a>
60 with these fields. In general this configuration option should be avoided, it exists for the purposes of
61 backwards compatibility. For anything more complicated, such as specifying a particular id property or
62 assocations, a <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a> should be defined and specified for the <a href="Ext.grid.property.Store.html#model" rel="Ext.grid.property.Store#model" class="docClass">model</a> config.</p>
63 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.grid.property.Store.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.grid.property.Store.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
64 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
65 object during initialization.  This should be a valid listeners config object as specified in the
66 <a href="Ext.grid.property.Store.html#addListener" rel="Ext.grid.property.Store#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
67
68 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
69
70
71 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
72
73
74 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
75 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
76 events directly from a child element of a Component, we need to specify the <code>element</code> option to
77 identify the Component property to add a DOM listener to:</p>
78
79 <pre><code>new Ext.panel.Panel({
80     width: 400,
81     height: 200,
82     dockedItems: [{
83         xtype: 'toolbar'
84     }],
85     listeners: {
86         click: {
87             element: 'el', //bind to the underlying el property on the panel
88             fn: function(){ console.log('click el'); }
89         },
90         dblclick: {
91             element: 'body', //bind to the underlying body property on the panel
92             fn: function(){ console.log('dblclick body'); }
93         }
94     }
95 });
96 </code></pre>
97
98
99 <p></p></p>
100 </div></div></div><div id="config-model" class="member inherited"><a href="Ext.grid.property.Store.html#config-model" rel="config-model" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-cfg-model" class="viewSource">view source</a></div><a name="model"></a><a name="config-model"></a><a href="Ext.grid.property.Store.html#" rel="config-model" class="cls expand">model</a><span> : String</span></div><div class="description"><div class="short"><p>The <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a> associated with this store</p>
101 </div><div class="long"><p>The <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a> associated with this store</p>
102 </div></div></div><div id="config-proxy" class="member inherited"><a href="Ext.grid.property.Store.html#config-proxy" rel="config-proxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-cfg-proxy" class="viewSource">view source</a></div><a name="proxy"></a><a name="config-proxy"></a><a href="Ext.grid.property.Store.html#" rel="config-proxy" class="cls expand">proxy</a><span> : String/Ext.data.proxy.Proxy/Object</span></div><div class="description"><div class="short">The Proxy to use for this Store. This can be either a string, a config
103 object or a Proxy instance - see setProxy for ...</div><div class="long"><p>The Proxy to use for this Store. This can be either a string, a config
104 object or a Proxy instance - see <a href="Ext.grid.property.Store.html#setProxy" rel="Ext.grid.property.Store#setProxy" class="docClass">setProxy</a> for details.</p>
105 </div></div></div><div id="config-purgePageCount" class="member inherited"><a href="Ext.grid.property.Store.html#config-purgePageCount" rel="config-purgePageCount" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-cfg-purgePageCount" class="viewSource">view source</a></div><a name="purgePageCount"></a><a name="config-purgePageCount"></a><a href="Ext.grid.property.Store.html#" rel="config-purgePageCount" class="cls expand">purgePageCount</a><span> : Number</span></div><div class="description"><div class="short">The number of pages to keep in the cache before purging additional records. A value of 0 indicates to never purge the...</div><div class="long"><p>The number of pages to keep in the cache before purging additional records. A value of 0 indicates to never purge the prefetched data.
106 This option is only relevant when the <a href="Ext.grid.property.Store.html#buffered" rel="Ext.grid.property.Store#buffered" class="docClass">buffered</a> option is set to true.</p>
107 </div></div></div><div id="config-remoteFilter" class="member inherited"><a href="Ext.grid.property.Store.html#config-remoteFilter" rel="config-remoteFilter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-cfg-remoteFilter" class="viewSource">view source</a></div><a name="remoteFilter"></a><a name="config-remoteFilter"></a><a href="Ext.grid.property.Store.html#" rel="config-remoteFilter" class="cls expand">remoteFilter</a><span> : Boolean</span></div><div class="description"><div class="short">True to defer any filtering operation to the server. If false, filtering is done locally on the client. Defaults to f...</div><div class="long"><p>True to defer any filtering operation to the server. If false, filtering is done locally on the client. Defaults to <tt>false</tt>.</p>
108 </div></div></div><div id="config-remoteGroup" class="member inherited"><a href="Ext.grid.property.Store.html#config-remoteGroup" rel="config-remoteGroup" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-cfg-remoteGroup" class="viewSource">view source</a></div><a name="remoteGroup"></a><a name="config-remoteGroup"></a><a href="Ext.grid.property.Store.html#" rel="config-remoteGroup" class="cls expand">remoteGroup</a><span> : Boolean</span></div><div class="description"><div class="short">True if the grouping should apply on the server side, false if it is local only (defaults to false).  If the
109 grouping...</div><div class="long"><p>True if the grouping should apply on the server side, false if it is local only (defaults to false).  If the
110 grouping is local, it can be applied immediately to the data.  If it is remote, then it will simply act as a
111 helper, automatically sending the grouping information to the server.</p>
112 </div></div></div><div id="config-remoteSort" class="member inherited"><a href="Ext.grid.property.Store.html#config-remoteSort" rel="config-remoteSort" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-cfg-remoteSort" class="viewSource">view source</a></div><a name="remoteSort"></a><a name="config-remoteSort"></a><a href="Ext.grid.property.Store.html#" rel="config-remoteSort" class="cls expand">remoteSort</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to defer any sorting operation to the server. If false, sorting is done locally on the client. Defaults to <tt>false</tt>.</p>
113 </div><div class="long"><p>True to defer any sorting operation to the server. If false, sorting is done locally on the client. Defaults to <tt>false</tt>.</p>
114 </div></div></div><div id="config-sortOnFilter" class="member inherited"><a href="Ext.grid.property.Store.html#config-sortOnFilter" rel="config-sortOnFilter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-cfg-sortOnFilter" class="viewSource">view source</a></div><a name="sortOnFilter"></a><a name="config-sortOnFilter"></a><a href="Ext.grid.property.Store.html#" rel="config-sortOnFilter" class="cls expand">sortOnFilter</a><span> : Boolean</span></div><div class="description"><div class="short">For local filtering only, causes sort to be called whenever filter is called,
115 causing the sorters to be reapplied aft...</div><div class="long"><p>For local filtering only, causes <a href="Ext.grid.property.Store.html#sort" rel="Ext.grid.property.Store#sort" class="docClass">sort</a> to be called whenever <a href="Ext.grid.property.Store.html#filter" rel="Ext.grid.property.Store#filter" class="docClass">filter</a> is called,
116 causing the sorters to be reapplied after filtering. Defaults to true</p>
117 </div></div></div><div id="config-storeId" class="member inherited"><a href="Ext.grid.property.Store.html#config-storeId" rel="config-storeId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-cfg-storeId" class="viewSource">view source</a></div><a name="storeId"></a><a name="config-storeId"></a><a href="Ext.grid.property.Store.html#" rel="config-storeId" class="cls expand">storeId</a><span> : String</span></div><div class="description"><div class="short">Optional unique identifier for this store. If present, this Store will be registered with
118 the Ext.data.StoreManager, ...</div><div class="long"><p>Optional unique identifier for this store. If present, this Store will be registered with
119 the <a href="Ext.data.StoreManager.html" rel="Ext.data.StoreManager" class="docClass">Ext.data.StoreManager</a>, making it easy to reuse elsewhere. Defaults to undefined.</p>
120 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-" class="member f inherited"><a href="Ext.grid.property.Store.html#property-" rel="property-" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-property-" class="viewSource">view source</a></div><a></a><a name="property-"></a><a href="Ext.grid.property.Store.html#" rel="property-" class="cls expand"></a><span> : Object</span></div><div class="description"><div class="short">Loop over each record returned from the server. Assume they are
121 returned in order of how they were sent. If we find a...</div><div class="long"><p>Loop over each record returned from the server. Assume they are
122 returned in order of how they were sent. If we find a matching
123 record, replace it with the newly created one.</p>
124 </div></div></div><div id="property-batchUpdateMode" class="member inherited"><a href="Ext.grid.property.Store.html#property-batchUpdateMode" rel="property-batchUpdateMode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-batchUpdateMode" class="viewSource">view source</a></div><a name="batchUpdateMode"></a><a name="property-batchUpdateMode"></a><a href="Ext.grid.property.Store.html#" rel="property-batchUpdateMode" class="cls expand">batchUpdateMode</a><span> : String</span></div><div class="description"><div class="short">Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's
125 internal...</div><div class="long"><p>Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's
126 internal representation of the data after each operation of the batch has completed, 'complete' will wait until
127 the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local
128 storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.</p>
129 </div></div></div><div id="property-currentPage" class="member inherited"><a href="Ext.grid.property.Store.html#property-currentPage" rel="property-currentPage" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-property-currentPage" class="viewSource">view source</a></div><a name="currentPage"></a><a name="property-currentPage"></a><a href="Ext.grid.property.Store.html#" rel="property-currentPage" class="cls expand">currentPage</a><span> : Number</span></div><div class="description"><div class="short"><p>The page that the Store has most recently loaded (see <a href="Ext.grid.property.Store.html#loadPage" rel="Ext.grid.property.Store#loadPage" class="docClass">loadPage</a>)</p>
130 </div><div class="long"><p>The page that the Store has most recently loaded (see <a href="Ext.grid.property.Store.html#loadPage" rel="Ext.grid.property.Store#loadPage" class="docClass">loadPage</a>)</p>
131 </div></div></div><div id="property-data" class="member inherited"><a href="Ext.grid.property.Store.html#property-data" rel="property-data" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-property-data" class="viewSource">view source</a></div><a name="data"></a><a name="property-data"></a><a href="Ext.grid.property.Store.html#" rel="property-data" class="cls expand">data</a><span> : Ext.util.MixedCollection</span></div><div class="description"><div class="short"><p>The MixedCollection that holds this store's local cache of records</p>
132 </div><div class="long"><p>The MixedCollection that holds this store's local cache of records</p>
133 </div></div></div><div id="property-defaultProxyType" class="member inherited"><a href="Ext.grid.property.Store.html#property-defaultProxyType" rel="property-defaultProxyType" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-defaultProxyType" class="viewSource">view source</a></div><a name="defaultProxyType"></a><a name="property-defaultProxyType"></a><a href="Ext.grid.property.Store.html#" rel="property-defaultProxyType" class="cls expand">defaultProxyType</a><span> : String</span></div><div class="description"><div class="short"><p>The string type of the Proxy to create if none is specified. This defaults to creating a <a href="Ext.data.proxy.Memory.html" rel="Ext.data.proxy.Memory" class="docClass">memory proxy</a>.</p>
134 </div><div class="long"><p>The string type of the Proxy to create if none is specified. This defaults to creating a <a href="Ext.data.proxy.Memory.html" rel="Ext.data.proxy.Memory" class="docClass">memory proxy</a>.</p>
135 </div></div></div><div id="property-defaultSortDirection" class="member inherited"><a href="Ext.grid.property.Store.html#property-defaultSortDirection" rel="property-defaultSortDirection" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-defaultSortDirection" class="viewSource">view source</a></div><a name="defaultSortDirection"></a><a name="property-defaultSortDirection"></a><a href="Ext.grid.property.Store.html#" rel="property-defaultSortDirection" class="cls expand">defaultSortDirection</a><span> : String</span></div><div class="description"><div class="short"><p>The default sort direction to use if one is not specified (defaults to "ASC")</p>
136 </div><div class="long"><p>The default sort direction to use if one is not specified (defaults to "ASC")</p>
137 </div></div></div><div id="property-filterOnLoad" class="member inherited"><a href="Ext.grid.property.Store.html#property-filterOnLoad" rel="property-filterOnLoad" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-filterOnLoad" class="viewSource">view source</a></div><a name="filterOnLoad"></a><a name="property-filterOnLoad"></a><a href="Ext.grid.property.Store.html#" rel="property-filterOnLoad" class="cls expand">filterOnLoad</a><span> : Boolean</span></div><div class="description"><div class="short">If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired.
138 De...</div><div class="long"><p>If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired.
139 Defaults to true, ignored if <a href="Ext.grid.property.Store.html#remoteFilter" rel="Ext.grid.property.Store#remoteFilter" class="docClass">remoteFilter</a> is true</p>
140 </div></div></div><div id="property-filters" class="member inherited"><a href="Ext.grid.property.Store.html#property-filters" rel="property-filters" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-filters" class="viewSource">view source</a></div><a name="filters"></a><a name="property-filters"></a><a href="Ext.grid.property.Store.html#" rel="property-filters" class="cls expand">filters</a><span> : Ext.util.MixedCollection</span></div><div class="description"><div class="short"><p>The collection of <a href="Ext.util.Filter.html" rel="Ext.util.Filter" class="docClass">Filters</a> currently applied to this Store</p>
141 </div><div class="long"><p>The collection of <a href="Ext.util.Filter.html" rel="Ext.util.Filter" class="docClass">Filters</a> currently applied to this Store</p>
142 </div></div></div><div id="property-groupDir" class="member inherited"><a href="Ext.grid.property.Store.html#property-groupDir" rel="property-groupDir" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-property-groupDir" class="viewSource">view source</a></div><a name="groupDir"></a><a name="property-groupDir"></a><a href="Ext.grid.property.Store.html#" rel="property-groupDir" class="cls expand">groupDir</a><span> : String</span></div><div class="description"><div class="short"><p>The direction in which sorting should be applied when grouping. Defaults to "ASC" - the other supported value is "DESC"</p>
143 </div><div class="long"><p>The direction in which sorting should be applied when grouping. Defaults to "ASC" - the other supported value is "DESC"</p>
144 </div></div></div><div id="property-groupField" class="member inherited"><a href="Ext.grid.property.Store.html#property-groupField" rel="property-groupField" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-property-groupField" class="viewSource">view source</a></div><a name="groupField"></a><a name="property-groupField"></a><a href="Ext.grid.property.Store.html#" rel="property-groupField" class="cls expand">groupField</a><span> : String</span></div><div class="description"><div class="short">The (optional) field by which to group data in the store. Internally, grouping is very similar to sorting - the
145 group...</div><div class="long"><p>The (optional) field by which to group data in the store. Internally, grouping is very similar to sorting - the
146 groupField and <a href="Ext.grid.property.Store.html#groupDir" rel="Ext.grid.property.Store#groupDir" class="docClass">groupDir</a> are injected as the first sorter (see <a href="Ext.grid.property.Store.html#sort" rel="Ext.grid.property.Store#sort" class="docClass">sort</a>). Stores support a single
147 level of grouping, and groups can be fetched via the <a href="Ext.grid.property.Store.html#getGroups" rel="Ext.grid.property.Store#getGroups" class="docClass">getGroups</a> method.</p>
148 </div></div></div><div id="property-groupers" class="member inherited"><a href="Ext.grid.property.Store.html#property-groupers" rel="property-groupers" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-property-groupers" class="viewSource">view source</a></div><a name="groupers"></a><a name="property-groupers"></a><a href="Ext.grid.property.Store.html#" rel="property-groupers" class="cls expand">groupers</a><span> : Ext.util.MixedCollection</span></div><div class="description"><div class="short"><p>The collection of <a href="Ext.util.Grouper.html" rel="Ext.util.Grouper" class="docClass">Groupers</a> currently applied to this Store</p>
149 </div><div class="long"><p>The collection of <a href="Ext.util.Grouper.html" rel="Ext.util.Grouper" class="docClass">Groupers</a> currently applied to this Store</p>
150 </div></div></div><div id="property-isDestroyed" class="member inherited"><a href="Ext.grid.property.Store.html#property-isDestroyed" rel="property-isDestroyed" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-isDestroyed" class="viewSource">view source</a></div><a name="isDestroyed"></a><a name="property-isDestroyed"></a><a href="Ext.grid.property.Store.html#" rel="property-isDestroyed" class="cls expand">isDestroyed</a><span> : Boolean</span></div><div class="description"><div class="short">True if the Store has already been destroyed via destroyStore. If this is true, the reference to Store should be dele...</div><div class="long"><p>True if the Store has already been destroyed via <a href="Ext.grid.property.Store.html#destroyStore" rel="Ext.grid.property.Store#destroyStore" class="docClass">destroyStore</a>. If this is true, the reference to Store should be deleted
151 as it will not function correctly any more.</p>
152 </div></div></div><div id="property-isSortable" class="member inherited"><a href="Ext.grid.property.Store.html#property-isSortable" rel="property-isSortable" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-isSortable" class="viewSource">view source</a></div><a name="isSortable"></a><a name="property-isSortable"></a><a href="Ext.grid.property.Store.html#" rel="property-isSortable" class="cls expand">isSortable</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Flag denoting that this object is sortable. Always true.</p>
153 </div><div class="long"><p>Flag denoting that this object is sortable. Always true.</p>
154 </div></div></div><div id="property-pageSize" class="member inherited"><a href="Ext.grid.property.Store.html#property-pageSize" rel="property-pageSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-property-pageSize" class="viewSource">view source</a></div><a name="pageSize"></a><a name="property-pageSize"></a><a href="Ext.grid.property.Store.html#" rel="property-pageSize" class="cls expand">pageSize</a><span> : Number</span></div><div class="description"><div class="short">The number of records considered to form a 'page'. This is used to power the built-in
155 paging using the nextPage and p...</div><div class="long"><p>The number of records considered to form a 'page'. This is used to power the built-in
156 paging using the nextPage and previousPage functions. Defaults to 25.</p>
157 </div></div></div><div id="property-removeAll" class="member inherited"><a href="Ext.grid.property.Store.html#property-removeAll" rel="property-removeAll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-removeAll" class="viewSource">view source</a></div><a name="removeAll"></a><a name="property-removeAll"></a><a href="Ext.grid.property.Store.html#" rel="property-removeAll" class="cls expand">removeAll</a><span> : Object</span></div><div class="description"><div class="short">Removes all records from the store. This method does a "fast remove",
158 individual remove events are not called. The cl...</div><div class="long"><p>Removes all records from the store. This method does a "fast remove",
159 individual remove events are not called. The <a href="Ext.grid.property.Store.html#clear" rel="Ext.grid.property.Store#clear" class="docClass">clear</a> event is
160 fired upon completion.</p>
161 </div></div></div><div id="property-snapshot" class="member inherited"><a href="Ext.grid.property.Store.html#property-snapshot" rel="property-snapshot" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-property-snapshot" class="viewSource">view source</a></div><a name="snapshot"></a><a name="property-snapshot"></a><a href="Ext.grid.property.Store.html#" rel="property-snapshot" class="cls expand">snapshot</a><span> : Ext.util.MixedCollection</span></div><div class="description"><div class="short">A pristine (unfiltered) collection of the records in this store. This is used to reinstate
162 records when a filter is r...</div><div class="long"><p>A pristine (unfiltered) collection of the records in this store. This is used to reinstate
163 records when a filter is removed or changed</p>
164 </div></div></div><div id="property-sortOnLoad" class="member inherited"><a href="Ext.grid.property.Store.html#property-sortOnLoad" rel="property-sortOnLoad" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-property-sortOnLoad" class="viewSource">view source</a></div><a name="sortOnLoad"></a><a name="property-sortOnLoad"></a><a href="Ext.grid.property.Store.html#" rel="property-sortOnLoad" class="cls expand">sortOnLoad</a><span> : Boolean</span></div><div class="description"><div class="short">If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired.
165 De...</div><div class="long"><p>If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired.
166 Defaults to true, igored if <a href="Ext.grid.property.Store.html#remoteSort" rel="Ext.grid.property.Store#remoteSort" class="docClass">remoteSort</a> is true</p>
167 </div></div></div><div id="property-sortRoot" class="member inherited"><a href="Ext.grid.property.Store.html#property-sortRoot" rel="property-sortRoot" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-sortRoot" class="viewSource">view source</a></div><a name="sortRoot"></a><a name="property-sortRoot"></a><a href="Ext.grid.property.Store.html#" rel="property-sortRoot" class="cls expand">sortRoot</a><span> : String</span></div><div class="description"><div class="short"><p>The property in each item that contains the data to sort. (defaults to null)</p>
168 </div><div class="long"><p>The property in each item that contains the data to sort. (defaults to null)</p>
169 </div></div></div><div id="property-sorters" class="member inherited"><a href="Ext.grid.property.Store.html#property-sorters" rel="property-sorters" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-property-sorters" class="viewSource">view source</a></div><a name="sorters"></a><a name="property-sorters"></a><a href="Ext.grid.property.Store.html#" rel="property-sorters" class="cls expand">sorters</a><span> : Ext.util.MixedCollection</span></div><div class="description"><div class="short"><p>The collection of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Sorters</a> currently applied to this Store</p>
170 </div><div class="long"><p>The collection of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Sorters</a> currently applied to this Store</p>
171 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Store" class="member f ni"><a href="Ext.grid.property.Store.html#method-Store" rel="method-Store" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.property.Store.html" class="definedIn docClass">Ext.grid.property.Store</a><br/><a href="../source/Store.html#Ext-grid.property.Store-method-constructor" class="viewSource">view source</a></div><a name="Store"></a><a name="method-Store"></a><a href="Ext.grid.property.Store.html#" rel="method-Store" class="cls expand">Store</a>(
172 <span class="pre">Ext.grid.Grid grid, Object source</span>)
173  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
174 <h3 class="pa">Parameters</h3><ul><li><span class="pre">grid</span> : Ext.grid.Grid<div class="sub-desc"><p>The grid this store will be bound to</p>
175 </div></li><li><span class="pre">source</span> : Object<div class="sub-desc"><p>The source data config object</p>
176 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
177 </li></ul></div></div></div><div id="method-add" class="member inherited"><a href="Ext.grid.property.Store.html#method-add" rel="method-add" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-add" class="viewSource">view source</a></div><a name="add"></a><a name="method-add"></a><a href="Ext.grid.property.Store.html#" rel="method-add" class="cls expand">add</a>(
178 <span class="pre">Object data</span>)
179  : Array</div><div class="description"><div class="short">Adds Model instances to the Store by instantiating them based on a JavaScript object. When adding already-
180 instantiat...</div><div class="long"><p>Adds Model instances to the Store by instantiating them based on a JavaScript object. When adding already-
181 instantiated Models, use <a href="Ext.grid.property.Store.html#insert" rel="Ext.grid.property.Store#insert" class="docClass">insert</a> instead. The instances will be added at the end of the existing collection.
182 This method accepts either a single argument array of Model instances or any number of model instance arguments.
183 Sample usage:</p>
184
185 <pre><code>myStore.add({some: 'data'}, {some: 'other data'});
186 </code></pre>
187
188 <h3 class="pa">Parameters</h3><ul><li><span class="pre">data</span> : Object<div class="sub-desc"><p>The data for each model</p>
189 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The array of newly created model instances</p>
190 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.grid.property.Store.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.grid.property.Store.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
191 <span class="pre">Object/String o, String </span>)
192  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
193 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
194 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
195 or the first event name string if multiple event names are being passed as separate parameters.</p>
196 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
197 Usage:</p>
198
199 <pre><code>this.addEvents('storeloaded', 'storecleared');
200 </code></pre>
201
202 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
203 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.grid.property.Store.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.grid.property.Store.html#" rel="method-addListener" class="cls expand">addListener</a>(
204 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
205  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
206 </div><div class="long"><p>Appends an event handler to this object.</p>
207 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
208 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
209 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
210 <b>If omitted, defaults to the object which fired the event.</b></p>
211 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
212 properties. This may contain any of the following properties:<ul>
213 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
214 <b>If omitted, defaults to the object which fired the event.</b></div></li>
215 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
216 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
217 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
218 by the specified number of milliseconds. If the event fires again within that time, the original
219 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
220 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
221 if the event was bubbled up from a child Observable.</div></li>
222 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
223 The name of a Component property which references an element to add a listener to.</p>
224
225 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
226 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
227 <pre><code>new Ext.panel.Panel({
228     title: 'The title',
229     listeners: {
230         click: this.handlePanelClick,
231         element: 'body'
232     }
233 });
234 </code></pre></p>
235
236
237 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
238
239
240 <p></div></li>
241 </ul><br></p>
242
243 <p>
244 <b>Combining Options</b><br>
245 Using the options argument, it is possible to combine different types of listeners:<br>
246 <br>
247 A delayed, one-time listener.
248 <pre><code>myPanel.on('hide', this.handleClick, this, {
249 single: true,
250 delay: 100
251 });</code></pre>
252 <p>
253 <b>Attaching multiple handlers in 1 call</b><br>
254 The method also allows for a single argument to be passed which is a config object containing properties
255 which specify multiple events. For example:
256 <pre><code>myGridPanel.on({
257     cellClick: this.onCellClick,
258     mouseover: this.onMouseOver,
259     mouseout: this.onMouseOut,
260     scope: this // Important. Ensure "this" is correct during handler execution
261 });
262 </code></pre>.
263 <p>
264
265 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
266 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.grid.property.Store.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.grid.property.Store.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
267 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
268  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
269 is destroyed.
270
271 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
272 is destroyed.
273
274 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
275 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
276 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
277 is the handler function.</p>
278 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
279 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
280 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
281 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
282 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
283 </li></ul></div></div></div><div id="method-aggregate" class="member inherited"><a href="Ext.grid.property.Store.html#method-aggregate" rel="method-aggregate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-aggregate" class="viewSource">view source</a></div><a name="aggregate"></a><a name="method-aggregate"></a><a href="Ext.grid.property.Store.html#" rel="method-aggregate" class="cls expand">aggregate</a>(
284 <span class="pre">Function fn, [Object scope], Boolean grouped, [Array args]</span>)
285  : Object</div><div class="description"><div class="short"><p>Runs the aggregate function for all the records in the store.</p>
286 </div><div class="long"><p>Runs the aggregate function for all the records in the store.</p>
287 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to execute. The function is called with a single parameter,
288 an array of records for that group.</p>
289 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope to execute the function in. Defaults to the store.</p>
290 </div></li><li><span class="pre">grouped</span> : Boolean<div class="sub-desc"><p>(Optional) True to perform the operation for each group
291 in the store. The value returned will be an object literal with the key being the group
292 name and the group average being the value. The grouped parameter is only honored if
293 the store has a groupField.</p>
294 </div></li><li><span class="pre">args</span> : Array<div class="sub-desc"><p>(optional) Any arguments to append to the function call</p>
295 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>An object literal with the group names and their appropriate values.</p>
296 </li></ul></div></div></div><div id="method-average" class="member inherited"><a href="Ext.grid.property.Store.html#method-average" rel="method-average" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-average" class="viewSource">view source</a></div><a name="average"></a><a name="method-average"></a><a href="Ext.grid.property.Store.html#" rel="method-average" class="cls expand">average</a>(
297 <span class="pre">String field, Boolean grouped</span>)
298  : Mixed/undefined</div><div class="description"><div class="short"><p>Gets the average value in the store.</p>
299 </div><div class="long"><p>Gets the average value in the store.</p>
300 <h3 class="pa">Parameters</h3><ul><li><span class="pre">field</span> : String<div class="sub-desc"><p>The field in each record</p>
301 </div></li><li><span class="pre">grouped</span> : Boolean<div class="sub-desc"><p>(Optional) True to perform the operation for each group
302 in the store. The value returned will be an object literal with the key being the group
303 name and the group average being the value. The grouped parameter is only honored if
304 the store has a groupField.</p>
305 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed/undefined</span>&nbsp; &nbsp;<p>The average value, if no items exist, 0.</p>
306 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.grid.property.Store.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.grid.property.Store.html#" rel="method-capture" class="cls expand">capture</a>(
307 <span class="pre">Observable o, Function fn, [Object scope]</span>)
308  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
309 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
310 to the supplied function with the event name + standard signature of the event
311 <b>before</b> the event is fired. If the supplied function returns false,
312 the event will not fire.</p>
313 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
314 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
315 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
316 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
317 </li></ul></div></div></div><div id="method-clearFilter" class="member inherited"><a href="Ext.grid.property.Store.html#method-clearFilter" rel="method-clearFilter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-clearFilter" class="viewSource">view source</a></div><a name="clearFilter"></a><a name="method-clearFilter"></a><a href="Ext.grid.property.Store.html#" rel="method-clearFilter" class="cls expand">clearFilter</a>(
318 <span class="pre">Boolean suppressEvent</span>)
319  : void</div><div class="description"><div class="short"><p>Revert to a view of the Record cache with no filtering applied.</p>
320 </div><div class="long"><p>Revert to a view of the Record cache with no filtering applied.</p>
321 <h3 class="pa">Parameters</h3><ul><li><span class="pre">suppressEvent</span> : Boolean<div class="sub-desc"><p>If <tt>true</tt> the filter is cleared silently without firing the
322 <a href="Ext.grid.property.Store.html#datachanged" rel="Ext.grid.property.Store#datachanged" class="docClass">datachanged</a> event.</p>
323 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
324 </li></ul></div></div></div><div id="method-clearGrouping" class="member inherited"><a href="Ext.grid.property.Store.html#method-clearGrouping" rel="method-clearGrouping" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-clearGrouping" class="viewSource">view source</a></div><a name="clearGrouping"></a><a name="method-clearGrouping"></a><a href="Ext.grid.property.Store.html#" rel="method-clearGrouping" class="cls expand">clearGrouping</a> : void</div><div class="description"><div class="short"><p>Clear any groupers in the store</p>
325 </div><div class="long"><p>Clear any groupers in the store</p>
326 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
327 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.grid.property.Store.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.grid.property.Store.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
328 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
329 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
330 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.grid.property.Store.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.grid.property.Store.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
331 </div><div class="long"><p>Removes all managed listeners for this object.</p>
332 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
333 </li></ul></div></div></div><div id="method-collect" class="member inherited"><a href="Ext.grid.property.Store.html#method-collect" rel="method-collect" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-collect" class="viewSource">view source</a></div><a name="collect"></a><a name="method-collect"></a><a href="Ext.grid.property.Store.html#" rel="method-collect" class="cls expand">collect</a>(
334 <span class="pre">String dataIndex, [Boolean allowNull], [Boolean bypassFilter]</span>)
335  : Array</div><div class="description"><div class="short"><p>Collects unique values for a particular dataIndex from this store.</p>
336 </div><div class="long"><p>Collects unique values for a particular dataIndex from this store.</p>
337 <h3 class="pa">Parameters</h3><ul><li><span class="pre">dataIndex</span> : String<div class="sub-desc"><p>The property to collect</p>
338 </div></li><li><span class="pre">allowNull</span> : Boolean<div class="sub-desc"><p>(optional) Pass true to allow null, undefined or empty string values</p>
339 </div></li><li><span class="pre">bypassFilter</span> : Boolean<div class="sub-desc"><p>(optional) Pass true to collect from all records, even ones which are filtered</p>
340 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>An array of the unique values</p>
341 </li></ul></div></div></div><div id="method-count" class="member inherited"><a href="Ext.grid.property.Store.html#method-count" rel="method-count" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-count" class="viewSource">view source</a></div><a name="count"></a><a name="method-count"></a><a href="Ext.grid.property.Store.html#" rel="method-count" class="cls expand">count</a>(
342 <span class="pre">Boolean grouped</span>)
343  : Number</div><div class="description"><div class="short"><p>Gets the count of items in the store.</p>
344 </div><div class="long"><p>Gets the count of items in the store.</p>
345 <h3 class="pa">Parameters</h3><ul><li><span class="pre">grouped</span> : Boolean<div class="sub-desc"><p>(Optional) True to perform the operation for each group
346 in the store. The value returned will be an object literal with the key being the group
347 name and the count for each group being the value. The grouped parameter is only honored if
348 the store has a groupField.</p>
349 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>the count</p>
350 </li></ul></div></div></div><div id="method-each" class="member inherited"><a href="Ext.grid.property.Store.html#method-each" rel="method-each" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-each" class="viewSource">view source</a></div><a name="each"></a><a name="method-each"></a><a href="Ext.grid.property.Store.html#" rel="method-each" class="cls expand">each</a>(
351 <span class="pre">Function fn, [Object scope]</span>)
352  : void</div><div class="description"><div class="short"><p>Calls the specified function for each of the <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Records</a> in the cache.</p>
353 </div><div class="long"><p>Calls the specified function for each of the <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Records</a> in the cache.</p>
354 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call. The <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Record</a> is passed as the first parameter.
355 Returning <tt>false</tt> aborts and exits the iteration.</p>
356 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed.
357 Defaults to the current <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Record</a> in the iteration.</p>
358 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
359 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.grid.property.Store.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.grid.property.Store.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
360 <span class="pre">String/Array events</span>)
361  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
362 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
363 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
364
365
366 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
367 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
368 access the required target more quickly.</p>
369
370
371 <p>Example:</p>
372
373
374 <pre><code>Ext.override(Ext.form.field.Base, {
375 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
376 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
377     this.enableBubble('change');
378 }),
379
380 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
381 getBubbleTarget : function() {
382     if (!this.formPanel) {
383         this.formPanel = this.findParentByType('form');
384     }
385     return this.formPanel;
386 }
387 });
388
389 var myForm = new Ext.formPanel({
390 title: 'User Details',
391 items: [{
392     ...
393 }],
394 listeners: {
395     change: function() {
396         // Title goes red if form has been modified.
397         myForm.header.setStyle('color', 'red');
398     }
399 }
400 });
401 </code></pre>
402
403 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
404 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
405 </li></ul></div></div></div><div id="method-filter" class="member inherited"><a href="Ext.grid.property.Store.html#method-filter" rel="method-filter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-filter" class="viewSource">view source</a></div><a name="filter"></a><a name="method-filter"></a><a href="Ext.grid.property.Store.html#" rel="method-filter" class="cls expand">filter</a>(
406 <span class="pre">Mixed filters, String value</span>)
407  : void</div><div class="description"><div class="short"><p>Filters the loaded set of records by a given set of filters.</p>
408 </div><div class="long"><p>Filters the loaded set of records by a given set of filters.</p>
409 <h3 class="pa">Parameters</h3><ul><li><span class="pre">filters</span> : Mixed<div class="sub-desc"><p>The set of filters to apply to the data. These are stored internally on the store,
410 but the filtering itself is done on the Store's <a href="Ext.util.MixedCollection.html" rel="Ext.util.MixedCollection" class="docClass">MixedCollection</a>. See
411 MixedCollection's <a href="Ext.util.MixedCollection.html#filter" rel="Ext.util.MixedCollection#filter" class="docClass">filter</a> method for filter syntax. Alternatively,
412 pass in a property string</p>
413 </div></li><li><span class="pre">value</span> : String<div class="sub-desc"><p>Optional value to filter by (only if using a property string as the first argument)</p>
414 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
415 </li></ul></div></div></div><div id="method-filterBy" class="member inherited"><a href="Ext.grid.property.Store.html#method-filterBy" rel="method-filterBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-filterBy" class="viewSource">view source</a></div><a name="filterBy"></a><a name="method-filterBy"></a><a href="Ext.grid.property.Store.html#" rel="method-filterBy" class="cls expand">filterBy</a>(
416 <span class="pre">Function fn, [Object scope]</span>)
417  : void</div><div class="description"><div class="short">Filter by a function. The specified function will be called for each
418 Record in this Store. If the function returns tr...</div><div class="long"><p>Filter by a function. The specified function will be called for each
419 Record in this Store. If the function returns <tt>true</tt> the Record is included,
420 otherwise it is filtered out.</p>
421 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to be called. It will be passed the following parameters:<ul>
422 <li><b>record</b> : Ext.data.Model<p class="sub-desc">The <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">record</a>
423 to test for filtering. Access field values using <a href="Ext.data.Model.html#get" rel="Ext.data.Model#get" class="docClass">Ext.data.Model.get</a>.</p></li>
424 <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
425 </ul></p>
426 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.</p>
427 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
428 </li></ul></div></div></div><div id="method-find" class="member inherited"><a href="Ext.grid.property.Store.html#method-find" rel="method-find" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-find" class="viewSource">view source</a></div><a name="find"></a><a name="method-find"></a><a href="Ext.grid.property.Store.html#" rel="method-find" class="cls expand">find</a>(
429 <span class="pre">String fieldName, String/RegExp value, [Number startIndex], [Boolean anyMatch], [Boolean caseSensitive], Boolean exactMatch</span>)
430  : Number</div><div class="description"><div class="short"><p>Finds the index of the first matching Record in this store by a specific field value.</p>
431 </div><div class="long"><p>Finds the index of the first matching Record in this store by a specific field value.</p>
432 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fieldName</span> : String<div class="sub-desc"><p>The name of the Record field to test.</p>
433 </div></li><li><span class="pre">value</span> : String/RegExp<div class="sub-desc"><p>Either a string that the field value
434 should begin with, or a RegExp to test against the field.</p>
435 </div></li><li><span class="pre">startIndex</span> : Number<div class="sub-desc"><p>(optional) The index to start searching at</p>
436 </div></li><li><span class="pre">anyMatch</span> : Boolean<div class="sub-desc"><p>(optional) True to match any part of the string, not just the beginning</p>
437 </div></li><li><span class="pre">caseSensitive</span> : Boolean<div class="sub-desc"><p>(optional) True for case sensitive comparison</p>
438 </div></li><li><span class="pre">exactMatch</span> : Boolean<div class="sub-desc"><p>True to force exact match (^ and $ characters added to the regex). Defaults to false.</p>
439 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The matched index or -1</p>
440 </li></ul></div></div></div><div id="method-findBy" class="member inherited"><a href="Ext.grid.property.Store.html#method-findBy" rel="method-findBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-findBy" class="viewSource">view source</a></div><a name="findBy"></a><a name="method-findBy"></a><a href="Ext.grid.property.Store.html#" rel="method-findBy" class="cls expand">findBy</a>(
441 <span class="pre">Function fn, [Object scope], [Number startIndex]</span>)
442  : Number</div><div class="description"><div class="short">Find the index of the first matching Record in this Store by a function.
443 If the function returns true it is considere...</div><div class="long"><p>Find the index of the first matching Record in this Store by a function.
444 If the function returns <tt>true</tt> it is considered a match.</p>
445 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to be called. It will be passed the following parameters:<ul>
446 <li><b>record</b> : Ext.data.Model<p class="sub-desc">The <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">record</a>
447 to test for filtering. Access field values using <a href="Ext.data.Model.html#get" rel="Ext.data.Model#get" class="docClass">Ext.data.Model.get</a>.</p></li>
448 <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
449 </ul></p>
450 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.</p>
451 </div></li><li><span class="pre">startIndex</span> : Number<div class="sub-desc"><p>(optional) The index to start searching at</p>
452 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The matched index or -1</p>
453 </li></ul></div></div></div><div id="method-findExact" class="member inherited"><a href="Ext.grid.property.Store.html#method-findExact" rel="method-findExact" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-findExact" class="viewSource">view source</a></div><a name="findExact"></a><a name="method-findExact"></a><a href="Ext.grid.property.Store.html#" rel="method-findExact" class="cls expand">findExact</a>(
454 <span class="pre">String fieldName, Mixed value, [Number startIndex]</span>)
455  : Number</div><div class="description"><div class="short"><p>Finds the index of the first matching Record in this store by a specific field value.</p>
456 </div><div class="long"><p>Finds the index of the first matching Record in this store by a specific field value.</p>
457 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fieldName</span> : String<div class="sub-desc"><p>The name of the Record field to test.</p>
458 </div></li><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The value to match the field against.</p>
459 </div></li><li><span class="pre">startIndex</span> : Number<div class="sub-desc"><p>(optional) The index to start searching at</p>
460 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The matched index or -1</p>
461 </li></ul></div></div></div><div id="method-findRecord" class="member inherited"><a href="Ext.grid.property.Store.html#method-findRecord" rel="method-findRecord" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-findRecord" class="viewSource">view source</a></div><a name="findRecord"></a><a name="method-findRecord"></a><a href="Ext.grid.property.Store.html#" rel="method-findRecord" class="cls expand">findRecord</a>(
462 <span class="pre">String fieldName, String/RegExp value, [Number startIndex], [Boolean anyMatch], [Boolean caseSensitive], Boolean exactMatch</span>)
463  : Ext.data.Model</div><div class="description"><div class="short"><p>Finds the first matching Record in this store by a specific field value.</p>
464 </div><div class="long"><p>Finds the first matching Record in this store by a specific field value.</p>
465 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fieldName</span> : String<div class="sub-desc"><p>The name of the Record field to test.</p>
466 </div></li><li><span class="pre">value</span> : String/RegExp<div class="sub-desc"><p>Either a string that the field value
467 should begin with, or a RegExp to test against the field.</p>
468 </div></li><li><span class="pre">startIndex</span> : Number<div class="sub-desc"><p>(optional) The index to start searching at</p>
469 </div></li><li><span class="pre">anyMatch</span> : Boolean<div class="sub-desc"><p>(optional) True to match any part of the string, not just the beginning</p>
470 </div></li><li><span class="pre">caseSensitive</span> : Boolean<div class="sub-desc"><p>(optional) True for case sensitive comparison</p>
471 </div></li><li><span class="pre">exactMatch</span> : Boolean<div class="sub-desc"><p>True to force exact match (^ and $ characters added to the regex). Defaults to false.</p>
472 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Model</span>&nbsp; &nbsp;<p>The matched record or null</p>
473 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.grid.property.Store.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.grid.property.Store.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
474 <span class="pre">String eventName, Object... args</span>)
475  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
476
477
478 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
479
480
481 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
482 by calling <a href="Ext.grid.property.Store.html#enableBubble" rel="Ext.grid.property.Store#enableBubble" class="docClass">enableBubble</a>.</p>
483
484 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
485 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
486 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
487 </li></ul></div></div></div><div id="method-first" class="member inherited"><a href="Ext.grid.property.Store.html#method-first" rel="method-first" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-first" class="viewSource">view source</a></div><a name="first"></a><a name="method-first"></a><a href="Ext.grid.property.Store.html#" rel="method-first" class="cls expand">first</a>(
488 <span class="pre">Boolean grouped</span>)
489  : Ext.data.Model/undefined</div><div class="description"><div class="short"><p>Convenience function for getting the first model instance in the store</p>
490 </div><div class="long"><p>Convenience function for getting the first model instance in the store</p>
491 <h3 class="pa">Parameters</h3><ul><li><span class="pre">grouped</span> : Boolean<div class="sub-desc"><p>(Optional) True to perform the operation for each group
492 in the store. The value returned will be an object literal with the key being the group
493 name and the first record being the value. The grouped parameter is only honored if
494 the store has a groupField.</p>
495 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Model/undefined</span>&nbsp; &nbsp;<p>The first model instance in the store, or undefined</p>
496 </li></ul></div></div></div><div id="method-getAt" class="member inherited"><a href="Ext.grid.property.Store.html#method-getAt" rel="method-getAt" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-getAt" class="viewSource">view source</a></div><a name="getAt"></a><a name="method-getAt"></a><a href="Ext.grid.property.Store.html#" rel="method-getAt" class="cls expand">getAt</a>(
497 <span class="pre">Number index</span>)
498  : Ext.data.Model</div><div class="description"><div class="short"><p>Get the Record at the specified index.</p>
499 </div><div class="long"><p>Get the Record at the specified index.</p>
500 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index of the Record to find.</p>
501 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Model</span>&nbsp; &nbsp;<p>The Record at the passed index. Returns undefined if not found.</p>
502 </li></ul></div></div></div><div id="method-getById" class="member inherited"><a href="Ext.grid.property.Store.html#method-getById" rel="method-getById" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-getById" class="viewSource">view source</a></div><a name="getById"></a><a name="method-getById"></a><a href="Ext.grid.property.Store.html#" rel="method-getById" class="cls expand">getById</a>(
503 <span class="pre">String id</span>)
504  : Ext.data.Model</div><div class="description"><div class="short"><p>Get the Record with the specified id.</p>
505 </div><div class="long"><p>Get the Record with the specified id.</p>
506 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the Record to find.</p>
507 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Model</span>&nbsp; &nbsp;<p>The Record with the passed id. Returns undefined if not found.</p>
508 </li></ul></div></div></div><div id="method-getCount" class="member inherited"><a href="Ext.grid.property.Store.html#method-getCount" rel="method-getCount" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-getCount" class="viewSource">view source</a></div><a name="getCount"></a><a name="method-getCount"></a><a href="Ext.grid.property.Store.html#" rel="method-getCount" class="cls expand">getCount</a> : Number</div><div class="description"><div class="short">Gets the number of cached records.
509
510 If using paging, this may not be the total size of the dataset. If the data objec...</div><div class="long"><p>Gets the number of cached records.</p>
511
512 <p>If using paging, this may not be the total size of the dataset. If the data object
513 used by the Reader contains the dataset size, then the <a href="Ext.grid.property.Store.html#getTotalCount" rel="Ext.grid.property.Store#getTotalCount" class="docClass">getTotalCount</a> function returns
514 the dataset size.  <b>Note</b>: see the Important note in <a href="Ext.grid.property.Store.html#load" rel="Ext.grid.property.Store#load" class="docClass">load</a>.</p>
515
516 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The number of Records in the Store's cache.</p>
517 </li></ul></div></div></div><div id="method-getGroupString" class="member inherited"><a href="Ext.grid.property.Store.html#method-getGroupString" rel="method-getGroupString" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-getGroupString" class="viewSource">view source</a></div><a name="getGroupString"></a><a name="method-getGroupString"></a><a href="Ext.grid.property.Store.html#" rel="method-getGroupString" class="cls expand">getGroupString</a>(
518 <span class="pre">Ext.data.Model instance</span>)
519  : String</div><div class="description"><div class="short">Returns the string to group on for a given model instance. The default implementation of this method returns
520 the mode...</div><div class="long"><p>Returns the string to group on for a given model instance. The default implementation of this method returns
521 the model's <a href="Ext.grid.property.Store.html#groupField" rel="Ext.grid.property.Store#groupField" class="docClass">groupField</a>, but this can be overridden to group by an arbitrary string. For example, to
522 group by the first letter of a model's 'name' field, use the following code:</p>
523
524
525 <pre><code>new Ext.data.Store({
526     groupDir: 'ASC',
527     getGroupString: function(instance) {
528         return instance.get('name')[0];
529     }
530 });
531 </code></pre>
532
533 <h3 class="pa">Parameters</h3><ul><li><span class="pre">instance</span> : Ext.data.Model<div class="sub-desc"><p>The model instance</p>
534 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The string to compare when forming groups</p>
535 </li></ul></div></div></div><div id="method-getGroups" class="member inherited"><a href="Ext.grid.property.Store.html#method-getGroups" rel="method-getGroups" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-getGroups" class="viewSource">view source</a></div><a name="getGroups"></a><a name="method-getGroups"></a><a href="Ext.grid.property.Store.html#" rel="method-getGroups" class="cls expand">getGroups</a>(
536 <span class="pre">String groupName</span>)
537  : Array</div><div class="description"><div class="short">Returns an object containing the result of applying grouping to the records in this store. See groupField,
538 groupDir a...</div><div class="long"><p>Returns an object containing the result of applying grouping to the records in this store. See <a href="Ext.grid.property.Store.html#groupField" rel="Ext.grid.property.Store#groupField" class="docClass">groupField</a>,
539 <a href="Ext.grid.property.Store.html#groupDir" rel="Ext.grid.property.Store#groupDir" class="docClass">groupDir</a> and <a href="Ext.grid.property.Store.html#getGroupString" rel="Ext.grid.property.Store#getGroupString" class="docClass">getGroupString</a>. Example for a store containing records with a color field:</p>
540
541 <pre><code>var myStore = new Ext.data.Store({
542     groupField: 'color',
543     groupDir  : 'DESC'
544 });
545
546 myStore.getGroups(); //returns:
547 [
548     {
549         name: 'yellow',
550         children: [
551             //all records where the color field is 'yellow'
552         ]
553     },
554     {
555         name: 'red',
556         children: [
557             //all records where the color field is 'red'
558         ]
559     }
560 ]
561 </code></pre>
562
563 <h3 class="pa">Parameters</h3><ul><li><span class="pre">groupName</span> : String<div class="sub-desc"><p>(Optional) Pass in an optional groupName argument to access a specific group as defined by <a href="Ext.grid.property.Store.html#getGroupString" rel="Ext.grid.property.Store#getGroupString" class="docClass">getGroupString</a></p>
564 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The grouped data</p>
565 </li></ul></div></div></div><div id="method-getNewRecords" class="member inherited"><a href="Ext.grid.property.Store.html#method-getNewRecords" rel="method-getNewRecords" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-getNewRecords" class="viewSource">view source</a></div><a name="getNewRecords"></a><a name="method-getNewRecords"></a><a href="Ext.grid.property.Store.html#" rel="method-getNewRecords" class="cls expand">getNewRecords</a> : Array</div><div class="description"><div class="short">Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not
566 yet bee...</div><div class="long"><p>Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not
567 yet been saved on this Store (this happens when adding a non-phantom record from another Store into this one)</p>
568 <h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The Model instances</p>
569 </li></ul></div></div></div><div id="method-getPageFromRecordIndex" class="member inherited"><a href="Ext.grid.property.Store.html#method-getPageFromRecordIndex" rel="method-getPageFromRecordIndex" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-getPageFromRecordIndex" class="viewSource">view source</a></div><a name="getPageFromRecordIndex"></a><a name="method-getPageFromRecordIndex"></a><a href="Ext.grid.property.Store.html#" rel="method-getPageFromRecordIndex" class="cls expand">getPageFromRecordIndex</a>(
570 <span class="pre">Number index</span>)
571  : Number</div><div class="description"><div class="short"><p>Determines the page from a record index</p>
572 </div><div class="long"><p>Determines the page from a record index</p>
573 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The record index</p>
574 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The page the record belongs to</p>
575 </li></ul></div></div></div><div id="method-getProxy" class="member inherited"><a href="Ext.grid.property.Store.html#method-getProxy" rel="method-getProxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-getProxy" class="viewSource">view source</a></div><a name="getProxy"></a><a name="method-getProxy"></a><a href="Ext.grid.property.Store.html#" rel="method-getProxy" class="cls expand">getProxy</a> : Ext.data.proxy.Proxy</div><div class="description"><div class="short"><p>Returns the proxy currently attached to this proxy instance</p>
576 </div><div class="long"><p>Returns the proxy currently attached to this proxy instance</p>
577 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.proxy.Proxy</span>&nbsp; &nbsp;<p>The Proxy instance</p>
578 </li></ul></div></div></div><div id="method-getRange" class="member inherited"><a href="Ext.grid.property.Store.html#method-getRange" rel="method-getRange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-getRange" class="viewSource">view source</a></div><a name="getRange"></a><a name="method-getRange"></a><a href="Ext.grid.property.Store.html#" rel="method-getRange" class="cls expand">getRange</a>(
579 <span class="pre">[Number startIndex], [Number endIndex]</span>)
580  : Ext.data.Model[]</div><div class="description"><div class="short"><p>Returns a range of Records between specified indices.</p>
581 </div><div class="long"><p>Returns a range of Records between specified indices.</p>
582 <h3 class="pa">Parameters</h3><ul><li><span class="pre">startIndex</span> : Number<div class="sub-desc"><p>(optional) The starting index (defaults to 0)</p>
583 </div></li><li><span class="pre">endIndex</span> : Number<div class="sub-desc"><p>(optional) The ending index (defaults to the last Record in the Store)</p>
584 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Model[]</span>&nbsp; &nbsp;<p>An array of Records</p>
585 </li></ul></div></div></div><div id="method-getSortState" class="member inherited"><a href="Ext.grid.property.Store.html#method-getSortState" rel="method-getSortState" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-method-getSortState" class="viewSource">view source</a></div><a name="getSortState"></a><a name="method-getSortState"></a><a href="Ext.grid.property.Store.html#" rel="method-getSortState" class="cls expand">getSortState</a> : Object</div><div class="description"><div class="short"><p>Returns an object describing the current sort state of this Store.</p>
586 </div><div class="long"><p>Returns an object describing the current sort state of this Store.</p>
587 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The sort state of the Store. An object with two properties:<ul>
588 <li><b>field</b> : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li>
589 <li><b>direction</b> : String<p class="sub-desc">The sort order, 'ASC' or 'DESC' (case-sensitive).</p></li>
590 </ul>
591 See <tt><a href="Ext.grid.property.Store.html#sortInfo" rel="Ext.grid.property.Store#sortInfo" class="docClass">sortInfo</a></tt> for additional details.</p>
592 </li></ul></div></div></div><div id="method-getTotalCount" class="member inherited"><a href="Ext.grid.property.Store.html#method-getTotalCount" rel="method-getTotalCount" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-getTotalCount" class="viewSource">view source</a></div><a name="getTotalCount"></a><a name="method-getTotalCount"></a><a href="Ext.grid.property.Store.html#" rel="method-getTotalCount" class="cls expand">getTotalCount</a> : Number</div><div class="description"><div class="short">Returns the total number of Model instances that the Proxy
593 indicates exist. This will usually differ from getCount wh...</div><div class="long"><p>Returns the total number of <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a> instances that the <a href="Ext.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="docClass">Proxy</a>
594 indicates exist. This will usually differ from <a href="Ext.grid.property.Store.html#getCount" rel="Ext.grid.property.Store#getCount" class="docClass">getCount</a> when using paging - getCount returns the
595 number of records loaded into the Store at the moment, getTotalCount returns the number of records that
596 could be loaded into the Store if the Store contained all data</p>
597 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The total number of Model instances available via the Proxy</p>
598 </li></ul></div></div></div><div id="method-getUpdatedRecords" class="member inherited"><a href="Ext.grid.property.Store.html#method-getUpdatedRecords" rel="method-getUpdatedRecords" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-getUpdatedRecords" class="viewSource">view source</a></div><a name="getUpdatedRecords"></a><a name="method-getUpdatedRecords"></a><a href="Ext.grid.property.Store.html#" rel="method-getUpdatedRecords" class="cls expand">getUpdatedRecords</a> : Array</div><div class="description"><div class="short"><p>Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy</p>
599 </div><div class="long"><p>Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy</p>
600 <h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The updated Model instances</p>
601 </li></ul></div></div></div><div id="method-group" class="member inherited"><a href="Ext.grid.property.Store.html#method-group" rel="method-group" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-group" class="viewSource">view source</a></div><a name="group"></a><a name="method-group"></a><a href="Ext.grid.property.Store.html#" rel="method-group" class="cls expand">group</a>(
602 <span class="pre">String|Array groupers, String direction</span>)
603  : void</div><div class="description"><div class="short"><p>Group data in the store</p>
604 </div><div class="long"><p>Group data in the store</p>
605 <h3 class="pa">Parameters</h3><ul><li><span class="pre">groupers</span> : String|Array<div class="sub-desc"><p>Either a string name of one of the fields in this Store's configured <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a>,
606 or an Array of grouper configurations.</p>
607 </div></li><li><span class="pre">direction</span> : String<div class="sub-desc"><p>The overall direction to group the data by. Defaults to "ASC".</p>
608 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
609 </li></ul></div></div></div><div id="method-guaranteeRange" class="member inherited"><a href="Ext.grid.property.Store.html#method-guaranteeRange" rel="method-guaranteeRange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-guaranteeRange" class="viewSource">view source</a></div><a name="guaranteeRange"></a><a name="method-guaranteeRange"></a><a href="Ext.grid.property.Store.html#" rel="method-guaranteeRange" class="cls expand">guaranteeRange</a>(
610 <span class="pre">Object start, Object end, Object cb, Object scope</span>)
611  : void</div><div class="description"><div class="short">Guarantee a specific range, this will load the store with a range (that
612 must be the pageSize or smaller) and take car...</div><div class="long"><p>Guarantee a specific range, this will load the store with a range (that
613 must be the pageSize or smaller) and take care of any loading that may
614 be necessary.</p>
615 <h3 class="pa">Parameters</h3><ul><li><span class="pre">start</span> : Object<div class="sub-desc">
616 </div></li><li><span class="pre">end</span> : Object<div class="sub-desc">
617 </div></li><li><span class="pre">cb</span> : Object<div class="sub-desc">
618 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc">
619 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
620 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.grid.property.Store.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.grid.property.Store.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
621 <span class="pre">String eventName</span>)
622  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
623 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
624 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
625 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
626 </li></ul></div></div></div><div id="method-hasPendingRequests" class="member inherited"><a href="Ext.grid.property.Store.html#method-hasPendingRequests" rel="method-hasPendingRequests" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-hasPendingRequests" class="viewSource">view source</a></div><a name="hasPendingRequests"></a><a name="method-hasPendingRequests"></a><a href="Ext.grid.property.Store.html#" rel="method-hasPendingRequests" class="cls expand">hasPendingRequests</a> : void</div><div class="description"><div class="short"><p>Returns the number of pending requests out.</p>
627 </div><div class="long"><p>Returns the number of pending requests out.</p>
628 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
629 </li></ul></div></div></div><div id="method-indexOf" class="member inherited"><a href="Ext.grid.property.Store.html#method-indexOf" rel="method-indexOf" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-indexOf" class="viewSource">view source</a></div><a name="indexOf"></a><a name="method-indexOf"></a><a href="Ext.grid.property.Store.html#" rel="method-indexOf" class="cls expand">indexOf</a>(
630 <span class="pre">Ext.data.Model record</span>)
631  : Number</div><div class="description"><div class="short"><p>Get the index within the cache of the passed Record.</p>
632 </div><div class="long"><p>Get the index within the cache of the passed Record.</p>
633 <h3 class="pa">Parameters</h3><ul><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a> object to find.</p>
634 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The index of the passed Record. Returns -1 if not found.</p>
635 </li></ul></div></div></div><div id="method-indexOfId" class="member inherited"><a href="Ext.grid.property.Store.html#method-indexOfId" rel="method-indexOfId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-indexOfId" class="viewSource">view source</a></div><a name="indexOfId"></a><a name="method-indexOfId"></a><a href="Ext.grid.property.Store.html#" rel="method-indexOfId" class="cls expand">indexOfId</a>(
636 <span class="pre">String id</span>)
637  : Number</div><div class="description"><div class="short"><p>Get the index within the cache of the Record with the passed id.</p>
638 </div><div class="long"><p>Get the index within the cache of the Record with the passed id.</p>
639 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id of the Record to find.</p>
640 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The index of the Record. Returns -1 if not found.</p>
641 </li></ul></div></div></div><div id="method-indexOfTotal" class="member inherited"><a href="Ext.grid.property.Store.html#method-indexOfTotal" rel="method-indexOfTotal" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-indexOfTotal" class="viewSource">view source</a></div><a name="indexOfTotal"></a><a name="method-indexOfTotal"></a><a href="Ext.grid.property.Store.html#" rel="method-indexOfTotal" class="cls expand">indexOfTotal</a>(
642 <span class="pre">Ext.data.Model record</span>)
643  : Number</div><div class="description"><div class="short"><p>Get the index within the entire dataset. From 0 to the totalCount.</p>
644 </div><div class="long"><p>Get the index within the entire dataset. From 0 to the totalCount.</p>
645 <h3 class="pa">Parameters</h3><ul><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a> object to find.</p>
646 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The index of the passed Record. Returns -1 if not found.</p>
647 </li></ul></div></div></div><div id="method-initSortable" class="member inherited"><a href="Ext.grid.property.Store.html#method-initSortable" rel="method-initSortable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-method-initSortable" class="viewSource">view source</a></div><a name="initSortable"></a><a name="method-initSortable"></a><a href="Ext.grid.property.Store.html#" rel="method-initSortable" class="cls expand">initSortable</a> : void</div><div class="description"><div class="short">Performs initialization of this mixin. Component classes using this mixin should call this method
648 during their own in...</div><div class="long"><p>Performs initialization of this mixin. Component classes using this mixin should call this method
649 during their own initialization.</p>
650 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
651 </li></ul></div></div></div><div id="method-insert" class="member inherited"><a href="Ext.grid.property.Store.html#method-insert" rel="method-insert" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-insert" class="viewSource">view source</a></div><a name="insert"></a><a name="method-insert"></a><a href="Ext.grid.property.Store.html#" rel="method-insert" class="cls expand">insert</a>(
652 <span class="pre">Number index, Ext.data.Model[] records</span>)
653  : void</div><div class="description"><div class="short"><p>Inserts Model instances into the Store at the given index and fires the <a href="Ext.grid.property.Store.html#add" rel="Ext.grid.property.Store#add" class="docClass">add</a> event.
654 See also <code><a href="Ext.grid.property.Store.html#add" rel="Ext.grid.property.Store#add" class="docClass">add</a></code>.</p>
655 </div><div class="long"><p>Inserts Model instances into the Store at the given index and fires the <a href="Ext.grid.property.Store.html#add" rel="Ext.grid.property.Store#add" class="docClass">add</a> event.
656 See also <code><a href="Ext.grid.property.Store.html#add" rel="Ext.grid.property.Store#add" class="docClass">add</a></code>.</p>
657 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The start index at which to insert the passed Records.</p>
658 </div></li><li><span class="pre">records</span> : Ext.data.Model[]<div class="sub-desc"><p>An Array of <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a> objects to add to the cache.</p>
659 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
660 </li></ul></div></div></div><div id="method-isFiltered" class="member inherited"><a href="Ext.grid.property.Store.html#method-isFiltered" rel="method-isFiltered" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-isFiltered" class="viewSource">view source</a></div><a name="isFiltered"></a><a name="method-isFiltered"></a><a href="Ext.grid.property.Store.html#" rel="method-isFiltered" class="cls expand">isFiltered</a> : Boolean</div><div class="description"><div class="short"><p>Returns true if this store is currently filtered</p>
661 </div><div class="long"><p>Returns true if this store is currently filtered</p>
662 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
663 </li></ul></div></div></div><div id="method-isGrouped" class="member inherited"><a href="Ext.grid.property.Store.html#method-isGrouped" rel="method-isGrouped" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-isGrouped" class="viewSource">view source</a></div><a name="isGrouped"></a><a name="method-isGrouped"></a><a href="Ext.grid.property.Store.html#" rel="method-isGrouped" class="cls expand">isGrouped</a> : Boolean</div><div class="description"><div class="short"><p>Checks if the store is currently grouped</p>
664 </div><div class="long"><p>Checks if the store is currently grouped</p>
665 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the store is grouped.</p>
666 </li></ul></div></div></div><div id="method-isLoading" class="member inherited"><a href="Ext.grid.property.Store.html#method-isLoading" rel="method-isLoading" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-isLoading" class="viewSource">view source</a></div><a name="isLoading"></a><a name="method-isLoading"></a><a href="Ext.grid.property.Store.html#" rel="method-isLoading" class="cls expand">isLoading</a> : Boolean</div><div class="description"><div class="short"><p>Returns true if the Store is currently performing a load operation</p>
667 </div><div class="long"><p>Returns true if the Store is currently performing a load operation</p>
668 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the Store is currently loading</p>
669 </li></ul></div></div></div><div id="method-last" class="member inherited"><a href="Ext.grid.property.Store.html#method-last" rel="method-last" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-last" class="viewSource">view source</a></div><a name="last"></a><a name="method-last"></a><a href="Ext.grid.property.Store.html#" rel="method-last" class="cls expand">last</a>(
670 <span class="pre">Boolean grouped</span>)
671  : Ext.data.Model/undefined</div><div class="description"><div class="short"><p>Convenience function for getting the last model instance in the store</p>
672 </div><div class="long"><p>Convenience function for getting the last model instance in the store</p>
673 <h3 class="pa">Parameters</h3><ul><li><span class="pre">grouped</span> : Boolean<div class="sub-desc"><p>(Optional) True to perform the operation for each group
674 in the store. The value returned will be an object literal with the key being the group
675 name and the last record being the value. The grouped parameter is only honored if
676 the store has a groupField.</p>
677 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Model/undefined</span>&nbsp; &nbsp;<p>The last model instance in the store, or undefined</p>
678 </li></ul></div></div></div><div id="method-load" class="member inherited"><a href="Ext.grid.property.Store.html#method-load" rel="method-load" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-load" class="viewSource">view source</a></div><a name="load"></a><a name="method-load"></a><a href="Ext.grid.property.Store.html#" rel="method-load" class="cls expand">load</a>(
679 <span class="pre">Object/Function options</span>)
680  : void</div><div class="description"><div class="short">Loads data into the Store via the configured proxy. This uses the Proxy to make an
681 asynchronous call to whatever stor...</div><div class="long"><p>Loads data into the Store via the configured <a href="Ext.grid.property.Store.html#proxy" rel="Ext.grid.property.Store#proxy" class="docClass">proxy</a>. This uses the Proxy to make an
682 asynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved
683 instances into the Store and calling an optional callback if required. Example usage:</p>
684
685
686
687
688 <pre><code>store.load({
689     scope   : this,
690     callback: function(records, operation, success) {
691         //the <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">operation</a> object contains all of the details of the load operation
692         console.log(records);
693     }
694 });
695 </code></pre>
696
697
698
699
700 <p>If the callback scope does not need to be set, a function can simply be passed:</p>
701
702
703
704
705 <pre><code>store.load(function(records, operation, success) {
706     console.log('loaded records');
707 });
708 </code></pre>
709
710 <h3 class="pa">Parameters</h3><ul><li><span class="pre">options</span> : Object/Function<div class="sub-desc"><p>Optional config object, passed into the <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Ext.data.Operation</a> object before loading.</p>
711 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
712 </li></ul></div></div></div><div id="method-loadData" class="member inherited"><a href="Ext.grid.property.Store.html#method-loadData" rel="method-loadData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-loadData" class="viewSource">view source</a></div><a name="loadData"></a><a name="method-loadData"></a><a href="Ext.grid.property.Store.html#" rel="method-loadData" class="cls expand">loadData</a>(
713 <span class="pre">Array data, Boolean append</span>)
714  : void</div><div class="description"><div class="short"><p>Loads an array of data straight into the Store</p>
715 </div><div class="long"><p>Loads an array of data straight into the Store</p>
716 <h3 class="pa">Parameters</h3><ul><li><span class="pre">data</span> : Array<div class="sub-desc"><p>Array of data to load. Any non-model instances will be cast into model instances first</p>
717 </div></li><li><span class="pre">append</span> : Boolean<div class="sub-desc"><p>True to add the records to the existing records in the store, false to remove the old ones first</p>
718 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
719 </li></ul></div></div></div><div id="method-loadPage" class="member inherited"><a href="Ext.grid.property.Store.html#method-loadPage" rel="method-loadPage" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-loadPage" class="viewSource">view source</a></div><a name="loadPage"></a><a name="method-loadPage"></a><a href="Ext.grid.property.Store.html#" rel="method-loadPage" class="cls expand">loadPage</a>(
720 <span class="pre">Number page</span>)
721  : void</div><div class="description"><div class="short">Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a norma...</div><div class="long"><p>Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a normal
722 load operation, passing in calculated 'start' and 'limit' params</p>
723 <h3 class="pa">Parameters</h3><ul><li><span class="pre">page</span> : Number<div class="sub-desc"><p>The number of the page to load</p>
724 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
725 </li></ul></div></div></div><div id="method-loadRecords" class="member inherited"><a href="Ext.grid.property.Store.html#method-loadRecords" rel="method-loadRecords" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-loadRecords" class="viewSource">view source</a></div><a name="loadRecords"></a><a name="method-loadRecords"></a><a href="Ext.grid.property.Store.html#" rel="method-loadRecords" class="cls expand">loadRecords</a>(
726 <span class="pre">Array records, Object options</span>)
727  : void</div><div class="description"><div class="short">Loads an array of {@Ext.data.Model model} instances into the store, fires the datachanged event. This should only usu...</div><div class="long"><p>Loads an array of {@Ext.data.Model model} instances into the store, fires the datachanged event. This should only usually
728 be called internally when loading from the <a href="Ext.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="docClass">Proxy</a>, when adding records manually use <a href="Ext.grid.property.Store.html#add" rel="Ext.grid.property.Store#add" class="docClass">add</a> instead</p>
729 <h3 class="pa">Parameters</h3><ul><li><span class="pre">records</span> : Array<div class="sub-desc"><p>The array of records to load</p>
730 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>{addRecords: true} to add these records to the existing records, false to remove the Store's existing records first</p>
731 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
732 </li></ul></div></div></div><div id="method-max" class="member inherited"><a href="Ext.grid.property.Store.html#method-max" rel="method-max" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-max" class="viewSource">view source</a></div><a name="max"></a><a name="method-max"></a><a href="Ext.grid.property.Store.html#" rel="method-max" class="cls expand">max</a>(
733 <span class="pre">String field, Boolean grouped</span>)
734  : Mixed/undefined</div><div class="description"><div class="short"><p>Gets the maximum value in the store.</p>
735 </div><div class="long"><p>Gets the maximum value in the store.</p>
736 <h3 class="pa">Parameters</h3><ul><li><span class="pre">field</span> : String<div class="sub-desc"><p>The field in each record</p>
737 </div></li><li><span class="pre">grouped</span> : Boolean<div class="sub-desc"><p>(Optional) True to perform the operation for each group
738 in the store. The value returned will be an object literal with the key being the group
739 name and the maximum in the group being the value. The grouped parameter is only honored if
740 the store has a groupField.</p>
741 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed/undefined</span>&nbsp; &nbsp;<p>The maximum value, if no items exist, undefined.</p>
742 </li></ul></div></div></div><div id="method-min" class="member inherited"><a href="Ext.grid.property.Store.html#method-min" rel="method-min" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-min" class="viewSource">view source</a></div><a name="min"></a><a name="method-min"></a><a href="Ext.grid.property.Store.html#" rel="method-min" class="cls expand">min</a>(
743 <span class="pre">String field, Boolean grouped</span>)
744  : Mixed/undefined</div><div class="description"><div class="short"><p>Gets the minimum value in the store.</p>
745 </div><div class="long"><p>Gets the minimum value in the store.</p>
746 <h3 class="pa">Parameters</h3><ul><li><span class="pre">field</span> : String<div class="sub-desc"><p>The field in each record</p>
747 </div></li><li><span class="pre">grouped</span> : Boolean<div class="sub-desc"><p>(Optional) True to perform the operation for each group
748 in the store. The value returned will be an object literal with the key being the group
749 name and the minimum in the group being the value. The grouped parameter is only honored if
750 the store has a groupField.</p>
751 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed/undefined</span>&nbsp; &nbsp;<p>The minimum value, if no items exist, undefined.</p>
752 </li></ul></div></div></div><div id="method-nextPage" class="member inherited"><a href="Ext.grid.property.Store.html#method-nextPage" rel="method-nextPage" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-nextPage" class="viewSource">view source</a></div><a name="nextPage"></a><a name="method-nextPage"></a><a href="Ext.grid.property.Store.html#" rel="method-nextPage" class="cls expand">nextPage</a> : void</div><div class="description"><div class="short"><p>Loads the next 'page' in the current data set</p>
753 </div><div class="long"><p>Loads the next 'page' in the current data set</p>
754 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
755 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.grid.property.Store.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.grid.property.Store.html#" rel="method-observe" class="cls expand">observe</a>(
756 <span class="pre">Function c, Object listeners</span>)
757  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
758
759 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
760
761 <p>This makes any event fired on any instance of the passed class also fire a single event through
762 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
763
764 <p>Usage:</p>
765
766 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
767 Ext.data.Connection.on('beforerequest', function(con, options) {
768     console.log('Ajax request made to ' + options.url);
769 });
770 </code></pre>
771 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
772 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.grid.property.Store.html#addListener" rel="Ext.grid.property.Store#addListener" class="docClass">addListener</a>.</p>
773 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
774 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.grid.property.Store.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.grid.property.Store.html#" rel="method-on" class="cls expand">on</a>(
775 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
776  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.grid.property.Store.html#addListener" rel="Ext.grid.property.Store#addListener" class="docClass">addListener</a>.)</p>
777 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.grid.property.Store.html#addListener" rel="Ext.grid.property.Store#addListener" class="docClass">addListener</a>.)</p>
778 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
779 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
780 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
781 <b>If omitted, defaults to the object which fired the event.</b></p>
782 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
783 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
784 </li></ul></div></div></div><div id="method-prefetch" class="member inherited"><a href="Ext.grid.property.Store.html#method-prefetch" rel="method-prefetch" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-prefetch" class="viewSource">view source</a></div><a name="prefetch"></a><a name="method-prefetch"></a><a href="Ext.grid.property.Store.html#" rel="method-prefetch" class="cls expand">prefetch</a>(
785 <span class="pre">Object options</span>)
786  : void</div><div class="description"><div class="short"><p>Prefetches data the Store using its configured <a href="Ext.grid.property.Store.html#proxy" rel="Ext.grid.property.Store#proxy" class="docClass">proxy</a>.</p>
787 </div><div class="long"><p>Prefetches data the Store using its configured <a href="Ext.grid.property.Store.html#proxy" rel="Ext.grid.property.Store#proxy" class="docClass">proxy</a>.</p>
788 <h3 class="pa">Parameters</h3><ul><li><span class="pre">options</span> : Object<div class="sub-desc"><p>Optional config object, passed into the <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Ext.data.Operation</a> object before loading.
789 See <a href="Ext.grid.property.Store.html#load" rel="Ext.grid.property.Store#load" class="docClass">load</a></p>
790 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
791 </li></ul></div></div></div><div id="method-prefetchPage" class="member inherited"><a href="Ext.grid.property.Store.html#method-prefetchPage" rel="method-prefetchPage" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-prefetchPage" class="viewSource">view source</a></div><a name="prefetchPage"></a><a name="method-prefetchPage"></a><a href="Ext.grid.property.Store.html#" rel="method-prefetchPage" class="cls expand">prefetchPage</a>(
792 <span class="pre">Number page, Object options, Object </span>)
793  : void</div><div class="description"><div class="short"><p>Prefetches a page of data.</p>
794 </div><div class="long"><p>Prefetches a page of data.</p>
795 <h3 class="pa">Parameters</h3><ul><li><span class="pre">page</span> : Number<div class="sub-desc"><p>The page to prefetch</p>
796 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>Optional config object, passed into the <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Ext.data.Operation</a> object before loading.
797 See <a href="Ext.grid.property.Store.html#load" rel="Ext.grid.property.Store#load" class="docClass">load</a></p>
798 </div></li><li><span class="pre"></span> : Object<div class="sub-desc">
799 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
800 </li></ul></div></div></div><div id="method-previousPage" class="member inherited"><a href="Ext.grid.property.Store.html#method-previousPage" rel="method-previousPage" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-previousPage" class="viewSource">view source</a></div><a name="previousPage"></a><a name="method-previousPage"></a><a href="Ext.grid.property.Store.html#" rel="method-previousPage" class="cls expand">previousPage</a> : void</div><div class="description"><div class="short"><p>Loads the previous 'page' in the current data set</p>
801 </div><div class="long"><p>Loads the previous 'page' in the current data set</p>
802 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
803 </li></ul></div></div></div><div id="method-purgeRecords" class="member inherited"><a href="Ext.grid.property.Store.html#method-purgeRecords" rel="method-purgeRecords" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-purgeRecords" class="viewSource">view source</a></div><a name="purgeRecords"></a><a name="method-purgeRecords"></a><a href="Ext.grid.property.Store.html#" rel="method-purgeRecords" class="cls expand">purgeRecords</a> : void</div><div class="description"><div class="short"><p>Purge the least recently used records in the prefetch if the purgeCount
804 has been exceeded.</p>
805 </div><div class="long"><p>Purge the least recently used records in the prefetch if the purgeCount
806 has been exceeded.</p>
807 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
808 </li></ul></div></div></div><div id="method-queryBy" class="member inherited"><a href="Ext.grid.property.Store.html#method-queryBy" rel="method-queryBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-queryBy" class="viewSource">view source</a></div><a name="queryBy"></a><a name="method-queryBy"></a><a href="Ext.grid.property.Store.html#" rel="method-queryBy" class="cls expand">queryBy</a>(
809 <span class="pre">Function fn, [Object scope]</span>)
810  : MixedCollection</div><div class="description"><div class="short">Query the cached records in this Store using a filtering function. The specified function
811 will be called with each re...</div><div class="long"><p>Query the cached records in this Store using a filtering function. The specified function
812 will be called with each record in this Store. If the function returns <tt>true</tt> the record is
813 included in the results.</p>
814 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to be called. It will be passed the following parameters:<ul>
815 <li><b>record</b> : Ext.data.Model<p class="sub-desc">The <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">record</a>
816 to test for filtering. Access field values using <a href="Ext.data.Model.html#get" rel="Ext.data.Model#get" class="docClass">Ext.data.Model.get</a>.</p></li>
817 <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
818 </ul></p>
819 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.</p>
820 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">MixedCollection</span>&nbsp; &nbsp;<p>Returns an <a href="Ext.util.MixedCollection.html" rel="Ext.util.MixedCollection" class="docClass">Ext.util.MixedCollection</a> of the matched records</p>
821 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.grid.property.Store.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.grid.property.Store.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
822 <span class="pre">Object origin, Array events, Object prefix</span>)
823  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
824 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
825 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
826 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
827 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
828 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
829 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.grid.property.Store.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.grid.property.Store.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
830 <span class="pre">Observable o</span>)
831  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
832 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
833 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
834 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
835 </li></ul></div></div></div><div id="method-remove" class="member inherited"><a href="Ext.grid.property.Store.html#method-remove" rel="method-remove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-remove" class="viewSource">view source</a></div><a name="remove"></a><a name="method-remove"></a><a href="Ext.grid.property.Store.html#" rel="method-remove" class="cls expand">remove</a>(
836 <span class="pre">Ext.data.Model/Array records, Object isMove</span>)
837  : void</div><div class="description"><div class="short">Removes the given record from the Store, firing the 'remove' event for each instance that is removed, plus a single
838 '...</div><div class="long"><p>Removes the given record from the Store, firing the 'remove' event for each instance that is removed, plus a single
839 'datachanged' event after removal.</p>
840 <h3 class="pa">Parameters</h3><ul><li><span class="pre">records</span> : Ext.data.Model/Array<div class="sub-desc"><p>The <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a> instance or array of instances to remove</p>
841 </div></li><li><span class="pre">isMove</span> : Object<div class="sub-desc">
842 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
843 </li></ul></div></div></div><div id="method-removeAll" class="member inherited"><a href="Ext.grid.property.Store.html#method-removeAll" rel="method-removeAll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-removeAll" class="viewSource">view source</a></div><a name="removeAll"></a><a name="method-removeAll"></a><a href="Ext.grid.property.Store.html#" rel="method-removeAll" class="cls expand">removeAll</a>(
844 <span class="pre">Boolean silent</span>)
845  : void</div><div class="description"><div class="short"><p>Remove all items from the store.</p>
846 </div><div class="long"><p>Remove all items from the store.</p>
847 <h3 class="pa">Parameters</h3><ul><li><span class="pre">silent</span> : Boolean<div class="sub-desc"><p>Prevent the <code>clear</code> event from being fired.</p>
848 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
849 </li></ul></div></div></div><div id="method-removeAt" class="member inherited"><a href="Ext.grid.property.Store.html#method-removeAt" rel="method-removeAt" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-removeAt" class="viewSource">view source</a></div><a name="removeAt"></a><a name="method-removeAt"></a><a href="Ext.grid.property.Store.html#" rel="method-removeAt" class="cls expand">removeAt</a>(
850 <span class="pre">Number index</span>)
851  : void</div><div class="description"><div class="short"><p>Removes the model instance at the given index</p>
852 </div><div class="long"><p>Removes the model instance at the given index</p>
853 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The record index</p>
854 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
855 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.grid.property.Store.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.grid.property.Store.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
856 <span class="pre">String eventName, Function handler, [Object scope]</span>)
857  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
858 </div><div class="long"><p>Removes an event handler.</p>
859 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
860 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.grid.property.Store.html#addListener" rel="Ext.grid.property.Store#addListener" class="docClass">addListener</a> call.</b></p>
861 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
862 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
863 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.grid.property.Store.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.grid.property.Store.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
864 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
865  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.grid.property.Store.html#mon" rel="Ext.grid.property.Store#mon" class="docClass">mon</a> method.</p>
866 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.grid.property.Store.html#mon" rel="Ext.grid.property.Store#mon" class="docClass">mon</a> method.</p>
867 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
868 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
869 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
870 is the handler function.</p>
871 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
872 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
873 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
874 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.grid.property.Store.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.grid.property.Store.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
875 If events were suspended using the queueSuspended parameter, then all
876 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.grid.property.Store.html#suspendEvents" rel="Ext.grid.property.Store#suspendEvents" class="docClass">suspendEvents</a>)
877 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
878 events fired during event suspension will be sent to any listeners now.</p>
879 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
880 </li></ul></div></div></div><div id="method-setProxy" class="member inherited"><a href="Ext.grid.property.Store.html#method-setProxy" rel="method-setProxy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-setProxy" class="viewSource">view source</a></div><a name="setProxy"></a><a name="method-setProxy"></a><a href="Ext.grid.property.Store.html#" rel="method-setProxy" class="cls expand">setProxy</a>(
881 <span class="pre">String|Object|Ext.data.proxy.Proxy proxy</span>)
882  : Ext.data.proxy.Proxy</div><div class="description"><div class="short"><p>Sets the Store's Proxy by string, config object or Proxy instance</p>
883 </div><div class="long"><p>Sets the Store's Proxy by string, config object or Proxy instance</p>
884 <h3 class="pa">Parameters</h3><ul><li><span class="pre">proxy</span> : String|Object|Ext.data.proxy.Proxy<div class="sub-desc"><p>The new Proxy, which can be either a type string, a configuration object
885 or an <a href="Ext.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="docClass">Ext.data.proxy.Proxy</a> instance</p>
886 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.proxy.Proxy</span>&nbsp; &nbsp;<p>The attached Proxy object</p>
887 </li></ul></div></div></div><div id="method-sort" class="member inherited"><a href="Ext.grid.property.Store.html#method-sort" rel="method-sort" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Sortable.html" class="definedIn docClass">Ext.util.Sortable</a><br/><a href="../source/Sortable.html#Ext-util.Sortable-method-sort" class="viewSource">view source</a></div><a name="sort"></a><a name="method-sort"></a><a href="Ext.grid.property.Store.html#" rel="method-sort" class="cls expand">sort</a>(
888 <span class="pre">String|Array sorters, String direction, Object where, Object doSort</span>)
889  : void</div><div class="description"><div class="short">Sorts the data in the Store by one or more of its properties. Example usage:
890
891
892 //sort by a single field
893 myStore.sort(...</div><div class="long"><p>Sorts the data in the Store by one or more of its properties. Example usage:</p>
894
895
896 <pre><code>//sort by a single field
897 myStore.sort('myField', 'DESC');
898
899 //sorting by multiple fields
900 myStore.sort([
901     {
902         property : 'age',
903         direction: 'ASC'
904     },
905     {
906         property : 'name',
907         direction: 'DESC'
908     }
909 ]);
910 </code></pre>
911
912
913 <p>Internally, Store converts the passed arguments into an array of <a href="Ext.util.Sorter.html" rel="Ext.util.Sorter" class="docClass">Ext.util.Sorter</a> instances, and delegates the actual
914 sorting to its internal <a href="Ext.util.MixedCollection.html" rel="Ext.util.MixedCollection" class="docClass">Ext.util.MixedCollection</a>.</p>
915
916
917 <p>When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:</p>
918
919
920 <pre><code>store.sort('myField');
921 store.sort('myField');
922      </code></pre>
923
924
925 <p>Is equivalent to this code, because Store handles the toggling automatically:</p>
926
927
928 <pre><code>store.sort('myField', 'ASC');
929 store.sort('myField', 'DESC');
930 </code></pre>
931
932 <h3 class="pa">Parameters</h3><ul><li><span class="pre">sorters</span> : String|Array<div class="sub-desc"><p>Either a string name of one of the fields in this Store's configured <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a>,
933 or an Array of sorter configurations.</p>
934 </div></li><li><span class="pre">direction</span> : String<div class="sub-desc"><p>The overall direction to sort the data by. Defaults to "ASC".</p>
935 </div></li><li><span class="pre">where</span> : Object<div class="sub-desc">
936 </div></li><li><span class="pre">doSort</span> : Object<div class="sub-desc">
937 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
938 </li></ul></div></div></div><div id="method-sum" class="member inherited"><a href="Ext.grid.property.Store.html#method-sum" rel="method-sum" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-method-sum" class="viewSource">view source</a></div><a name="sum"></a><a name="method-sum"></a><a href="Ext.grid.property.Store.html#" rel="method-sum" class="cls expand">sum</a>(
939 <span class="pre">String field, Boolean grouped</span>)
940  : Number</div><div class="description"><div class="short"><p>Sums the value of <tt>property</tt> for each <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">record</a> between <tt>start</tt>
941 and <tt>end</tt> and returns the result.</p>
942 </div><div class="long"><p>Sums the value of <tt>property</tt> for each <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">record</a> between <tt>start</tt>
943 and <tt>end</tt> and returns the result.</p>
944 <h3 class="pa">Parameters</h3><ul><li><span class="pre">field</span> : String<div class="sub-desc"><p>A field in each record</p>
945 </div></li><li><span class="pre">grouped</span> : Boolean<div class="sub-desc"><p>(Optional) True to perform the operation for each group
946 in the store. The value returned will be an object literal with the key being the group
947 name and the sum for that group being the value. The grouped parameter is only honored if
948 the store has a groupField.</p>
949 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;<p>The sum</p>
950 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.grid.property.Store.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.grid.property.Store.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
951 <span class="pre">Boolean queueSuspended</span>)
952  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.grid.property.Store.html#resumeEvents" rel="Ext.grid.property.Store#resumeEvents" class="docClass">resumeEvents</a>)</p>
953 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.grid.property.Store.html#resumeEvents" rel="Ext.grid.property.Store#resumeEvents" class="docClass">resumeEvents</a>)</p>
954 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
955 after the <a href="Ext.grid.property.Store.html#resumeEvents" rel="Ext.grid.property.Store#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
956 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
957 </li></ul></div></div></div><div id="method-sync" class="member inherited"><a href="Ext.grid.property.Store.html#method-sync" rel="method-sync" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-method-sync" class="viewSource">view source</a></div><a name="sync"></a><a name="method-sync"></a><a href="Ext.grid.property.Store.html#" rel="method-sync" class="cls expand">sync</a> : void</div><div class="description"><div class="short">Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated
958 and deleted records in ...</div><div class="long"><p>Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated
959 and deleted records in the store, updating the Store's internal representation of the records
960 as each operation completes.</p>
961 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
962 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.grid.property.Store.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.grid.property.Store.html#" rel="method-un" class="cls expand">un</a>(
963 <span class="pre">String eventName, Function handler, [Object scope]</span>)
964  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.grid.property.Store.html#removeListener" rel="Ext.grid.property.Store#removeListener" class="docClass">removeListener</a>.)</p>
965 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.grid.property.Store.html#removeListener" rel="Ext.grid.property.Store#removeListener" class="docClass">removeListener</a>.)</p>
966 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
967 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.grid.property.Store.html#addListener" rel="Ext.grid.property.Store#addListener" class="docClass">addListener</a> call.</b></p>
968 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
969 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
970 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-add" class="member f inherited"><a href="Ext.grid.property.Store.html#event-add" rel="event-add" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-add" class="viewSource">view source</a></div><a name="add"></a><a name="event-add"></a><a href="Ext.grid.property.Store.html#" rel="event-add" class="cls expand">add</a>(
971 <span class="pre">Ext.data.Store store, Array records, Number index</span>)
972 </div><div class="description"><div class="short"><p>Fired when a Model instance has been added to this Store</p>
973 </div><div class="long"><p>Fired when a Model instance has been added to this Store</p>
974 <h3 class="pa">Parameters</h3><ul><li><span class="pre">store</span> : Ext.data.Store<div class="sub-desc"><p>The store</p>
975 </div></li><li><span class="pre">records</span> : Array<div class="sub-desc"><p>The Model instances that were added</p>
976 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index at which the instances were inserted</p>
977 </div></li></ul></div></div></div><div id="event-beforeload" class="member inherited"><a href="Ext.grid.property.Store.html#event-beforeload" rel="event-beforeload" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-beforeload" class="viewSource">view source</a></div><a name="beforeload"></a><a name="event-beforeload"></a><a href="Ext.grid.property.Store.html#" rel="event-beforeload" class="cls expand">beforeload</a>(
978 <span class="pre">Ext.data.Store store, Ext.data.Operation operation</span>)
979 </div><div class="description"><div class="short"><p>Event description</p>
980 </div><div class="long"><p>Event description</p>
981 <h3 class="pa">Parameters</h3><ul><li><span class="pre">store</span> : Ext.data.Store<div class="sub-desc"><p>This Store</p>
982 </div></li><li><span class="pre">operation</span> : Ext.data.Operation<div class="sub-desc"><p>The <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Ext.data.Operation</a> object that will be passed to the Proxy to load the Store</p>
983 </div></li></ul></div></div></div><div id="event-beforeprefetch" class="member inherited"><a href="Ext.grid.property.Store.html#event-beforeprefetch" rel="event-beforeprefetch" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-event-beforeprefetch" class="viewSource">view source</a></div><a name="beforeprefetch"></a><a name="event-beforeprefetch"></a><a href="Ext.grid.property.Store.html#" rel="event-beforeprefetch" class="cls expand">beforeprefetch</a>(
984 <span class="pre">Ext.data.store this, Ext.data.Operation operation</span>)
985 </div><div class="description"><div class="short"><p>Fires before a prefetch occurs. Return false to cancel.</p>
986 </div><div class="long"><p>Fires before a prefetch occurs. Return false to cancel.</p>
987 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.store<div class="sub-desc">
988 </div></li><li><span class="pre">operation</span> : Ext.data.Operation<div class="sub-desc"><p>The associated operation</p>
989 </div></li></ul></div></div></div><div id="event-beforesync" class="member inherited"><a href="Ext.grid.property.Store.html#event-beforesync" rel="event-beforesync" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-beforesync" class="viewSource">view source</a></div><a name="beforesync"></a><a name="event-beforesync"></a><a href="Ext.grid.property.Store.html#" rel="event-beforesync" class="cls expand">beforesync</a>(
990 <span class="pre">Object options</span>)
991 </div><div class="description"><div class="short"><p>Called before a call to <a href="Ext.grid.property.Store.html#sync" rel="Ext.grid.property.Store#sync" class="docClass">sync</a> is executed. Return false from any listener to cancel the synv</p>
992 </div><div class="long"><p>Called before a call to <a href="Ext.grid.property.Store.html#sync" rel="Ext.grid.property.Store#sync" class="docClass">sync</a> is executed. Return false from any listener to cancel the synv</p>
993 <h3 class="pa">Parameters</h3><ul><li><span class="pre">options</span> : Object<div class="sub-desc"><p>Hash of all records to be synchronized, broken down into create, update and destroy</p>
994 </div></li></ul></div></div></div><div id="event-clear" class="member inherited"><a href="Ext.grid.property.Store.html#event-clear" rel="event-clear" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-clear" class="viewSource">view source</a></div><a name="clear"></a><a name="event-clear"></a><a href="Ext.grid.property.Store.html#" rel="event-clear" class="cls expand">clear</a>(
995 <span class="pre">Ext.data.Store this</span>)
996 </div><div class="description"><div class="short"><p>Fired after the <a href="Ext.grid.property.Store.html#removeAll" rel="Ext.grid.property.Store#removeAll" class="docClass">removeAll</a> method is called.</p>
997 </div><div class="long"><p>Fired after the <a href="Ext.grid.property.Store.html#removeAll" rel="Ext.grid.property.Store#removeAll" class="docClass">removeAll</a> method is called.</p>
998 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.Store<div class="sub-desc">
999 </div></li></ul></div></div></div><div id="event-datachanged" class="member inherited"><a href="Ext.grid.property.Store.html#event-datachanged" rel="event-datachanged" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-datachanged" class="viewSource">view source</a></div><a name="datachanged"></a><a name="event-datachanged"></a><a href="Ext.grid.property.Store.html#" rel="event-datachanged" class="cls expand">datachanged</a>(
1000 <span class="pre">Ext.data.Store this</span>)
1001 </div><div class="description"><div class="short">Fires whenever the records in the Store have changed in some way - this could include adding or removing records,
1002 or ...</div><div class="long"><p>Fires whenever the records in the Store have changed in some way - this could include adding or removing records,
1003 or updating the data in existing records</p>
1004 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.Store<div class="sub-desc"><p>The data store</p>
1005 </div></li></ul></div></div></div><div id="event-groupchange" class="member inherited"><a href="Ext.grid.property.Store.html#event-groupchange" rel="event-groupchange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-event-groupchange" class="viewSource">view source</a></div><a name="groupchange"></a><a name="event-groupchange"></a><a href="Ext.grid.property.Store.html#" rel="event-groupchange" class="cls expand">groupchange</a>(
1006 <span class="pre">Ext.data.Store store, Array groupers</span>)
1007 </div><div class="description"><div class="short"><p>Fired whenever the grouping in the grid changes</p>
1008 </div><div class="long"><p>Fired whenever the grouping in the grid changes</p>
1009 <h3 class="pa">Parameters</h3><ul><li><span class="pre">store</span> : Ext.data.Store<div class="sub-desc"><p>The store</p>
1010 </div></li><li><span class="pre">groupers</span> : Array<div class="sub-desc"><p>The array of grouper objects</p>
1011 </div></li></ul></div></div></div><div id="event-load" class="member inherited"><a href="Ext.grid.property.Store.html#event-load" rel="event-load" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Store.html" class="definedIn docClass">Ext.data.Store</a><br/><a href="../source/Store2.html#Ext-data.Store-event-load" class="viewSource">view source</a></div><a name="load"></a><a name="event-load"></a><a href="Ext.grid.property.Store.html#" rel="event-load" class="cls expand">load</a>(
1012 <span class="pre">Ext.data.store this, Array records, Boolean successful, Ext.data.Operation operation</span>)
1013 </div><div class="description"><div class="short"><p>Fires whenever records have been prefetched</p>
1014 </div><div class="long"><p>Fires whenever records have been prefetched</p>
1015 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.data.store<div class="sub-desc">
1016 </div></li><li><span class="pre">records</span> : Array<div class="sub-desc"><p>An array of records</p>
1017 </div></li><li><span class="pre">successful</span> : Boolean<div class="sub-desc"><p>True if the operation was successful.</p>
1018 </div></li><li><span class="pre">operation</span> : Ext.data.Operation<div class="sub-desc"><p>The associated operation</p>
1019 </div></li></ul></div></div></div><div id="event-remove" class="member inherited"><a href="Ext.grid.property.Store.html#event-remove" rel="event-remove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-remove" class="viewSource">view source</a></div><a name="remove"></a><a name="event-remove"></a><a href="Ext.grid.property.Store.html#" rel="event-remove" class="cls expand">remove</a>(
1020 <span class="pre">Ext.data.Store store, Ext.data.Model record, Number index</span>)
1021 </div><div class="description"><div class="short"><p>Fired when a Model instance has been removed from this Store</p>
1022 </div><div class="long"><p>Fired when a Model instance has been removed from this Store</p>
1023 <h3 class="pa">Parameters</h3><ul><li><span class="pre">store</span> : Ext.data.Store<div class="sub-desc"><p>The Store object</p>
1024 </div></li><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The record that was removed</p>
1025 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index of the record that was removed</p>
1026 </div></li></ul></div></div></div><div id="event-update" class="member inherited"><a href="Ext.grid.property.Store.html#event-update" rel="event-update" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.AbstractStore.html" class="definedIn docClass">Ext.data.AbstractStore</a><br/><a href="../source/AbstractStore.html#Ext-data.AbstractStore-event-update" class="viewSource">view source</a></div><a name="update"></a><a name="event-update"></a><a href="Ext.grid.property.Store.html#" rel="event-update" class="cls expand">update</a>(
1027 <span class="pre">Store this, Ext.data.Model record, String operation</span>)
1028 </div><div class="description"><div class="short"><p>Fires when a Record has been updated</p>
1029 </div><div class="long"><p>Fires when a Record has been updated</p>
1030 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Store<div class="sub-desc">
1031 </div></li><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The Model instance that was updated</p>
1032 </div></li><li><span class="pre">operation</span> : String<div class="sub-desc"><p>The update operation being performed. Value may be one of:</p>
1033
1034 <pre><code>               Ext.data.Model.EDIT
1035                Ext.data.Model.REJECT
1036                Ext.data.Model.COMMIT
1037 </code></pre>
1038
1039 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>