+++ /dev/null
- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.data.Store-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.data.Store-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.data.Store-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Ext.data.Store-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="../docs/?class=Ext.data.Store"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <div class="inheritance res-block">
-<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
- <img src="resources/elbow-end.gif"/>Store</pre></div>
- <h1>Class Ext.data.Store</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Store.js" target="_blank">Store.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">Store</td></tr>
- <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.data.GroupingStore" href="output/Ext.data.GroupingStore.html">GroupingStore</a>, <a ext:cls="Ext.data.JsonStore" href="output/Ext.data.JsonStore.html">JsonStore</a>, <a ext:cls="Ext.data.SimpleStore" href="output/Ext.data.SimpleStore.html">SimpleStore</a>, <a ext:cls="Ext.sql.SQLiteStore" href="output/Ext.sql.SQLiteStore.html">SQLiteStore</a></td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
- </table>
- <div class="description">
- *
-The Store class encapsulates a client side cache of <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Record</a>
-objects which provide input data for Components such as the <a ext:cls="Ext.grid.GridPanel" href="output/Ext.grid.GridPanel.html">GridPanel</a>,
-the <a ext:cls="Ext.form.ComboBox" href="output/Ext.form.ComboBox.html">ComboBox</a>, or the <a ext:cls="Ext.DataView" href="output/Ext.DataView.html">DataView</a></p>
-<p>A Store object uses its <a ext:cls="Ext.data.Store" ext:member="proxy" href="output/Ext.data.Store.html#proxy">configured</a> implementation of <a ext:cls="Ext.data.DataProxy" href="output/Ext.data.DataProxy.html">DataProxy</a>
-to access a data object unless you call <a ext:cls="Ext.data.Store" ext:member="loadData" href="output/Ext.data.Store.html#loadData">loadData</a> directly and pass in your data.</p>
-<p>A Store object has no knowledge of the format of the data returned by the Proxy.</p>
-<p>A Store object uses its <a ext:cls="Ext.data.Store" ext:member="reader" href="output/Ext.data.Store.html#reader">configured</a> implementation of <a ext:cls="Ext.data.DataReader" href="output/Ext.data.DataReader.html">DataReader</a>
-to create <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Record</a> instances from the data object. These Records
-are cached and made available through accessor functions.</p> </div>
-
- <div class="hr"></div>
- <a id="Ext.data.Store-configs"></a>
- <h2>Config Options</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Config Options</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-autoLoad"></a>\r
- <b>autoLoad</b> : Boolean/Object <div class="mdesc">\r
- If passed, this store's load method is automatically called after creation with the autoLoad object </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-baseParams"></a>\r
- <b>baseParams</b> : Object <div class="mdesc">\r
- An object containing properties which are to be sent as parameters on any HTTP request </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-data"></a>\r
- <b>data</b> : Array <div class="mdesc">\r
- Inline data to be loaded when the store is initialized. </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-listeners"></a>\r
- <b>listeners</b> : Object <div class="mdesc">\r
- <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
- <div class="long">\r
- (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-proxy"></a>\r
- <b>proxy</b> : Ext.data.DataProxy <div class="mdesc">\r
- The Proxy object which provides access to a data object. </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="config-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-pruneModifiedRecords"></a>\r
- <b>pruneModifiedRecords</b> : boolean <div class="mdesc">\r
- <div class="short">True to clear all modified record information each time the store is loaded or when a record is removed. (defaults to...</div>\r
- <div class="long">\r
- True to clear all modified record information each time the store is loaded or when a record is removed. (defaults to false). </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="config-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-reader"></a>\r
- <b>reader</b> : Ext.data.DataReader <div class="mdesc">\r
- <div class="short">The DataReader object which processes the data object and returns an Array of Ext.data.Record objects which are cache...</div>\r
- <div class="long">\r
- The DataReader object which processes the data object and returns an Array of Ext.data.Record objects which are cached keyed by their <em>id</em> property. </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="config-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-remoteSort"></a>\r
- <b>remoteSort</b> : boolean <div class="mdesc">\r
- <div class="short">True if sorting is to be handled by requesting the Proxy to provide a refreshed version of the data object in sorted ...</div>\r
- <div class="long">\r
- True if sorting is to be handled by requesting the Proxy to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false). <p>If remote sorting is specified, then clicking on a column header causes the current page to be requested from the server with the addition of the following two parameters: <div class="mdetail-params"><ul> <li><b>sort</b> : String<p class="sub-desc">The name (as specified in the Record's Field definition) of the field to sort on.</p></li> <li><b>dir</b> : String<p class="sub-desc">The direction of the sort, "ASC" or "DESC" (case-sensitive).</p></li> </ul></div></p> </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="config-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-sortInfo"></a>\r
- <b>sortInfo</b> : Object <div class="mdesc">\r
- <div class="short">A config object in the format: {field: "fieldName", direction: "ASC|DESC"} to specify the sort order in the request o...</div>\r
- <div class="long">\r
- A config object in the format: {field: "fieldName", direction: "ASC|DESC"} to specify the sort order in the request of a remote Store's <a ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a> operation. Note that for local sorting, the direction property is case-sensitive. </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-storeId"></a>\r
- <b>storeId</b> : String <div class="mdesc">\r
- If passed, the id to use to register with the StoreMgr </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-url"></a>\r
- <b>url</b> : String <div class="mdesc">\r
- If passed, an HttpProxy is created for the passed URL </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- </table>
- <a id="Ext.data.Store-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-baseParams"></a>\r
- <b>baseParams</b> : Object <div class="mdesc">\r
- <div class="short">An object containing properties which are used as parameters on any HTTP request.
-This property can be changed after ...</div>\r
- <div class="long">\r
- An object containing properties which are used as parameters on any HTTP request.
-This property can be changed after creating the Store to send different parameters. </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-fields"></a>\r
- <b>fields</b> : Ext.util.MixedCollection <div class="mdesc">\r
- A MixedCollection containing the defined <a ext:cls="Ext.data.Field" href="output/Ext.data.Field.html">Field</a>s for the Records stored in this Store. Read-only. </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="property-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-lastOptions"></a>\r
- <b>lastOptions</b> : Object <div class="mdesc">\r
- <div class="short">Contains the last options object used as the parameter to the load method. See load
-for the details of what this may ...</div>\r
- <div class="long">\r
- Contains the last options object used as the parameter to the load method. See <a ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a>
-for the details of what this may contain. This may be useful for accessing any params which
-were used to load the current Record cache. </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="property-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-paramNames"></a>\r
- <b>paramNames</b> : Object <div class="mdesc">\r
- <div class="short">An object containing properties which specify the names of the paging and
-sorting parameters passed to remote servers...</div>\r
- <div class="long">\r
- <p>An object containing properties which specify the names of the paging and
-sorting parameters passed to remote servers when loading blocks of data. By default, this
-object takes the following form:</p><pre><code>{
- start : <em>"start"</em>, <i>// The parameter name which specifies the start row</i>
- limit : <em>"limit"</em>, <i>// The parameter name which specifies number of rows to <b>return</b></i>
- sort : <em>"sort"</em>, <i>// The parameter name which specifies the column to sort on</i>
- dir : <em>"dir"</em> <i>// The parameter name which specifies the sort direction</i>
-}</code></pre>
-<p>The server must produce the requested data block upon receipt of these parameter names.
-If different parameter names are required, this property can be overriden using a configuration
-property.</p>
-<p>A <a ext:cls="Ext.PagingToolbar" href="output/Ext.PagingToolbar.html">PagingToolbar</a> bound to this grid uses this property to determine
-the parameter names to use in its requests. </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="property-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-recordType"></a>\r
- <b>recordType</b> : Function <div class="mdesc">\r
- <div class="short">The Record constructor as supplied to (or created by) the Reader. Read-only.
-If the Reader was constructed by passin...</div>\r
- <div class="long">\r
- The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Record</a> constructor as supplied to (or created by) the <a ext:cls="Ext.data.Reader" ext:member="Reader" href="output/Ext.data.Reader.html#Reader">Reader</a>. Read-only.
-<p>If the Reader was constructed by passing in an Array of field definition objects, instead of an created
-Record constructor it will have <a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">created a constructor</a> from that Array.</p>
-<p>This property may be used to create new Records of the type held in this Store.</p> </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- </table>
- <a id="Ext.data.Store-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-Store"></a>\r
- <b>Store</b>( <code>Object config</code> ) <div class="mdesc">\r
- <div class="short">Creates a new Store.</div>\r
- <div class="long">\r
- Creates a new Store. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>config</code> : Object<div class="sub-desc">A config object containing the objects needed for the Store to access data,
-and read the data into Records.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code></code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-add"></a>\r
- <b>add</b>( <code>Ext.data.Record[] records</code> ) : void <div class="mdesc">\r
- <div class="short">Add Records to the Store and fires the <a ext:cls="Ext.data.Store" ext:member="add" href="output/Ext.data.Store.html#add">add</a> event.</div>\r
- <div class="long">\r
- Add Records to the Store and fires the <a ext:cls="Ext.data.Store" ext:member="add" href="output/Ext.data.Store.html#add">add</a> event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>records</code> : Ext.data.Record[]<div class="sub-desc">An Array of Ext.data.Record objects to add to the cache.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-addEvents"></a>\r
- <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">\r
- <div class="short">Used to define events on this Observable</div>\r
- <div class="long">\r
- Used to define events on this Observable <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-addListener"></a>\r
- <b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this component</div>\r
- <div class="long">\r
- Appends an event handler to this component <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
-properties. This may contain any of the following properties:<ul>
-<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
-<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
-<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
-<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
-by the specified number of milliseconds. If the event fires again within that time, the original
-handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
-</ul><br>
-<p>
-<b>Combining Options</b><br>
-Using the options argument, it is possible to combine different types of listeners:<br>
-<br>
-A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
-<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
- single: true,
- delay: 100,
- forumId: 4
-});</code></pre>
-<p>
-<b>Attaching multiple handlers in 1 call</b><br>
-The method also allows for a single argument to be passed which is a config object containing properties
-which specify multiple handlers.
-<p>
-<pre><code>foo.on({
- <em>'click'</em> : {
- fn: <b>this</b>.onClick,
- scope: <b>this</b>,
- delay: 100
- },
- <em>'mouseover'</em> : {
- fn: <b>this</b>.onMouseOver,
- scope: <b>this</b>
- },
- <em>'mouseout'</em> : {
- fn: <b>this</b>.onMouseOut,
- scope: <b>this</b>
- }
-});</code></pre>
-<p>
-Or a shorthand syntax:<br>
-<pre><code>foo.on({
- <em>'click'</em> : <b>this</b>.onClick,
- <em>'mouseover'</em> : <b>this</b>.onMouseOver,
- <em>'mouseout'</em> : <b>this</b>.onMouseOut,
- scope: <b>this</b>
-});</code></pre></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-addSorted"></a>\r
- <b>addSorted</b>( <code>Ext.data.Record record</code> ) : void <div class="mdesc">\r
- <div class="short">(Local sort only) Inserts the passed Record into the Store at the index where it
-should go based on the current sort ...</div>\r
- <div class="long">\r
- (Local sort only) Inserts the passed Record into the Store at the index where it
-should go based on the current sort information. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>record</code> : Ext.data.Record<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-clearFilter"></a>\r
- <b>clearFilter</b>( <code>Boolean suppressEvent</code> ) : void <div class="mdesc">\r
- <div class="short">Revert to a view of the Record cache with no filtering applied.</div>\r
- <div class="long">\r
- Revert to a view of the Record cache with no filtering applied. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>suppressEvent</code> : Boolean<div class="sub-desc">If true the filter is cleared silently without notifying listeners</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-collect"></a>\r
- <b>collect</b>( <code>String dataIndex</code>, <span class="optional" title="Optional">[<code>Boolean allowNull</code>]</span>, <span class="optional" title="Optional">[<code>Boolean bypassFilter</code>]</span> ) : Array <div class="mdesc">\r
- <div class="short">Collects unique values for a particular dataIndex from this store.</div>\r
- <div class="long">\r
- Collects unique values for a particular dataIndex from this store. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>dataIndex</code> : String<div class="sub-desc">The property to collect</div></li><li><code>allowNull</code> : Boolean<div class="sub-desc">(optional) Pass true to allow null, undefined or empty string values</div></li><li><code>bypassFilter</code> : Boolean<div class="sub-desc">(optional) Pass true to collect from all records, even ones which are filtered</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">An array of the unique values</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-commitChanges"></a>\r
- <b>commitChanges</b>() : void <div class="mdesc">\r
- <div class="short">Commit all Records with outstanding changes. To handle updates for changes, subscribe to the
-Store's "update" event, ...</div>\r
- <div class="long">\r
- Commit all Records with outstanding changes. To handle updates for changes, subscribe to the
-Store's "update" event, and perform updating when the third parameter is Ext.data.Record.COMMIT. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-each"></a>\r
- <b>each</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Calls the specified function for each of the Records in the cache.</div>\r
- <div class="long">\r
- Calls the specified function for each of the Records in the cache. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>fn</code> : Function<div class="sub-desc">The function to call. The Record is passed as the first parameter.
-Returning <tt>false</tt> aborts and exits the iteration.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to call the function (defaults to the Record).</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-filter"></a>\r
- <b>filter</b>( <code>String field</code>, <code>String/RegExp value</code>, <span class="optional" title="Optional">[<code>Boolean anyMatch</code>]</span>, <span class="optional" title="Optional">[<code>Boolean caseSensitive</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Filter the records by a specified property.</div>\r
- <div class="long">\r
- Filter the records by a specified property. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>field</code> : String<div class="sub-desc">A field on your records</div></li><li><code>value</code> : String/RegExp<div class="sub-desc">Either a string that the field
-should begin with, or a RegExp to test against the field.</div></li><li><code>anyMatch</code> : Boolean<div class="sub-desc">(optional) True to match any part not just the beginning</div></li><li><code>caseSensitive</code> : Boolean<div class="sub-desc">(optional) True for case sensitive comparison</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-filterBy"></a>\r
- <b>filterBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Filter by a function. The specified function will be called for each
-Record in this Store. If the function returns tr...</div>\r
- <div class="long">\r
- Filter by a function. The specified function will be called for each
-Record in this Store. If the function returns <tt>true</tt> the Record is included,
-otherwise it is filtered out. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul>
-<li><b>record</b> : Ext.data.Record<p class="sub-desc">The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">record</a>
-to test for filtering. Access field values using <a ext:cls="Ext.data.Record" ext:member="get" href="output/Ext.data.Record.html#get">Ext.data.Record.get</a>.</p></li>
-<li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
-</ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-find"></a>\r
- <b>find</b>( <code>String property</code>, <code>String/RegExp value</code>, <span class="optional" title="Optional">[<code>Number startIndex</code>]</span>, <span class="optional" title="Optional">[<code>Boolean anyMatch</code>]</span>, <span class="optional" title="Optional">[<code>Boolean caseSensitive</code>]</span> ) : Number <div class="mdesc">\r
- <div class="short">Finds the index of the first matching record in this store by a specific property/value.</div>\r
- <div class="long">\r
- Finds the index of the first matching record in this store by a specific property/value. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>property</code> : String<div class="sub-desc">A property on your objects</div></li><li><code>value</code> : String/RegExp<div class="sub-desc">Either a string that the property value
-should begin with, or a RegExp to test against the property.</div></li><li><code>startIndex</code> : Number<div class="sub-desc">(optional) The index to start searching at</div></li><li><code>anyMatch</code> : Boolean<div class="sub-desc">(optional) True to match any part of the string, not just the beginning</div></li><li><code>caseSensitive</code> : Boolean<div class="sub-desc">(optional) True for case sensitive comparison</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The matched index or -1</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-findBy"></a>\r
- <b>findBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Number startIndex</code>]</span> ) : Number <div class="mdesc">\r
- <div class="short">Find the index of the first matching Record in this Store by a function.
-If the function returns true it is considere...</div>\r
- <div class="long">\r
- Find the index of the first matching Record in this Store by a function.
-If the function returns <tt>true</tt> it is considered a match. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul>
-<li><b>record</b> : Ext.data.Record<p class="sub-desc">The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">record</a>
-to test for filtering. Access field values using <a ext:cls="Ext.data.Record" ext:member="get" href="output/Ext.data.Record.html#get">Ext.data.Record.get</a>.</p></li>
-<li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
-</ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li><li><code>startIndex</code> : Number<div class="sub-desc">(optional) The index to start searching at</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The matched index or -1</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-fireEvent"></a>\r
- <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
- <div class="long">\r
- Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-getAt"></a>\r
- <b>getAt</b>( <code>Number index</code> ) : Ext.data.Record <div class="mdesc">\r
- <div class="short">Get the Record at the specified index.</div>\r
- <div class="long">\r
- Get the Record at the specified index. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>index</code> : Number<div class="sub-desc">The index of the Record to find.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.data.Record</code><div class="sub-desc">The Record at the passed index. Returns undefined if not found.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-getById"></a>\r
- <b>getById</b>( <code>String id</code> ) : Ext.data.Record <div class="mdesc">\r
- <div class="short">Get the Record with the specified id.</div>\r
- <div class="long">\r
- Get the Record with the specified id. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : String<div class="sub-desc">The id of the Record to find.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.data.Record</code><div class="sub-desc">The Record with the passed id. Returns undefined if not found.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-getCount"></a>\r
- <b>getCount</b>() : Number <div class="mdesc">\r
- <div class="short">Gets the number of cached records.
-If using paging, this may not be the total size of the dataset. If the data object...</div>\r
- <div class="long">\r
- Gets the number of cached records.
-<p>If using paging, this may not be the total size of the dataset. If the data object
-used by the Reader contains the dataset size, then the <a ext:cls="Ext.data.Store" ext:member="getTotalCount" href="output/Ext.data.Store.html#getTotalCount">getTotalCount</a> function returns
-the dataset size.</p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The number of Records in the Store's cache.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-getModifiedRecords"></a>\r
- <b>getModifiedRecords</b>() : Ext.data.Record[] <div class="mdesc">\r
- <div class="short">Gets all records modified since the last commit. Modified records are persisted across load operations
-(e.g., during...</div>\r
- <div class="long">\r
- Gets all records modified since the last commit. Modified records are persisted across load operations
-(e.g., during paging). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.data.Record[]</code><div class="sub-desc">An array of Records containing outstanding modifications.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-getRange"></a>\r
- <b>getRange</b>( <span class="optional" title="Optional">[<code>Number startIndex</code>]</span>, <span class="optional" title="Optional">[<code>Number endIndex</code>]</span> ) : Ext.data.Record[] <div class="mdesc">\r
- <div class="short">Returns a range of Records between specified indices.</div>\r
- <div class="long">\r
- Returns a range of Records between specified indices. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>startIndex</code> : Number<div class="sub-desc">(optional) The starting index (defaults to 0)</div></li><li><code>endIndex</code> : Number<div class="sub-desc">(optional) The ending index (defaults to the last Record in the Store)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.data.Record[]</code><div class="sub-desc">An array of Records</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-getSortState"></a>\r
- <b>getSortState</b>() : Object <div class="mdesc">\r
- <div class="short">Returns an object describing the current sort state of this Store.</div>\r
- <div class="long">\r
- Returns an object describing the current sort state of this Store. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">The sort state of the Store. An object with two properties:<ul> <li><b>field : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li> <li><b>direction : String<p class="sub-desc">The sort order, "ASC" or "DESC" (case-sensitive).</p></li> </ul></div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-getTotalCount"></a>\r
- <b>getTotalCount</b>() : Number <div class="mdesc">\r
- <div class="short">Gets the total number of records in the dataset as returned by the server.
-If using paging, for this to be accurate, ...</div>\r
- <div class="long">\r
- Gets the total number of records in the dataset as returned by the server.
-<p>If using paging, for this to be accurate, the data object used by the Reader must contain
-the dataset size. For remote data sources, this is provided by a query on the server.</p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The number of Records as specified in the data object passed to the Reader by the Proxy <p><b>This value is not updated when changing the contents of the Store locally.</b></p></div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-hasListener"></a>\r
- <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
- <div class="long">\r
- Checks to see if this object has any listeners for a specified event <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-indexOf"></a>\r
- <b>indexOf</b>( <code>Ext.data.Record record</code> ) : Number <div class="mdesc">\r
- <div class="short">Get the index within the cache of the passed Record.</div>\r
- <div class="long">\r
- Get the index within the cache of the passed Record. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Ext.data.Record object to find.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The index of the passed Record. Returns -1 if not found.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-indexOfId"></a>\r
- <b>indexOfId</b>( <code>String id</code> ) : Number <div class="mdesc">\r
- <div class="short">Get the index within the cache of the Record with the passed id.</div>\r
- <div class="long">\r
- Get the index within the cache of the Record with the passed id. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : String<div class="sub-desc">The id of the Record to find.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The index of the Record. Returns -1 if not found.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-insert"></a>\r
- <b>insert</b>( <code>Number index</code>, <code>Ext.data.Record[] records</code> ) : void <div class="mdesc">\r
- <div class="short">Inserts Records into the Store at the given index and fires the <a ext:cls="Ext.data.Store" ext:member="add" href="output/Ext.data.Store.html#add">add</a> event.</div>\r
- <div class="long">\r
- Inserts Records into the Store at the given index and fires the <a ext:cls="Ext.data.Store" ext:member="add" href="output/Ext.data.Store.html#add">add</a> event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>index</code> : Number<div class="sub-desc">The start index at which to insert the passed Records.</div></li><li><code>records</code> : Ext.data.Record[]<div class="sub-desc">An Array of Ext.data.Record objects to add to the cache.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-isFiltered"></a>\r
- <b>isFiltered</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if this store is currently filtered</div>\r
- <div class="long">\r
- Returns true if this store is currently filtered <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-load"></a>\r
- <b>load</b>( <code>Object options</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Loads the Record cache from the configured Proxy using the configured Reader.
-If using remote paging, then the first ...</div>\r
- <div class="long">\r
- Loads the Record cache from the configured Proxy using the configured Reader.
-<p>If using remote paging, then the first load call must specify the <tt>start</tt>
-and <tt>limit</tt> properties in the options.params property to establish the initial
-position within the dataset, and the number of Records to cache on each read from the Proxy.</p>
-<p><b>It is important to note that for remote data sources, loading is asynchronous,
-and this call will return before the new data has been loaded. Perform any post-processing
-in a callback function, or in a "load" event handler.</b></p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>options</code> : Object<div class="sub-desc">An object containing properties which control loading options:<ul>
-<li><b>params</b> :Object<p class="sub-desc">An object containing properties to pass as HTTP parameters to a remote data source.</p></li>
-<li><b>callback</b> : Function<p class="sub-desc">A function to be called after the Records have been loaded. The callback is
-passed the following arguments:<ul>
-<li>r : Ext.data.Record[]</li>
-<li>options: Options object from the load call</li>
-<li>success: Boolean success indicator</li></ul></p></li>
-<li><b>scope</b> : Object<p class="sub-desc">Scope with which to call the callback (defaults to the Store object)</p></li>
-<li><b>add</b> : Boolean<p class="sub-desc">Indicator to append loaded records rather than replace the current cache.</p></li>
-</ul></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">Whether the load fired (if beforeload failed).</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-loadData"></a>\r
- <b>loadData</b>( <code>Object data</code>, <span class="optional" title="Optional">[<code>Boolean add</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Loads data from a passed data block and fires the load event. A Reader which understands the format of the data
-must ...</div>\r
- <div class="long">\r
- Loads data from a passed data block and fires the <a ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a> event. A Reader which understands the format of the data
-must have been configured in the constructor. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>data</code> : Object<div class="sub-desc">The data block from which to read the Records. The format of the data expected
-is dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.</div></li><li><code>add</code> : Boolean<div class="sub-desc">(Optional) True to add the new Records rather than replace the existing cache. <b>Remember that
-Records in a Store are keyed by their <a ext:cls="Ext.data.Record" ext:member="id" href="output/Ext.data.Record.html#id">id</a>, so added Records with ids which are already present in
-the Store will <i>replace</i> existing Records. Records with new, unique ids will be added.</b></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-on"></a>\r
- <b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
- <div class="long">\r
- Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-purgeListeners"></a>\r
- <b>purgeListeners</b>() : void <div class="mdesc">\r
- <div class="short">Removes all listeners for this object</div>\r
- <div class="long">\r
- Removes all listeners for this object <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-query"></a>\r
- <b>query</b>( <code>String field</code>, <code>String/RegExp value</code>, <span class="optional" title="Optional">[<code>Boolean anyMatch</code>]</span>, <span class="optional" title="Optional">[<code>Boolean caseSensitive</code>]</span> ) : MixedCollection <div class="mdesc">\r
- <div class="short">Query the records by a specified property.</div>\r
- <div class="long">\r
- Query the records by a specified property. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>field</code> : String<div class="sub-desc">A field on your records</div></li><li><code>value</code> : String/RegExp<div class="sub-desc">Either a string that the field
-should begin with, or a RegExp to test against the field.</div></li><li><code>anyMatch</code> : Boolean<div class="sub-desc">(optional) True to match any part not just the beginning</div></li><li><code>caseSensitive</code> : Boolean<div class="sub-desc">(optional) True for case sensitive comparison</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>MixedCollection</code><div class="sub-desc">Returns an Ext.util.MixedCollection of the matched records</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-queryBy"></a>\r
- <b>queryBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : MixedCollection <div class="mdesc">\r
- <div class="short">Query the cached records in this Store using a filtering function. The specified function
-will be called with each re...</div>\r
- <div class="long">\r
- Query the cached records in this Store using a filtering function. The specified function
-will be called with each record in this Store. If the function returns <tt>true</tt> the record is
-included in the results. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul>
-<li><b>record</b> : Ext.data.Record<p class="sub-desc">The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">record</a>
-to test for filtering. Access field values using <a ext:cls="Ext.data.Record" ext:member="get" href="output/Ext.data.Record.html#get">Ext.data.Record.get</a>.</p></li>
-<li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
-</ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>MixedCollection</code><div class="sub-desc">Returns an Ext.util.MixedCollection of the matched records</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-rejectChanges"></a>\r
- <b>rejectChanges</b>() : void <div class="mdesc">\r
- <div class="short">Cancel outstanding changes on all changed records.</div>\r
- <div class="long">\r
- Cancel outstanding changes on all changed records. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-relayEvents"></a>\r
- <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">\r
- <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
- <div class="long">\r
- Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-reload"></a>\r
- <b>reload</b>( <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Reloads the Record cache from the configured Proxy using the configured Reader and
-the options from the last load ope...</div>\r
- <div class="long">\r
- <p>Reloads the Record cache from the configured Proxy using the configured Reader and
-the options from the last load operation performed.</p>
-<p><b>It is important to note that for remote data sources, loading is asynchronous,
-and this call will return before the new data has been loaded. Perform any post-processing
-in a callback function, or in a "load" event handler.</b></p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing loading options which may override the options
-used in the last load operation. See <a ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a> for details (defaults to null, in which case
-the most recently used options are reused).</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-remove"></a>\r
- <b>remove</b>( <code>Ext.data.Record record</code> ) : void <div class="mdesc">\r
- <div class="short">Remove a Record from the Store and fires the <a ext:cls="Ext.data.Store" ext:member="remove" href="output/Ext.data.Store.html#remove">remove</a> event.</div>\r
- <div class="long">\r
- Remove a Record from the Store and fires the <a ext:cls="Ext.data.Store" ext:member="remove" href="output/Ext.data.Store.html#remove">remove</a> event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Ext.data.Record object to remove from the cache.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-removeAll"></a>\r
- <b>removeAll</b>() : void <div class="mdesc">\r
- <div class="short">Remove all Records from the Store and fires the <a ext:cls="Ext.data.Store" ext:member="clear" href="output/Ext.data.Store.html#clear">clear</a> event.</div>\r
- <div class="long">\r
- Remove all Records from the Store and fires the <a ext:cls="Ext.data.Store" ext:member="clear" href="output/Ext.data.Store.html#clear">clear</a> event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-removeAt"></a>\r
- <b>removeAt</b>( <code>Number index</code> ) : void <div class="mdesc">\r
- <div class="short">Remove a Record from the Store at the specified index. Fires the <a ext:cls="Ext.data.Store" ext:member="remove" href="output/Ext.data.Store.html#remove">remove</a> event.</div>\r
- <div class="long">\r
- Remove a Record from the Store at the specified index. Fires the <a ext:cls="Ext.data.Store" ext:member="remove" href="output/Ext.data.Store.html#remove">remove</a> event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>index</code> : Number<div class="sub-desc">The index of the record to remove.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-removeListener"></a>\r
- <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener</div>\r
- <div class="long">\r
- Removes a listener <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-resumeEvents"></a>\r
- <b>resumeEvents</b>() : void <div class="mdesc">\r
- <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
- <div class="long">\r
- Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-setDefaultSort"></a>\r
- <b>setDefaultSort</b>( <code>String fieldName</code>, <span class="optional" title="Optional">[<code>String dir</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Sets the default sort column and order to be used by the next load operation.</div>\r
- <div class="long">\r
- Sets the default sort column and order to be used by the next load operation. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>fieldName</code> : String<div class="sub-desc">The name of the field to sort by.</div></li><li><code>dir</code> : String<div class="sub-desc">(optional) The sort order, "ASC" or "DESC" (case-sensitive, defaults to "ASC")</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-sort"></a>\r
- <b>sort</b>( <code>String fieldName</code>, <span class="optional" title="Optional">[<code>String dir</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Sort the Records.
-If remote sorting is used, the sort is performed on the server, and the cache is
-reloaded. If local...</div>\r
- <div class="long">\r
- Sort the Records.
-If remote sorting is used, the sort is performed on the server, and the cache is
-reloaded. If local sorting is used, the cache is sorted internally. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>fieldName</code> : String<div class="sub-desc">The name of the field to sort by.</div></li><li><code>dir</code> : String<div class="sub-desc">(optional) The sort order, "ASC" or "DESC" (case-sensitive, defaults to "ASC")</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-sum"></a>\r
- <b>sum</b>( <code>String property</code>, <code>Number start</code>, <code>Number end</code> ) : Number <div class="mdesc">\r
- <div class="short">Sums the value of <i>property</i> for each record between start and end and returns the result.</div>\r
- <div class="long">\r
- Sums the value of <i>property</i> for each record between start and end and returns the result. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>property</code> : String<div class="sub-desc">A field on your records</div></li><li><code>start</code> : Number<div class="sub-desc">The record index to start at (defaults to 0)</div></li><li><code>end</code> : Number<div class="sub-desc">The last record index to include (defaults to length - 1)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The sum</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-suspendEvents"></a>\r
- <b>suspendEvents</b>() : void <div class="mdesc">\r
- <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
- <div class="long">\r
- Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-un"></a>\r
- <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener (shorthand for removeListener)</div>\r
- <div class="long">\r
- Removes a listener (shorthand for removeListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.data.Store-events"></a>
- <h2>Public Events</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Event</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-add"></a>\r
- <b>add</b> : ( <code>Store this</code>, <code>Ext.data.Record[] records</code>, <code>Number index</code> ) <div class="mdesc">\r
- <div class="short">Fires when Records have been added to the Store</div>\r
- <div class="long">\r
- Fires when Records have been added to the Store <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>records</code> : Ext.data.Record[]<div class="sub-desc">The array of Records added</div></li><li><code>index</code> : Number<div class="sub-desc">The index at which the record(s) were added</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-beforeload"></a>\r
- <b>beforeload</b> : ( <code>Store this</code>, <code>Object options</code> ) <div class="mdesc">\r
- <div class="short">Fires before a request is made for a new data object. If the beforeload handler returns false
-the load action will b...</div>\r
- <div class="long">\r
- Fires before a request is made for a new data object. If the beforeload handler returns false
-the load action will be canceled. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>options</code> : Object<div class="sub-desc">The loading options that were specified (see <a ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a> for details)</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-clear"></a>\r
- <b>clear</b> : ( <code>Store this</code> ) <div class="mdesc">\r
- <div class="short">Fires when the data cache has been cleared.</div>\r
- <div class="long">\r
- Fires when the data cache has been cleared. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Store<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-datachanged"></a>\r
- <b>datachanged</b> : ( <code>Store this</code> ) <div class="mdesc">\r
- <div class="short">Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a
-widget that ...</div>\r
- <div class="long">\r
- Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a
-widget that is using this Store as a Record cache should refresh its view. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Store<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-load"></a>\r
- <b>load</b> : ( <code>Store this</code>, <code>Ext.data.Record[] records</code>, <code>Object options</code> ) <div class="mdesc">\r
- <div class="short">Fires after a new set of Records has been loaded.</div>\r
- <div class="long">\r
- Fires after a new set of Records has been loaded. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>records</code> : Ext.data.Record[]<div class="sub-desc">The Records that were loaded</div></li><li><code>options</code> : Object<div class="sub-desc">The loading options that were specified (see <a ext:cls="Ext.data.Store" ext:member="load" href="output/Ext.data.Store.html#load">load</a> for details)</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-loadexception"></a>\r
- <b>loadexception</b> : () <div class="mdesc">\r
- <div class="short">Fires if an exception occurs in the Proxy during loading.
-Called with the signature of the Proxy's "loadexception" ev...</div>\r
- <div class="long">\r
- Fires if an exception occurs in the Proxy during loading.
-Called with the signature of the Proxy's "loadexception" event. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li>None.</li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-metachange"></a>\r
- <b>metachange</b> : ( <code>Store this</code>, <code>Object meta</code> ) <div class="mdesc">\r
- <div class="short">Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders.</div>\r
- <div class="long">\r
- Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>meta</code> : Object<div class="sub-desc">The JSON metadata</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-remove"></a>\r
- <b>remove</b> : ( <code>Store this</code>, <code>Ext.data.Record record</code>, <code>Number index</code> ) <div class="mdesc">\r
- <div class="short">Fires when a Record has been removed from the Store</div>\r
- <div class="long">\r
- Fires when a Record has been removed from the Store <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Record that was removed</div></li><li><code>index</code> : Number<div class="sub-desc">The index at which the record was removed</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.data.Store-update"></a>\r
- <b>update</b> : ( <code>Store this</code>, <code>Ext.data.Record record</code>, <code>String operation</code> ) <div class="mdesc">\r
- <div class="short">Fires when a Record has been updated</div>\r
- <div class="long">\r
- Fires when a Record has been updated <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Store<div class="sub-desc"></div></li><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Record that was updated</div></li><li><code>operation</code> : String<div class="sub-desc">The update operation being performed. Value may be one of:
-<pre><code>Ext.data.Record.EDIT
- Ext.data.Record.REJECT
- Ext.data.Record.COMMIT</code></pre></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">Store</td>\r
- </tr>\r
- </table>
-
- </div>
\ No newline at end of file