[619] | 1 | <div class="body-wrap"> |
---|
| 2 | <div class="top-tools"> |
---|
| 3 | <a class="inner-link" href="#Ext.data.JsonStore-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
---|
| 4 | <a class="inner-link" href="#Ext.data.JsonStore-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
---|
| 5 | <a class="inner-link" href="#Ext.data.JsonStore-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
---|
| 6 | <a class="inner-link" href="#Ext.data.JsonStore-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> |
---|
| 7 | <a class="bookmark" href="../docs/?class=Ext.data.JsonStore"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
---|
| 8 | </div> |
---|
| 9 | <div class="inheritance res-block"> |
---|
| 10 | <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a> |
---|
| 11 | <img src="resources/elbow-end.gif"/><a ext:cls="Ext.data.Store" ext:member="" href="output/Ext.data.Store.html">Store</a> |
---|
| 12 | <img src="resources/elbow-end.gif"/>JsonStore</pre></div> |
---|
| 13 | <h1>Class Ext.data.JsonStore</h1> |
---|
| 14 | <table cellspacing="0"> |
---|
| 15 | <tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr> |
---|
| 16 | <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/JsonStore.js" target="_blank">JsonStore.js</a></td></tr> |
---|
| 17 | <tr><td class="label">Class:</td><td class="hd-info">JsonStore</td></tr> |
---|
| 18 | <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.data.Store" ext:member="" href="output/Ext.data.Store.html">Store</a></td></tr> |
---|
| 19 | </table> |
---|
| 20 | <div class="description"> |
---|
| 21 | * |
---|
| 22 | Small helper class to make creating Stores for remotely-loaded JSON data easier. JsonStore is pre-configured |
---|
| 23 | with a built-in <a ext:cls="Ext.data.HttpProxy" href="output/Ext.data.HttpProxy.html">Ext.data.HttpProxy</a> and <a ext:cls="Ext.data.JsonReader" href="output/Ext.data.JsonReader.html">Ext.data.JsonReader</a>. If you require some other proxy/reader |
---|
| 24 | combination then you'll have to create a basic <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a> configured as needed.<br/> |
---|
| 25 | <pre><code>var store = <b>new</b> Ext.data.JsonStore({ |
---|
| 26 | url: <em>'get-images.php'</em>, |
---|
| 27 | root: <em>'images'</em>, |
---|
| 28 | fields: [<em>'name'</em>, <em>'url'</em>, {name:<em>'size'</em>, type: <em>'float'</em>}, {name:<em>'lastmod'</em>, type:<em>'date'</em>}] |
---|
| 29 | });</code></pre> |
---|
| 30 | This would consume a returned object of the form: |
---|
| 31 | <pre><code>{ |
---|
| 32 | images: [ |
---|
| 33 | {name: <em>'Image one'</em>, url:<em>'/GetImage.php?id=1'</em>, size:46.5, lastmod: <b>new</b> Date(2007, 10, 29)}, |
---|
| 34 | {name: <em>'Image Two'</em>, url:<em>'/GetImage.php?id=2'</em>, size:43.2, lastmod: <b>new</b> Date(2007, 10, 30)} |
---|
| 35 | ] |
---|
| 36 | }</code></pre> |
---|
| 37 | An object literal of this form could also be used as the <a ext:cls="Ext.data.JsonStore" ext:member="data" href="output/Ext.data.JsonStore.html#data">data</a> config option. |
---|
| 38 | <b>Note: Although they are not listed, this class inherits all of the config options of Store, |
---|
| 39 | JsonReader.</b> </div> |
---|
| 40 | |
---|
| 41 | <div class="hr"></div> |
---|
| 42 | <a id="Ext.data.JsonStore-configs"></a> |
---|
| 43 | <h2>Config Options</h2> |
---|
| 44 | <table cellspacing="0" class="member-table"> |
---|
| 45 | <tr> |
---|
| 46 | <th class="sig-header" colspan="2">Config Options</th> |
---|
| 47 | <th class="msource-header">Defined By</th> |
---|
| 48 | </tr> |
---|
| 49 | <tr class="config-row inherited"> |
---|
| 50 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 51 | <td class="sig"> |
---|
| 52 | <a id="Ext.data.JsonStore-autoLoad"></a> |
---|
| 53 | <b>autoLoad</b> : Boolean/Object <div class="mdesc"> |
---|
| 54 | If passed, this store's load method is automatically called after creation with the autoLoad object </div> |
---|
| 55 | </td> |
---|
| 56 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#autoLoad" href="output/Ext.data.Store.html#autoLoad">Store</a></td> |
---|
| 57 | </tr> |
---|
| 58 | <tr class="config-row inherited alt"> |
---|
| 59 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 60 | <td class="sig"> |
---|
| 61 | <a id="Ext.data.JsonStore-baseParams"></a> |
---|
| 62 | <b>baseParams</b> : Object <div class="mdesc"> |
---|
| 63 | An object containing properties which are to be sent as parameters on any HTTP request </div> |
---|
| 64 | </td> |
---|
| 65 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#baseParams" href="output/Ext.data.Store.html#baseParams">Store</a></td> |
---|
| 66 | </tr> |
---|
| 67 | <tr class="config-row"> |
---|
| 68 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 69 | <td class="sig"> |
---|
| 70 | <a id="Ext.data.JsonStore-data"></a> |
---|
| 71 | <b>data</b> : Object <div class="mdesc"> |
---|
| 72 | A data object readable by this object's JsonReader. Either this option, or the <a ext:cls="Ext.data.JsonStore" ext:member="url" href="output/Ext.data.JsonStore.html#url">url</a> option must be specified. </div> |
---|
| 73 | </td> |
---|
| 74 | <td class="msource">JsonStore</td> |
---|
| 75 | </tr> |
---|
| 76 | <tr class="config-row alt expandable"> |
---|
| 77 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 78 | <td class="sig"> |
---|
| 79 | <a id="Ext.data.JsonStore-fields"></a> |
---|
| 80 | <b>fields</b> : Array <div class="mdesc"> |
---|
| 81 | <div class="short">Either an Array of field definition objects as passed to Ext.data.Record.create, or a Record constructor created usin...</div> |
---|
| 82 | <div class="long"> |
---|
| 83 | Either an Array of field definition objects as passed to <a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">Ext.data.Record.create</a>, or a <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Record</a> constructor created using <a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">Ext.data.Record.create</a>.<br> <p>This config is used to create the <tt>recordType</tt> parameter to the <a ext:cls="Ext.data.JsonReader" ext:member="JsonReader" href="output/Ext.data.JsonReader.html#JsonReader">JsonReader</a> constructor that is implicitly called, and creates the <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Record definition</a> used by the Store. </div> |
---|
| 84 | </div> |
---|
| 85 | </td> |
---|
| 86 | <td class="msource">JsonStore</td> |
---|
| 87 | </tr> |
---|
| 88 | <tr class="config-row inherited expandable"> |
---|
| 89 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 90 | <td class="sig"> |
---|
| 91 | <a id="Ext.data.JsonStore-listeners"></a> |
---|
| 92 | <b>listeners</b> : Object <div class="mdesc"> |
---|
| 93 | <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div> |
---|
| 94 | <div class="long"> |
---|
| 95 | (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> |
---|
| 96 | </div> |
---|
| 97 | </td> |
---|
| 98 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td> |
---|
| 99 | </tr> |
---|
| 100 | <tr class="config-row inherited alt expandable"> |
---|
| 101 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 102 | <td class="sig"> |
---|
| 103 | <a id="Ext.data.JsonStore-pruneModifiedRecords"></a> |
---|
| 104 | <b>pruneModifiedRecords</b> : boolean <div class="mdesc"> |
---|
| 105 | <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> |
---|
| 106 | <div class="long"> |
---|
| 107 | True to clear all modified record information each time the store is loaded or when a record is removed. (defaults to false). </div> |
---|
| 108 | </div> |
---|
| 109 | </td> |
---|
| 110 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#pruneModifiedRecords" href="output/Ext.data.Store.html#pruneModifiedRecords">Store</a></td> |
---|
| 111 | </tr> |
---|
| 112 | <tr class="config-row inherited expandable"> |
---|
| 113 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 114 | <td class="sig"> |
---|
| 115 | <a id="Ext.data.JsonStore-remoteSort"></a> |
---|
| 116 | <b>remoteSort</b> : boolean <div class="mdesc"> |
---|
| 117 | <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> |
---|
| 118 | <div class="long"> |
---|
| 119 | 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> |
---|
| 120 | </div> |
---|
| 121 | </td> |
---|
| 122 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#remoteSort" href="output/Ext.data.Store.html#remoteSort">Store</a></td> |
---|
| 123 | </tr> |
---|
| 124 | <tr class="config-row inherited alt expandable"> |
---|
| 125 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 126 | <td class="sig"> |
---|
| 127 | <a id="Ext.data.JsonStore-sortInfo"></a> |
---|
| 128 | <b>sortInfo</b> : Object <div class="mdesc"> |
---|
| 129 | <div class="short">A config object in the format: {field: "fieldName", direction: "ASC|DESC"} to specify the sort order in the request o...</div> |
---|
| 130 | <div class="long"> |
---|
| 131 | 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> |
---|
| 132 | </div> |
---|
| 133 | </td> |
---|
| 134 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#sortInfo" href="output/Ext.data.Store.html#sortInfo">Store</a></td> |
---|
| 135 | </tr> |
---|
| 136 | <tr class="config-row inherited"> |
---|
| 137 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 138 | <td class="sig"> |
---|
| 139 | <a id="Ext.data.JsonStore-storeId"></a> |
---|
| 140 | <b>storeId</b> : String <div class="mdesc"> |
---|
| 141 | If passed, the id to use to register with the StoreMgr </div> |
---|
| 142 | </td> |
---|
| 143 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#storeId" href="output/Ext.data.Store.html#storeId">Store</a></td> |
---|
| 144 | </tr> |
---|
| 145 | <tr class="config-row alt"> |
---|
| 146 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 147 | <td class="sig"> |
---|
| 148 | <a id="Ext.data.JsonStore-url"></a> |
---|
| 149 | <b>url</b> : String <div class="mdesc"> |
---|
| 150 | The URL from which to load data through an HttpProxy. Either this option, or the <a ext:cls="Ext.data.JsonStore" ext:member="data" href="output/Ext.data.JsonStore.html#data">data</a> option must be specified. </div> |
---|
| 151 | </td> |
---|
| 152 | <td class="msource">JsonStore</td> |
---|
| 153 | </tr> |
---|
| 154 | </table> |
---|
| 155 | <a id="Ext.data.JsonStore-props"></a> |
---|
| 156 | <h2>Public Properties</h2> |
---|
| 157 | <table cellspacing="0" class="member-table"> |
---|
| 158 | <tr> |
---|
| 159 | <th class="sig-header" colspan="2">Property</th> |
---|
| 160 | <th class="msource-header">Defined By</th> |
---|
| 161 | </tr> |
---|
| 162 | <tr class="property-row inherited expandable"> |
---|
| 163 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 164 | <td class="sig"> |
---|
| 165 | <a id="Ext.data.JsonStore-baseParams"></a> |
---|
| 166 | <b>baseParams</b> : Object <div class="mdesc"> |
---|
| 167 | <div class="short">An object containing properties which are used as parameters on any HTTP request. |
---|
| 168 | This property can be changed after ...</div> |
---|
| 169 | <div class="long"> |
---|
| 170 | An object containing properties which are used as parameters on any HTTP request. |
---|
| 171 | This property can be changed after creating the Store to send different parameters. </div> |
---|
| 172 | </div> |
---|
| 173 | </td> |
---|
| 174 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#baseParams" href="output/Ext.data.Store.html#baseParams">Store</a></td> |
---|
| 175 | </tr> |
---|
| 176 | <tr class="property-row inherited alt"> |
---|
| 177 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 178 | <td class="sig"> |
---|
| 179 | <a id="Ext.data.JsonStore-fields"></a> |
---|
| 180 | <b>fields</b> : Ext.util.MixedCollection <div class="mdesc"> |
---|
| 181 | 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> |
---|
| 182 | </td> |
---|
| 183 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#fields" href="output/Ext.data.Store.html#fields">Store</a></td> |
---|
| 184 | </tr> |
---|
| 185 | <tr class="property-row inherited expandable"> |
---|
| 186 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 187 | <td class="sig"> |
---|
| 188 | <a id="Ext.data.JsonStore-lastOptions"></a> |
---|
| 189 | <b>lastOptions</b> : Object <div class="mdesc"> |
---|
| 190 | <div class="short">Contains the last options object used as the parameter to the load method. See load |
---|
| 191 | for the details of what this may ...</div> |
---|
| 192 | <div class="long"> |
---|
| 193 | 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> |
---|
| 194 | for the details of what this may contain. This may be useful for accessing any params which |
---|
| 195 | were used to load the current Record cache. </div> |
---|
| 196 | </div> |
---|
| 197 | </td> |
---|
| 198 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#lastOptions" href="output/Ext.data.Store.html#lastOptions">Store</a></td> |
---|
| 199 | </tr> |
---|
| 200 | <tr class="property-row inherited alt expandable"> |
---|
| 201 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 202 | <td class="sig"> |
---|
| 203 | <a id="Ext.data.JsonStore-paramNames"></a> |
---|
| 204 | <b>paramNames</b> : Object <div class="mdesc"> |
---|
| 205 | <div class="short">An object containing properties which specify the names of the paging and |
---|
| 206 | sorting parameters passed to remote servers...</div> |
---|
| 207 | <div class="long"> |
---|
| 208 | <p>An object containing properties which specify the names of the paging and |
---|
| 209 | sorting parameters passed to remote servers when loading blocks of data. By default, this |
---|
| 210 | object takes the following form:</p><pre><code>{ |
---|
| 211 | start : <em>"start"</em>, <i>// The parameter name which specifies the start row</i> |
---|
| 212 | limit : <em>"limit"</em>, <i>// The parameter name which specifies number of rows to <b>return</b></i> |
---|
| 213 | sort : <em>"sort"</em>, <i>// The parameter name which specifies the column to sort on</i> |
---|
| 214 | dir : <em>"dir"</em> <i>// The parameter name which specifies the sort direction</i> |
---|
| 215 | }</code></pre> |
---|
| 216 | <p>The server must produce the requested data block upon receipt of these parameter names. |
---|
| 217 | If different parameter names are required, this property can be overriden using a configuration |
---|
| 218 | property.</p> |
---|
| 219 | <p>A <a ext:cls="Ext.PagingToolbar" href="output/Ext.PagingToolbar.html">PagingToolbar</a> bound to this grid uses this property to determine |
---|
| 220 | the parameter names to use in its requests. </div> |
---|
| 221 | </div> |
---|
| 222 | </td> |
---|
| 223 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#paramNames" href="output/Ext.data.Store.html#paramNames">Store</a></td> |
---|
| 224 | </tr> |
---|
| 225 | <tr class="property-row inherited expandable"> |
---|
| 226 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 227 | <td class="sig"> |
---|
| 228 | <a id="Ext.data.JsonStore-recordType"></a> |
---|
| 229 | <b>recordType</b> : Function <div class="mdesc"> |
---|
| 230 | <div class="short">The Record constructor as supplied to (or created by) the Reader. Read-only. |
---|
| 231 | If the Reader was constructed by passin...</div> |
---|
| 232 | <div class="long"> |
---|
| 233 | 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. |
---|
| 234 | <p>If the Reader was constructed by passing in an Array of field definition objects, instead of an created |
---|
| 235 | 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> |
---|
| 236 | <p>This property may be used to create new Records of the type held in this Store.</p> </div> |
---|
| 237 | </div> |
---|
| 238 | </td> |
---|
| 239 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#recordType" href="output/Ext.data.Store.html#recordType">Store</a></td> |
---|
| 240 | </tr> |
---|
| 241 | </table> |
---|
| 242 | <a id="Ext.data.JsonStore-methods"></a> |
---|
| 243 | <h2>Public Methods</h2> |
---|
| 244 | <table cellspacing="0" class="member-table"> |
---|
| 245 | <tr> |
---|
| 246 | <th class="sig-header" colspan="2">Method</th> |
---|
| 247 | <th class="msource-header">Defined By</th> |
---|
| 248 | </tr> |
---|
| 249 | <tr class="method-row expandable"> |
---|
| 250 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 251 | <td class="sig"> |
---|
| 252 | <a id="Ext.data.JsonStore-JsonStore"></a> |
---|
| 253 | <b>JsonStore</b>( <code>Object config</code> ) <div class="mdesc"> |
---|
| 254 | <div class="short"></div> |
---|
| 255 | <div class="long"> |
---|
| 256 | <div class="mdetail-params"> |
---|
| 257 | <strong>Parameters:</strong> |
---|
| 258 | <ul><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul> |
---|
| 259 | <strong>Returns:</strong> |
---|
| 260 | <ul> |
---|
| 261 | <li><code></code></li> |
---|
| 262 | </ul> |
---|
| 263 | </div> |
---|
| 264 | </div> |
---|
| 265 | </div> |
---|
| 266 | </td> |
---|
| 267 | <td class="msource">JsonStore</td> |
---|
| 268 | </tr> |
---|
| 269 | <tr class="method-row inherited alt expandable"> |
---|
| 270 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 271 | <td class="sig"> |
---|
| 272 | <a id="Ext.data.JsonStore-add"></a> |
---|
| 273 | <b>add</b>( <code>Ext.data.Record[] records</code> ) : void <div class="mdesc"> |
---|
| 274 | <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> |
---|
| 275 | <div class="long"> |
---|
| 276 | 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"> |
---|
| 277 | <strong>Parameters:</strong> |
---|
| 278 | <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> |
---|
| 279 | <strong>Returns:</strong> |
---|
| 280 | <ul> |
---|
| 281 | <li><code>void</code></li> |
---|
| 282 | </ul> |
---|
| 283 | </div> |
---|
| 284 | </div> |
---|
| 285 | </div> |
---|
| 286 | </td> |
---|
| 287 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#add" href="output/Ext.data.Store.html#add">Store</a></td> |
---|
| 288 | </tr> |
---|
| 289 | <tr class="method-row inherited expandable"> |
---|
| 290 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 291 | <td class="sig"> |
---|
| 292 | <a id="Ext.data.JsonStore-addEvents"></a> |
---|
| 293 | <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc"> |
---|
| 294 | <div class="short">Used to define events on this Observable</div> |
---|
| 295 | <div class="long"> |
---|
| 296 | Used to define events on this Observable <div class="mdetail-params"> |
---|
| 297 | <strong>Parameters:</strong> |
---|
| 298 | <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul> |
---|
| 299 | <strong>Returns:</strong> |
---|
| 300 | <ul> |
---|
| 301 | <li><code>void</code></li> |
---|
| 302 | </ul> |
---|
| 303 | </div> |
---|
| 304 | </div> |
---|
| 305 | </div> |
---|
| 306 | </td> |
---|
| 307 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td> |
---|
| 308 | </tr> |
---|
| 309 | <tr class="method-row inherited alt expandable"> |
---|
| 310 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 311 | <td class="sig"> |
---|
| 312 | <a id="Ext.data.JsonStore-addListener"></a> |
---|
| 313 | <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"> |
---|
| 314 | <div class="short">Appends an event handler to this component</div> |
---|
| 315 | <div class="long"> |
---|
| 316 | Appends an event handler to this component <div class="mdetail-params"> |
---|
| 317 | <strong>Parameters:</strong> |
---|
| 318 | <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 |
---|
| 319 | function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration |
---|
| 320 | properties. This may contain any of the following properties:<ul> |
---|
| 321 | <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> |
---|
| 322 | <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> |
---|
| 323 | <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> |
---|
| 324 | <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 |
---|
| 325 | by the specified number of milliseconds. If the event fires again within that time, the original |
---|
| 326 | handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li> |
---|
| 327 | </ul><br> |
---|
| 328 | <p> |
---|
| 329 | <b>Combining Options</b><br> |
---|
| 330 | Using the options argument, it is possible to combine different types of listeners:<br> |
---|
| 331 | <br> |
---|
| 332 | A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) |
---|
| 333 | <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, { |
---|
| 334 | single: true, |
---|
| 335 | delay: 100, |
---|
| 336 | forumId: 4 |
---|
| 337 | });</code></pre> |
---|
| 338 | <p> |
---|
| 339 | <b>Attaching multiple handlers in 1 call</b><br> |
---|
| 340 | The method also allows for a single argument to be passed which is a config object containing properties |
---|
| 341 | which specify multiple handlers. |
---|
| 342 | <p> |
---|
| 343 | <pre><code>foo.on({ |
---|
| 344 | <em>'click'</em> : { |
---|
| 345 | fn: <b>this</b>.onClick, |
---|
| 346 | scope: <b>this</b>, |
---|
| 347 | delay: 100 |
---|
| 348 | }, |
---|
| 349 | <em>'mouseover'</em> : { |
---|
| 350 | fn: <b>this</b>.onMouseOver, |
---|
| 351 | scope: <b>this</b> |
---|
| 352 | }, |
---|
| 353 | <em>'mouseout'</em> : { |
---|
| 354 | fn: <b>this</b>.onMouseOut, |
---|
| 355 | scope: <b>this</b> |
---|
| 356 | } |
---|
| 357 | });</code></pre> |
---|
| 358 | <p> |
---|
| 359 | Or a shorthand syntax:<br> |
---|
| 360 | <pre><code>foo.on({ |
---|
| 361 | <em>'click'</em> : <b>this</b>.onClick, |
---|
| 362 | <em>'mouseover'</em> : <b>this</b>.onMouseOver, |
---|
| 363 | <em>'mouseout'</em> : <b>this</b>.onMouseOut, |
---|
| 364 | scope: <b>this</b> |
---|
| 365 | });</code></pre></div></li> </ul> |
---|
| 366 | <strong>Returns:</strong> |
---|
| 367 | <ul> |
---|
| 368 | <li><code>void</code></li> |
---|
| 369 | </ul> |
---|
| 370 | </div> |
---|
| 371 | </div> |
---|
| 372 | </div> |
---|
| 373 | </td> |
---|
| 374 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td> |
---|
| 375 | </tr> |
---|
| 376 | <tr class="method-row inherited expandable"> |
---|
| 377 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 378 | <td class="sig"> |
---|
| 379 | <a id="Ext.data.JsonStore-addSorted"></a> |
---|
| 380 | <b>addSorted</b>( <code>Ext.data.Record record</code> ) : void <div class="mdesc"> |
---|
| 381 | <div class="short">(Local sort only) Inserts the passed Record into the Store at the index where it |
---|
| 382 | should go based on the current sort ...</div> |
---|
| 383 | <div class="long"> |
---|
| 384 | (Local sort only) Inserts the passed Record into the Store at the index where it |
---|
| 385 | should go based on the current sort information. <div class="mdetail-params"> |
---|
| 386 | <strong>Parameters:</strong> |
---|
| 387 | <ul><li><code>record</code> : Ext.data.Record<div class="sub-desc"></div></li> </ul> |
---|
| 388 | <strong>Returns:</strong> |
---|
| 389 | <ul> |
---|
| 390 | <li><code>void</code></li> |
---|
| 391 | </ul> |
---|
| 392 | </div> |
---|
| 393 | </div> |
---|
| 394 | </div> |
---|
| 395 | </td> |
---|
| 396 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#addSorted" href="output/Ext.data.Store.html#addSorted">Store</a></td> |
---|
| 397 | </tr> |
---|
| 398 | <tr class="method-row inherited alt expandable"> |
---|
| 399 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 400 | <td class="sig"> |
---|
| 401 | <a id="Ext.data.JsonStore-clearFilter"></a> |
---|
| 402 | <b>clearFilter</b>( <code>Boolean suppressEvent</code> ) : void <div class="mdesc"> |
---|
| 403 | <div class="short">Revert to a view of the Record cache with no filtering applied.</div> |
---|
| 404 | <div class="long"> |
---|
| 405 | Revert to a view of the Record cache with no filtering applied. <div class="mdetail-params"> |
---|
| 406 | <strong>Parameters:</strong> |
---|
| 407 | <ul><li><code>suppressEvent</code> : Boolean<div class="sub-desc">If true the filter is cleared silently without notifying listeners</div></li> </ul> |
---|
| 408 | <strong>Returns:</strong> |
---|
| 409 | <ul> |
---|
| 410 | <li><code>void</code></li> |
---|
| 411 | </ul> |
---|
| 412 | </div> |
---|
| 413 | </div> |
---|
| 414 | </div> |
---|
| 415 | </td> |
---|
| 416 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#clearFilter" href="output/Ext.data.Store.html#clearFilter">Store</a></td> |
---|
| 417 | </tr> |
---|
| 418 | <tr class="method-row inherited expandable"> |
---|
| 419 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 420 | <td class="sig"> |
---|
| 421 | <a id="Ext.data.JsonStore-collect"></a> |
---|
| 422 | <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"> |
---|
| 423 | <div class="short">Collects unique values for a particular dataIndex from this store.</div> |
---|
| 424 | <div class="long"> |
---|
| 425 | Collects unique values for a particular dataIndex from this store. <div class="mdetail-params"> |
---|
| 426 | <strong>Parameters:</strong> |
---|
| 427 | <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> |
---|
| 428 | <strong>Returns:</strong> |
---|
| 429 | <ul> |
---|
| 430 | <li><code>Array</code><div class="sub-desc">An array of the unique values</div></li> |
---|
| 431 | </ul> |
---|
| 432 | </div> |
---|
| 433 | </div> |
---|
| 434 | </div> |
---|
| 435 | </td> |
---|
| 436 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#collect" href="output/Ext.data.Store.html#collect">Store</a></td> |
---|
| 437 | </tr> |
---|
| 438 | <tr class="method-row inherited alt expandable"> |
---|
| 439 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 440 | <td class="sig"> |
---|
| 441 | <a id="Ext.data.JsonStore-commitChanges"></a> |
---|
| 442 | <b>commitChanges</b>() : void <div class="mdesc"> |
---|
| 443 | <div class="short">Commit all Records with outstanding changes. To handle updates for changes, subscribe to the |
---|
| 444 | Store's "update" event, ...</div> |
---|
| 445 | <div class="long"> |
---|
| 446 | Commit all Records with outstanding changes. To handle updates for changes, subscribe to the |
---|
| 447 | Store's "update" event, and perform updating when the third parameter is Ext.data.Record.COMMIT. <div class="mdetail-params"> |
---|
| 448 | <strong>Parameters:</strong> |
---|
| 449 | <ul><li>None.</li> </ul> |
---|
| 450 | <strong>Returns:</strong> |
---|
| 451 | <ul> |
---|
| 452 | <li><code>void</code></li> |
---|
| 453 | </ul> |
---|
| 454 | </div> |
---|
| 455 | </div> |
---|
| 456 | </div> |
---|
| 457 | </td> |
---|
| 458 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#commitChanges" href="output/Ext.data.Store.html#commitChanges">Store</a></td> |
---|
| 459 | </tr> |
---|
| 460 | <tr class="method-row inherited expandable"> |
---|
| 461 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 462 | <td class="sig"> |
---|
| 463 | <a id="Ext.data.JsonStore-each"></a> |
---|
| 464 | <b>each</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
---|
| 465 | <div class="short">Calls the specified function for each of the Records in the cache.</div> |
---|
| 466 | <div class="long"> |
---|
| 467 | Calls the specified function for each of the Records in the cache. <div class="mdetail-params"> |
---|
| 468 | <strong>Parameters:</strong> |
---|
| 469 | <ul><li><code>fn</code> : Function<div class="sub-desc">The function to call. The Record is passed as the first parameter. |
---|
| 470 | 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> |
---|
| 471 | <strong>Returns:</strong> |
---|
| 472 | <ul> |
---|
| 473 | <li><code>void</code></li> |
---|
| 474 | </ul> |
---|
| 475 | </div> |
---|
| 476 | </div> |
---|
| 477 | </div> |
---|
| 478 | </td> |
---|
| 479 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#each" href="output/Ext.data.Store.html#each">Store</a></td> |
---|
| 480 | </tr> |
---|
| 481 | <tr class="method-row inherited alt expandable"> |
---|
| 482 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 483 | <td class="sig"> |
---|
| 484 | <a id="Ext.data.JsonStore-filter"></a> |
---|
| 485 | <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"> |
---|
| 486 | <div class="short">Filter the records by a specified property.</div> |
---|
| 487 | <div class="long"> |
---|
| 488 | Filter the records by a specified property. <div class="mdetail-params"> |
---|
| 489 | <strong>Parameters:</strong> |
---|
| 490 | <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 |
---|
| 491 | 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> |
---|
| 492 | <strong>Returns:</strong> |
---|
| 493 | <ul> |
---|
| 494 | <li><code>void</code></li> |
---|
| 495 | </ul> |
---|
| 496 | </div> |
---|
| 497 | </div> |
---|
| 498 | </div> |
---|
| 499 | </td> |
---|
| 500 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#filter" href="output/Ext.data.Store.html#filter">Store</a></td> |
---|
| 501 | </tr> |
---|
| 502 | <tr class="method-row inherited expandable"> |
---|
| 503 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 504 | <td class="sig"> |
---|
| 505 | <a id="Ext.data.JsonStore-filterBy"></a> |
---|
| 506 | <b>filterBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
---|
| 507 | <div class="short">Filter by a function. The specified function will be called for each |
---|
| 508 | Record in this Store. If the function returns tr...</div> |
---|
| 509 | <div class="long"> |
---|
| 510 | Filter by a function. The specified function will be called for each |
---|
| 511 | Record in this Store. If the function returns <tt>true</tt> the Record is included, |
---|
| 512 | otherwise it is filtered out. <div class="mdetail-params"> |
---|
| 513 | <strong>Parameters:</strong> |
---|
| 514 | <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul> |
---|
| 515 | <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> |
---|
| 516 | 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> |
---|
| 517 | <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li> |
---|
| 518 | </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li> </ul> |
---|
| 519 | <strong>Returns:</strong> |
---|
| 520 | <ul> |
---|
| 521 | <li><code>void</code></li> |
---|
| 522 | </ul> |
---|
| 523 | </div> |
---|
| 524 | </div> |
---|
| 525 | </div> |
---|
| 526 | </td> |
---|
| 527 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#filterBy" href="output/Ext.data.Store.html#filterBy">Store</a></td> |
---|
| 528 | </tr> |
---|
| 529 | <tr class="method-row inherited alt expandable"> |
---|
| 530 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 531 | <td class="sig"> |
---|
| 532 | <a id="Ext.data.JsonStore-find"></a> |
---|
| 533 | <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"> |
---|
| 534 | <div class="short">Finds the index of the first matching record in this store by a specific property/value.</div> |
---|
| 535 | <div class="long"> |
---|
| 536 | Finds the index of the first matching record in this store by a specific property/value. <div class="mdetail-params"> |
---|
| 537 | <strong>Parameters:</strong> |
---|
| 538 | <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 |
---|
| 539 | 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> |
---|
| 540 | <strong>Returns:</strong> |
---|
| 541 | <ul> |
---|
| 542 | <li><code>Number</code><div class="sub-desc">The matched index or -1</div></li> |
---|
| 543 | </ul> |
---|
| 544 | </div> |
---|
| 545 | </div> |
---|
| 546 | </div> |
---|
| 547 | </td> |
---|
| 548 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#find" href="output/Ext.data.Store.html#find">Store</a></td> |
---|
| 549 | </tr> |
---|
| 550 | <tr class="method-row inherited expandable"> |
---|
| 551 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 552 | <td class="sig"> |
---|
| 553 | <a id="Ext.data.JsonStore-findBy"></a> |
---|
| 554 | <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"> |
---|
| 555 | <div class="short">Find the index of the first matching Record in this Store by a function. |
---|
| 556 | If the function returns true it is considere...</div> |
---|
| 557 | <div class="long"> |
---|
| 558 | Find the index of the first matching Record in this Store by a function. |
---|
| 559 | If the function returns <tt>true</tt> it is considered a match. <div class="mdetail-params"> |
---|
| 560 | <strong>Parameters:</strong> |
---|
| 561 | <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul> |
---|
| 562 | <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> |
---|
| 563 | 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> |
---|
| 564 | <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li> |
---|
| 565 | </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> |
---|
| 566 | <strong>Returns:</strong> |
---|
| 567 | <ul> |
---|
| 568 | <li><code>Number</code><div class="sub-desc">The matched index or -1</div></li> |
---|
| 569 | </ul> |
---|
| 570 | </div> |
---|
| 571 | </div> |
---|
| 572 | </div> |
---|
| 573 | </td> |
---|
| 574 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#findBy" href="output/Ext.data.Store.html#findBy">Store</a></td> |
---|
| 575 | </tr> |
---|
| 576 | <tr class="method-row inherited alt expandable"> |
---|
| 577 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 578 | <td class="sig"> |
---|
| 579 | <a id="Ext.data.JsonStore-fireEvent"></a> |
---|
| 580 | <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc"> |
---|
| 581 | <div class="short">Fires the specified event with the passed parameters (minus the event name).</div> |
---|
| 582 | <div class="long"> |
---|
| 583 | Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params"> |
---|
| 584 | <strong>Parameters:</strong> |
---|
| 585 | <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> |
---|
| 586 | <strong>Returns:</strong> |
---|
| 587 | <ul> |
---|
| 588 | <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li> |
---|
| 589 | </ul> |
---|
| 590 | </div> |
---|
| 591 | </div> |
---|
| 592 | </div> |
---|
| 593 | </td> |
---|
| 594 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td> |
---|
| 595 | </tr> |
---|
| 596 | <tr class="method-row inherited expandable"> |
---|
| 597 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 598 | <td class="sig"> |
---|
| 599 | <a id="Ext.data.JsonStore-getAt"></a> |
---|
| 600 | <b>getAt</b>( <code>Number index</code> ) : Ext.data.Record <div class="mdesc"> |
---|
| 601 | <div class="short">Get the Record at the specified index.</div> |
---|
| 602 | <div class="long"> |
---|
| 603 | Get the Record at the specified index. <div class="mdetail-params"> |
---|
| 604 | <strong>Parameters:</strong> |
---|
| 605 | <ul><li><code>index</code> : Number<div class="sub-desc">The index of the Record to find.</div></li> </ul> |
---|
| 606 | <strong>Returns:</strong> |
---|
| 607 | <ul> |
---|
| 608 | <li><code>Ext.data.Record</code><div class="sub-desc">The Record at the passed index. Returns undefined if not found.</div></li> |
---|
| 609 | </ul> |
---|
| 610 | </div> |
---|
| 611 | </div> |
---|
| 612 | </div> |
---|
| 613 | </td> |
---|
| 614 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getAt" href="output/Ext.data.Store.html#getAt">Store</a></td> |
---|
| 615 | </tr> |
---|
| 616 | <tr class="method-row inherited alt expandable"> |
---|
| 617 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 618 | <td class="sig"> |
---|
| 619 | <a id="Ext.data.JsonStore-getById"></a> |
---|
| 620 | <b>getById</b>( <code>String id</code> ) : Ext.data.Record <div class="mdesc"> |
---|
| 621 | <div class="short">Get the Record with the specified id.</div> |
---|
| 622 | <div class="long"> |
---|
| 623 | Get the Record with the specified id. <div class="mdetail-params"> |
---|
| 624 | <strong>Parameters:</strong> |
---|
| 625 | <ul><li><code>id</code> : String<div class="sub-desc">The id of the Record to find.</div></li> </ul> |
---|
| 626 | <strong>Returns:</strong> |
---|
| 627 | <ul> |
---|
| 628 | <li><code>Ext.data.Record</code><div class="sub-desc">The Record with the passed id. Returns undefined if not found.</div></li> |
---|
| 629 | </ul> |
---|
| 630 | </div> |
---|
| 631 | </div> |
---|
| 632 | </div> |
---|
| 633 | </td> |
---|
| 634 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getById" href="output/Ext.data.Store.html#getById">Store</a></td> |
---|
| 635 | </tr> |
---|
| 636 | <tr class="method-row inherited expandable"> |
---|
| 637 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 638 | <td class="sig"> |
---|
| 639 | <a id="Ext.data.JsonStore-getCount"></a> |
---|
| 640 | <b>getCount</b>() : Number <div class="mdesc"> |
---|
| 641 | <div class="short">Gets the number of cached records. |
---|
| 642 | If using paging, this may not be the total size of the dataset. If the data object...</div> |
---|
| 643 | <div class="long"> |
---|
| 644 | Gets the number of cached records. |
---|
| 645 | <p>If using paging, this may not be the total size of the dataset. If the data object |
---|
| 646 | 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 |
---|
| 647 | the dataset size.</p> <div class="mdetail-params"> |
---|
| 648 | <strong>Parameters:</strong> |
---|
| 649 | <ul><li>None.</li> </ul> |
---|
| 650 | <strong>Returns:</strong> |
---|
| 651 | <ul> |
---|
| 652 | <li><code>Number</code><div class="sub-desc">The number of Records in the Store's cache.</div></li> |
---|
| 653 | </ul> |
---|
| 654 | </div> |
---|
| 655 | </div> |
---|
| 656 | </div> |
---|
| 657 | </td> |
---|
| 658 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getCount" href="output/Ext.data.Store.html#getCount">Store</a></td> |
---|
| 659 | </tr> |
---|
| 660 | <tr class="method-row inherited alt expandable"> |
---|
| 661 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 662 | <td class="sig"> |
---|
| 663 | <a id="Ext.data.JsonStore-getModifiedRecords"></a> |
---|
| 664 | <b>getModifiedRecords</b>() : Ext.data.Record[] <div class="mdesc"> |
---|
| 665 | <div class="short">Gets all records modified since the last commit. Modified records are persisted across load operations |
---|
| 666 | (e.g., during...</div> |
---|
| 667 | <div class="long"> |
---|
| 668 | Gets all records modified since the last commit. Modified records are persisted across load operations |
---|
| 669 | (e.g., during paging). <div class="mdetail-params"> |
---|
| 670 | <strong>Parameters:</strong> |
---|
| 671 | <ul><li>None.</li> </ul> |
---|
| 672 | <strong>Returns:</strong> |
---|
| 673 | <ul> |
---|
| 674 | <li><code>Ext.data.Record[]</code><div class="sub-desc">An array of Records containing outstanding modifications.</div></li> |
---|
| 675 | </ul> |
---|
| 676 | </div> |
---|
| 677 | </div> |
---|
| 678 | </div> |
---|
| 679 | </td> |
---|
| 680 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getModifiedRecords" href="output/Ext.data.Store.html#getModifiedRecords">Store</a></td> |
---|
| 681 | </tr> |
---|
| 682 | <tr class="method-row inherited expandable"> |
---|
| 683 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 684 | <td class="sig"> |
---|
| 685 | <a id="Ext.data.JsonStore-getRange"></a> |
---|
| 686 | <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"> |
---|
| 687 | <div class="short">Returns a range of Records between specified indices.</div> |
---|
| 688 | <div class="long"> |
---|
| 689 | Returns a range of Records between specified indices. <div class="mdetail-params"> |
---|
| 690 | <strong>Parameters:</strong> |
---|
| 691 | <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> |
---|
| 692 | <strong>Returns:</strong> |
---|
| 693 | <ul> |
---|
| 694 | <li><code>Ext.data.Record[]</code><div class="sub-desc">An array of Records</div></li> |
---|
| 695 | </ul> |
---|
| 696 | </div> |
---|
| 697 | </div> |
---|
| 698 | </div> |
---|
| 699 | </td> |
---|
| 700 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getRange" href="output/Ext.data.Store.html#getRange">Store</a></td> |
---|
| 701 | </tr> |
---|
| 702 | <tr class="method-row inherited alt expandable"> |
---|
| 703 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 704 | <td class="sig"> |
---|
| 705 | <a id="Ext.data.JsonStore-getSortState"></a> |
---|
| 706 | <b>getSortState</b>() : Object <div class="mdesc"> |
---|
| 707 | <div class="short">Returns an object describing the current sort state of this Store.</div> |
---|
| 708 | <div class="long"> |
---|
| 709 | Returns an object describing the current sort state of this Store. <div class="mdetail-params"> |
---|
| 710 | <strong>Parameters:</strong> |
---|
| 711 | <ul><li>None.</li> </ul> |
---|
| 712 | <strong>Returns:</strong> |
---|
| 713 | <ul> |
---|
| 714 | <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> |
---|
| 715 | </ul> |
---|
| 716 | </div> |
---|
| 717 | </div> |
---|
| 718 | </div> |
---|
| 719 | </td> |
---|
| 720 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getSortState" href="output/Ext.data.Store.html#getSortState">Store</a></td> |
---|
| 721 | </tr> |
---|
| 722 | <tr class="method-row inherited expandable"> |
---|
| 723 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 724 | <td class="sig"> |
---|
| 725 | <a id="Ext.data.JsonStore-getTotalCount"></a> |
---|
| 726 | <b>getTotalCount</b>() : Number <div class="mdesc"> |
---|
| 727 | <div class="short">Gets the total number of records in the dataset as returned by the server. |
---|
| 728 | If using paging, for this to be accurate, ...</div> |
---|
| 729 | <div class="long"> |
---|
| 730 | Gets the total number of records in the dataset as returned by the server. |
---|
| 731 | <p>If using paging, for this to be accurate, the data object used by the Reader must contain |
---|
| 732 | the dataset size. For remote data sources, this is provided by a query on the server.</p> <div class="mdetail-params"> |
---|
| 733 | <strong>Parameters:</strong> |
---|
| 734 | <ul><li>None.</li> </ul> |
---|
| 735 | <strong>Returns:</strong> |
---|
| 736 | <ul> |
---|
| 737 | <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> |
---|
| 738 | </ul> |
---|
| 739 | </div> |
---|
| 740 | </div> |
---|
| 741 | </div> |
---|
| 742 | </td> |
---|
| 743 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#getTotalCount" href="output/Ext.data.Store.html#getTotalCount">Store</a></td> |
---|
| 744 | </tr> |
---|
| 745 | <tr class="method-row inherited alt expandable"> |
---|
| 746 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 747 | <td class="sig"> |
---|
| 748 | <a id="Ext.data.JsonStore-hasListener"></a> |
---|
| 749 | <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc"> |
---|
| 750 | <div class="short">Checks to see if this object has any listeners for a specified event</div> |
---|
| 751 | <div class="long"> |
---|
| 752 | Checks to see if this object has any listeners for a specified event <div class="mdetail-params"> |
---|
| 753 | <strong>Parameters:</strong> |
---|
| 754 | <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul> |
---|
| 755 | <strong>Returns:</strong> |
---|
| 756 | <ul> |
---|
| 757 | <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li> |
---|
| 758 | </ul> |
---|
| 759 | </div> |
---|
| 760 | </div> |
---|
| 761 | </div> |
---|
| 762 | </td> |
---|
| 763 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td> |
---|
| 764 | </tr> |
---|
| 765 | <tr class="method-row inherited expandable"> |
---|
| 766 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 767 | <td class="sig"> |
---|
| 768 | <a id="Ext.data.JsonStore-indexOf"></a> |
---|
| 769 | <b>indexOf</b>( <code>Ext.data.Record record</code> ) : Number <div class="mdesc"> |
---|
| 770 | <div class="short">Get the index within the cache of the passed Record.</div> |
---|
| 771 | <div class="long"> |
---|
| 772 | Get the index within the cache of the passed Record. <div class="mdetail-params"> |
---|
| 773 | <strong>Parameters:</strong> |
---|
| 774 | <ul><li><code>record</code> : Ext.data.Record<div class="sub-desc">The Ext.data.Record object to find.</div></li> </ul> |
---|
| 775 | <strong>Returns:</strong> |
---|
| 776 | <ul> |
---|
| 777 | <li><code>Number</code><div class="sub-desc">The index of the passed Record. Returns -1 if not found.</div></li> |
---|
| 778 | </ul> |
---|
| 779 | </div> |
---|
| 780 | </div> |
---|
| 781 | </div> |
---|
| 782 | </td> |
---|
| 783 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#indexOf" href="output/Ext.data.Store.html#indexOf">Store</a></td> |
---|
| 784 | </tr> |
---|
| 785 | <tr class="method-row inherited alt expandable"> |
---|
| 786 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 787 | <td class="sig"> |
---|
| 788 | <a id="Ext.data.JsonStore-indexOfId"></a> |
---|
| 789 | <b>indexOfId</b>( <code>String id</code> ) : Number <div class="mdesc"> |
---|
| 790 | <div class="short">Get the index within the cache of the Record with the passed id.</div> |
---|
| 791 | <div class="long"> |
---|
| 792 | Get the index within the cache of the Record with the passed id. <div class="mdetail-params"> |
---|
| 793 | <strong>Parameters:</strong> |
---|
| 794 | <ul><li><code>id</code> : String<div class="sub-desc">The id of the Record to find.</div></li> </ul> |
---|
| 795 | <strong>Returns:</strong> |
---|
| 796 | <ul> |
---|
| 797 | <li><code>Number</code><div class="sub-desc">The index of the Record. Returns -1 if not found.</div></li> |
---|
| 798 | </ul> |
---|
| 799 | </div> |
---|
| 800 | </div> |
---|
| 801 | </div> |
---|
| 802 | </td> |
---|
| 803 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#indexOfId" href="output/Ext.data.Store.html#indexOfId">Store</a></td> |
---|
| 804 | </tr> |
---|
| 805 | <tr class="method-row inherited expandable"> |
---|
| 806 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 807 | <td class="sig"> |
---|
| 808 | <a id="Ext.data.JsonStore-insert"></a> |
---|
| 809 | <b>insert</b>( <code>Number index</code>, <code>Ext.data.Record[] records</code> ) : void <div class="mdesc"> |
---|
| 810 | <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> |
---|
| 811 | <div class="long"> |
---|
| 812 | 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"> |
---|
| 813 | <strong>Parameters:</strong> |
---|
| 814 | <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> |
---|
| 815 | <strong>Returns:</strong> |
---|
| 816 | <ul> |
---|
| 817 | <li><code>void</code></li> |
---|
| 818 | </ul> |
---|
| 819 | </div> |
---|
| 820 | </div> |
---|
| 821 | </div> |
---|
| 822 | </td> |
---|
| 823 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#insert" href="output/Ext.data.Store.html#insert">Store</a></td> |
---|
| 824 | </tr> |
---|
| 825 | <tr class="method-row inherited alt expandable"> |
---|
| 826 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 827 | <td class="sig"> |
---|
| 828 | <a id="Ext.data.JsonStore-isFiltered"></a> |
---|
| 829 | <b>isFiltered</b>() : Boolean <div class="mdesc"> |
---|
| 830 | <div class="short">Returns true if this store is currently filtered</div> |
---|
| 831 | <div class="long"> |
---|
| 832 | Returns true if this store is currently filtered <div class="mdetail-params"> |
---|
| 833 | <strong>Parameters:</strong> |
---|
| 834 | <ul><li>None.</li> </ul> |
---|
| 835 | <strong>Returns:</strong> |
---|
| 836 | <ul> |
---|
| 837 | <li><code>Boolean</code></li> |
---|
| 838 | </ul> |
---|
| 839 | </div> |
---|
| 840 | </div> |
---|
| 841 | </div> |
---|
| 842 | </td> |
---|
| 843 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#isFiltered" href="output/Ext.data.Store.html#isFiltered">Store</a></td> |
---|
| 844 | </tr> |
---|
| 845 | <tr class="method-row inherited expandable"> |
---|
| 846 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 847 | <td class="sig"> |
---|
| 848 | <a id="Ext.data.JsonStore-load"></a> |
---|
| 849 | <b>load</b>( <code>Object options</code> ) : Boolean <div class="mdesc"> |
---|
| 850 | <div class="short">Loads the Record cache from the configured Proxy using the configured Reader. |
---|
| 851 | If using remote paging, then the first ...</div> |
---|
| 852 | <div class="long"> |
---|
| 853 | Loads the Record cache from the configured Proxy using the configured Reader. |
---|
| 854 | <p>If using remote paging, then the first load call must specify the <tt>start</tt> |
---|
| 855 | and <tt>limit</tt> properties in the options.params property to establish the initial |
---|
| 856 | position within the dataset, and the number of Records to cache on each read from the Proxy.</p> |
---|
| 857 | <p><b>It is important to note that for remote data sources, loading is asynchronous, |
---|
| 858 | and this call will return before the new data has been loaded. Perform any post-processing |
---|
| 859 | in a callback function, or in a "load" event handler.</b></p> <div class="mdetail-params"> |
---|
| 860 | <strong>Parameters:</strong> |
---|
| 861 | <ul><li><code>options</code> : Object<div class="sub-desc">An object containing properties which control loading options:<ul> |
---|
| 862 | <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> |
---|
| 863 | <li><b>callback</b> : Function<p class="sub-desc">A function to be called after the Records have been loaded. The callback is |
---|
| 864 | passed the following arguments:<ul> |
---|
| 865 | <li>r : Ext.data.Record[]</li> |
---|
| 866 | <li>options: Options object from the load call</li> |
---|
| 867 | <li>success: Boolean success indicator</li></ul></p></li> |
---|
| 868 | <li><b>scope</b> : Object<p class="sub-desc">Scope with which to call the callback (defaults to the Store object)</p></li> |
---|
| 869 | <li><b>add</b> : Boolean<p class="sub-desc">Indicator to append loaded records rather than replace the current cache.</p></li> |
---|
| 870 | </ul></div></li> </ul> |
---|
| 871 | <strong>Returns:</strong> |
---|
| 872 | <ul> |
---|
| 873 | <li><code>Boolean</code><div class="sub-desc">Whether the load fired (if beforeload failed).</div></li> |
---|
| 874 | </ul> |
---|
| 875 | </div> |
---|
| 876 | </div> |
---|
| 877 | </div> |
---|
| 878 | </td> |
---|
| 879 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#load" href="output/Ext.data.Store.html#load">Store</a></td> |
---|
| 880 | </tr> |
---|
| 881 | <tr class="method-row inherited alt expandable"> |
---|
| 882 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 883 | <td class="sig"> |
---|
| 884 | <a id="Ext.data.JsonStore-loadData"></a> |
---|
| 885 | <b>loadData</b>( <code>Object data</code>, <span class="optional" title="Optional">[<code>Boolean add</code>]</span> ) : void <div class="mdesc"> |
---|
| 886 | <div class="short">Loads data from a passed data block and fires the load event. A Reader which understands the format of the data |
---|
| 887 | must ...</div> |
---|
| 888 | <div class="long"> |
---|
| 889 | 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 |
---|
| 890 | must have been configured in the constructor. <div class="mdetail-params"> |
---|
| 891 | <strong>Parameters:</strong> |
---|
| 892 | <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 |
---|
| 893 | 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 |
---|
| 894 | 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 |
---|
| 895 | the Store will <i>replace</i> existing Records. Records with new, unique ids will be added.</b></div></li> </ul> |
---|
| 896 | <strong>Returns:</strong> |
---|
| 897 | <ul> |
---|
| 898 | <li><code>void</code></li> |
---|
| 899 | </ul> |
---|
| 900 | </div> |
---|
| 901 | </div> |
---|
| 902 | </div> |
---|
| 903 | </td> |
---|
| 904 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#loadData" href="output/Ext.data.Store.html#loadData">Store</a></td> |
---|
| 905 | </tr> |
---|
| 906 | <tr class="method-row inherited expandable"> |
---|
| 907 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 908 | <td class="sig"> |
---|
| 909 | <a id="Ext.data.JsonStore-on"></a> |
---|
| 910 | <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"> |
---|
| 911 | <div class="short">Appends an event handler to this element (shorthand for addListener)</div> |
---|
| 912 | <div class="long"> |
---|
| 913 | Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params"> |
---|
| 914 | <strong>Parameters:</strong> |
---|
| 915 | <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 |
---|
| 916 | function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul> |
---|
| 917 | <strong>Returns:</strong> |
---|
| 918 | <ul> |
---|
| 919 | <li><code>void</code></li> |
---|
| 920 | </ul> |
---|
| 921 | </div> |
---|
| 922 | </div> |
---|
| 923 | </div> |
---|
| 924 | </td> |
---|
| 925 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td> |
---|
| 926 | </tr> |
---|
| 927 | <tr class="method-row inherited alt expandable"> |
---|
| 928 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 929 | <td class="sig"> |
---|
| 930 | <a id="Ext.data.JsonStore-purgeListeners"></a> |
---|
| 931 | <b>purgeListeners</b>() : void <div class="mdesc"> |
---|
| 932 | <div class="short">Removes all listeners for this object</div> |
---|
| 933 | <div class="long"> |
---|
| 934 | Removes all listeners for this object <div class="mdetail-params"> |
---|
| 935 | <strong>Parameters:</strong> |
---|
| 936 | <ul><li>None.</li> </ul> |
---|
| 937 | <strong>Returns:</strong> |
---|
| 938 | <ul> |
---|
| 939 | <li><code>void</code></li> |
---|
| 940 | </ul> |
---|
| 941 | </div> |
---|
| 942 | </div> |
---|
| 943 | </div> |
---|
| 944 | </td> |
---|
| 945 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td> |
---|
| 946 | </tr> |
---|
| 947 | <tr class="method-row inherited expandable"> |
---|
| 948 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 949 | <td class="sig"> |
---|
| 950 | <a id="Ext.data.JsonStore-query"></a> |
---|
| 951 | <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"> |
---|
| 952 | <div class="short">Query the records by a specified property.</div> |
---|
| 953 | <div class="long"> |
---|
| 954 | Query the records by a specified property. <div class="mdetail-params"> |
---|
| 955 | <strong>Parameters:</strong> |
---|
| 956 | <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 |
---|
| 957 | 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> |
---|
| 958 | <strong>Returns:</strong> |
---|
| 959 | <ul> |
---|
| 960 | <li><code>MixedCollection</code><div class="sub-desc">Returns an Ext.util.MixedCollection of the matched records</div></li> |
---|
| 961 | </ul> |
---|
| 962 | </div> |
---|
| 963 | </div> |
---|
| 964 | </div> |
---|
| 965 | </td> |
---|
| 966 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#query" href="output/Ext.data.Store.html#query">Store</a></td> |
---|
| 967 | </tr> |
---|
| 968 | <tr class="method-row inherited alt expandable"> |
---|
| 969 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 970 | <td class="sig"> |
---|
| 971 | <a id="Ext.data.JsonStore-queryBy"></a> |
---|
| 972 | <b>queryBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : MixedCollection <div class="mdesc"> |
---|
| 973 | <div class="short">Query the cached records in this Store using a filtering function. The specified function |
---|
| 974 | will be called with each re...</div> |
---|
| 975 | <div class="long"> |
---|
| 976 | Query the cached records in this Store using a filtering function. The specified function |
---|
| 977 | will be called with each record in this Store. If the function returns <tt>true</tt> the record is |
---|
| 978 | included in the results. <div class="mdetail-params"> |
---|
| 979 | <strong>Parameters:</strong> |
---|
| 980 | <ul><li><code>fn</code> : Function<div class="sub-desc">The function to be called. It will be passed the following parameters:<ul> |
---|
| 981 | <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> |
---|
| 982 | 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> |
---|
| 983 | <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li> |
---|
| 984 | </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to this)</div></li> </ul> |
---|
| 985 | <strong>Returns:</strong> |
---|
| 986 | <ul> |
---|
| 987 | <li><code>MixedCollection</code><div class="sub-desc">Returns an Ext.util.MixedCollection of the matched records</div></li> |
---|
| 988 | </ul> |
---|
| 989 | </div> |
---|
| 990 | </div> |
---|
| 991 | </div> |
---|
| 992 | </td> |
---|
| 993 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#queryBy" href="output/Ext.data.Store.html#queryBy">Store</a></td> |
---|
| 994 | </tr> |
---|
| 995 | <tr class="method-row inherited expandable"> |
---|
| 996 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 997 | <td class="sig"> |
---|
| 998 | <a id="Ext.data.JsonStore-rejectChanges"></a> |
---|
| 999 | <b>rejectChanges</b>() : void <div class="mdesc"> |
---|
| 1000 | <div class="short">Cancel outstanding changes on all changed records.</div> |
---|
| 1001 | <div class="long"> |
---|
| 1002 | Cancel outstanding changes on all changed records. <div class="mdetail-params"> |
---|
| 1003 | <strong>Parameters:</strong> |
---|
| 1004 | <ul><li>None.</li> </ul> |
---|
| 1005 | <strong>Returns:</strong> |
---|
| 1006 | <ul> |
---|
| 1007 | <li><code>void</code></li> |
---|
| 1008 | </ul> |
---|
| 1009 | </div> |
---|
| 1010 | </div> |
---|
| 1011 | </div> |
---|
| 1012 | </td> |
---|
| 1013 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#rejectChanges" href="output/Ext.data.Store.html#rejectChanges">Store</a></td> |
---|
| 1014 | </tr> |
---|
| 1015 | <tr class="method-row inherited alt expandable"> |
---|
| 1016 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1017 | <td class="sig"> |
---|
| 1018 | <a id="Ext.data.JsonStore-relayEvents"></a> |
---|
| 1019 | <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc"> |
---|
| 1020 | <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div> |
---|
| 1021 | <div class="long"> |
---|
| 1022 | Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params"> |
---|
| 1023 | <strong>Parameters:</strong> |
---|
| 1024 | <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> |
---|
| 1025 | <strong>Returns:</strong> |
---|
| 1026 | <ul> |
---|
| 1027 | <li><code>void</code></li> |
---|
| 1028 | </ul> |
---|
| 1029 | </div> |
---|
| 1030 | </div> |
---|
| 1031 | </div> |
---|
| 1032 | </td> |
---|
| 1033 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td> |
---|
| 1034 | </tr> |
---|
| 1035 | <tr class="method-row inherited expandable"> |
---|
| 1036 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1037 | <td class="sig"> |
---|
| 1038 | <a id="Ext.data.JsonStore-reload"></a> |
---|
| 1039 | <b>reload</b>( <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc"> |
---|
| 1040 | <div class="short">Reloads the Record cache from the configured Proxy using the configured Reader and |
---|
| 1041 | the options from the last load ope...</div> |
---|
| 1042 | <div class="long"> |
---|
| 1043 | <p>Reloads the Record cache from the configured Proxy using the configured Reader and |
---|
| 1044 | the options from the last load operation performed.</p> |
---|
| 1045 | <p><b>It is important to note that for remote data sources, loading is asynchronous, |
---|
| 1046 | and this call will return before the new data has been loaded. Perform any post-processing |
---|
| 1047 | in a callback function, or in a "load" event handler.</b></p> <div class="mdetail-params"> |
---|
| 1048 | <strong>Parameters:</strong> |
---|
| 1049 | <ul><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing loading options which may override the options |
---|
| 1050 | 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 |
---|
| 1051 | the most recently used options are reused).</div></li> </ul> |
---|
| 1052 | <strong>Returns:</strong> |
---|
| 1053 | <ul> |
---|
| 1054 | <li><code>void</code></li> |
---|
| 1055 | </ul> |
---|
| 1056 | </div> |
---|
| 1057 | </div> |
---|
| 1058 | </div> |
---|
| 1059 | </td> |
---|
| 1060 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#reload" href="output/Ext.data.Store.html#reload">Store</a></td> |
---|
| 1061 | </tr> |
---|
| 1062 | <tr class="method-row inherited alt expandable"> |
---|
| 1063 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1064 | <td class="sig"> |
---|
| 1065 | <a id="Ext.data.JsonStore-remove"></a> |
---|
| 1066 | <b>remove</b>( <code>Ext.data.Record record</code> ) : void <div class="mdesc"> |
---|
| 1067 | <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> |
---|
| 1068 | <div class="long"> |
---|
| 1069 | 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"> |
---|
| 1070 | <strong>Parameters:</strong> |
---|
| 1071 | <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> |
---|
| 1072 | <strong>Returns:</strong> |
---|
| 1073 | <ul> |
---|
| 1074 | <li><code>void</code></li> |
---|
| 1075 | </ul> |
---|
| 1076 | </div> |
---|
| 1077 | </div> |
---|
| 1078 | </div> |
---|
| 1079 | </td> |
---|
| 1080 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#remove" href="output/Ext.data.Store.html#remove">Store</a></td> |
---|
| 1081 | </tr> |
---|
| 1082 | <tr class="method-row inherited expandable"> |
---|
| 1083 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1084 | <td class="sig"> |
---|
| 1085 | <a id="Ext.data.JsonStore-removeAll"></a> |
---|
| 1086 | <b>removeAll</b>() : void <div class="mdesc"> |
---|
| 1087 | <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> |
---|
| 1088 | <div class="long"> |
---|
| 1089 | 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"> |
---|
| 1090 | <strong>Parameters:</strong> |
---|
| 1091 | <ul><li>None.</li> </ul> |
---|
| 1092 | <strong>Returns:</strong> |
---|
| 1093 | <ul> |
---|
| 1094 | <li><code>void</code></li> |
---|
| 1095 | </ul> |
---|
| 1096 | </div> |
---|
| 1097 | </div> |
---|
| 1098 | </div> |
---|
| 1099 | </td> |
---|
| 1100 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#removeAll" href="output/Ext.data.Store.html#removeAll">Store</a></td> |
---|
| 1101 | </tr> |
---|
| 1102 | <tr class="method-row inherited alt expandable"> |
---|
| 1103 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1104 | <td class="sig"> |
---|
| 1105 | <a id="Ext.data.JsonStore-removeAt"></a> |
---|
| 1106 | <b>removeAt</b>( <code>Number index</code> ) : void <div class="mdesc"> |
---|
| 1107 | <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> |
---|
| 1108 | <div class="long"> |
---|
| 1109 | 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"> |
---|
| 1110 | <strong>Parameters:</strong> |
---|
| 1111 | <ul><li><code>index</code> : Number<div class="sub-desc">The index of the record to remove.</div></li> </ul> |
---|
| 1112 | <strong>Returns:</strong> |
---|
| 1113 | <ul> |
---|
| 1114 | <li><code>void</code></li> |
---|
| 1115 | </ul> |
---|
| 1116 | </div> |
---|
| 1117 | </div> |
---|
| 1118 | </div> |
---|
| 1119 | </td> |
---|
| 1120 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#removeAt" href="output/Ext.data.Store.html#removeAt">Store</a></td> |
---|
| 1121 | </tr> |
---|
| 1122 | <tr class="method-row inherited expandable"> |
---|
| 1123 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1124 | <td class="sig"> |
---|
| 1125 | <a id="Ext.data.JsonStore-removeListener"></a> |
---|
| 1126 | <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"> |
---|
| 1127 | <div class="short">Removes a listener</div> |
---|
| 1128 | <div class="long"> |
---|
| 1129 | Removes a listener <div class="mdetail-params"> |
---|
| 1130 | <strong>Parameters:</strong> |
---|
| 1131 | <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> |
---|
| 1132 | <strong>Returns:</strong> |
---|
| 1133 | <ul> |
---|
| 1134 | <li><code>void</code></li> |
---|
| 1135 | </ul> |
---|
| 1136 | </div> |
---|
| 1137 | </div> |
---|
| 1138 | </div> |
---|
| 1139 | </td> |
---|
| 1140 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td> |
---|
| 1141 | </tr> |
---|
| 1142 | <tr class="method-row inherited alt expandable"> |
---|
| 1143 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1144 | <td class="sig"> |
---|
| 1145 | <a id="Ext.data.JsonStore-resumeEvents"></a> |
---|
| 1146 | <b>resumeEvents</b>() : void <div class="mdesc"> |
---|
| 1147 | <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> |
---|
| 1148 | <div class="long"> |
---|
| 1149 | 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"> |
---|
| 1150 | <strong>Parameters:</strong> |
---|
| 1151 | <ul><li>None.</li> </ul> |
---|
| 1152 | <strong>Returns:</strong> |
---|
| 1153 | <ul> |
---|
| 1154 | <li><code>void</code></li> |
---|
| 1155 | </ul> |
---|
| 1156 | </div> |
---|
| 1157 | </div> |
---|
| 1158 | </div> |
---|
| 1159 | </td> |
---|
| 1160 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td> |
---|
| 1161 | </tr> |
---|
| 1162 | <tr class="method-row inherited expandable"> |
---|
| 1163 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1164 | <td class="sig"> |
---|
| 1165 | <a id="Ext.data.JsonStore-setDefaultSort"></a> |
---|
| 1166 | <b>setDefaultSort</b>( <code>String fieldName</code>, <span class="optional" title="Optional">[<code>String dir</code>]</span> ) : void <div class="mdesc"> |
---|
| 1167 | <div class="short">Sets the default sort column and order to be used by the next load operation.</div> |
---|
| 1168 | <div class="long"> |
---|
| 1169 | Sets the default sort column and order to be used by the next load operation. <div class="mdetail-params"> |
---|
| 1170 | <strong>Parameters:</strong> |
---|
| 1171 | <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> |
---|
| 1172 | <strong>Returns:</strong> |
---|
| 1173 | <ul> |
---|
| 1174 | <li><code>void</code></li> |
---|
| 1175 | </ul> |
---|
| 1176 | </div> |
---|
| 1177 | </div> |
---|
| 1178 | </div> |
---|
| 1179 | </td> |
---|
| 1180 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#setDefaultSort" href="output/Ext.data.Store.html#setDefaultSort">Store</a></td> |
---|
| 1181 | </tr> |
---|
| 1182 | <tr class="method-row inherited alt expandable"> |
---|
| 1183 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1184 | <td class="sig"> |
---|
| 1185 | <a id="Ext.data.JsonStore-sort"></a> |
---|
| 1186 | <b>sort</b>( <code>String fieldName</code>, <span class="optional" title="Optional">[<code>String dir</code>]</span> ) : void <div class="mdesc"> |
---|
| 1187 | <div class="short">Sort the Records. |
---|
| 1188 | If remote sorting is used, the sort is performed on the server, and the cache is |
---|
| 1189 | reloaded. If local...</div> |
---|
| 1190 | <div class="long"> |
---|
| 1191 | Sort the Records. |
---|
| 1192 | If remote sorting is used, the sort is performed on the server, and the cache is |
---|
| 1193 | reloaded. If local sorting is used, the cache is sorted internally. <div class="mdetail-params"> |
---|
| 1194 | <strong>Parameters:</strong> |
---|
| 1195 | <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> |
---|
| 1196 | <strong>Returns:</strong> |
---|
| 1197 | <ul> |
---|
| 1198 | <li><code>void</code></li> |
---|
| 1199 | </ul> |
---|
| 1200 | </div> |
---|
| 1201 | </div> |
---|
| 1202 | </div> |
---|
| 1203 | </td> |
---|
| 1204 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#sort" href="output/Ext.data.Store.html#sort">Store</a></td> |
---|
| 1205 | </tr> |
---|
| 1206 | <tr class="method-row inherited expandable"> |
---|
| 1207 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1208 | <td class="sig"> |
---|
| 1209 | <a id="Ext.data.JsonStore-sum"></a> |
---|
| 1210 | <b>sum</b>( <code>String property</code>, <code>Number start</code>, <code>Number end</code> ) : Number <div class="mdesc"> |
---|
| 1211 | <div class="short">Sums the value of <i>property</i> for each record between start and end and returns the result.</div> |
---|
| 1212 | <div class="long"> |
---|
| 1213 | Sums the value of <i>property</i> for each record between start and end and returns the result. <div class="mdetail-params"> |
---|
| 1214 | <strong>Parameters:</strong> |
---|
| 1215 | <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> |
---|
| 1216 | <strong>Returns:</strong> |
---|
| 1217 | <ul> |
---|
| 1218 | <li><code>Number</code><div class="sub-desc">The sum</div></li> |
---|
| 1219 | </ul> |
---|
| 1220 | </div> |
---|
| 1221 | </div> |
---|
| 1222 | </div> |
---|
| 1223 | </td> |
---|
| 1224 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#sum" href="output/Ext.data.Store.html#sum">Store</a></td> |
---|
| 1225 | </tr> |
---|
| 1226 | <tr class="method-row inherited alt expandable"> |
---|
| 1227 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1228 | <td class="sig"> |
---|
| 1229 | <a id="Ext.data.JsonStore-suspendEvents"></a> |
---|
| 1230 | <b>suspendEvents</b>() : void <div class="mdesc"> |
---|
| 1231 | <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> |
---|
| 1232 | <div class="long"> |
---|
| 1233 | 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"> |
---|
| 1234 | <strong>Parameters:</strong> |
---|
| 1235 | <ul><li>None.</li> </ul> |
---|
| 1236 | <strong>Returns:</strong> |
---|
| 1237 | <ul> |
---|
| 1238 | <li><code>void</code></li> |
---|
| 1239 | </ul> |
---|
| 1240 | </div> |
---|
| 1241 | </div> |
---|
| 1242 | </div> |
---|
| 1243 | </td> |
---|
| 1244 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td> |
---|
| 1245 | </tr> |
---|
| 1246 | <tr class="method-row inherited expandable"> |
---|
| 1247 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1248 | <td class="sig"> |
---|
| 1249 | <a id="Ext.data.JsonStore-un"></a> |
---|
| 1250 | <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"> |
---|
| 1251 | <div class="short">Removes a listener (shorthand for removeListener)</div> |
---|
| 1252 | <div class="long"> |
---|
| 1253 | Removes a listener (shorthand for removeListener) <div class="mdetail-params"> |
---|
| 1254 | <strong>Parameters:</strong> |
---|
| 1255 | <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> |
---|
| 1256 | <strong>Returns:</strong> |
---|
| 1257 | <ul> |
---|
| 1258 | <li><code>void</code></li> |
---|
| 1259 | </ul> |
---|
| 1260 | </div> |
---|
| 1261 | </div> |
---|
| 1262 | </div> |
---|
| 1263 | </td> |
---|
| 1264 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td> |
---|
| 1265 | </tr> |
---|
| 1266 | </table> |
---|
| 1267 | <a id="Ext.data.JsonStore-events"></a> |
---|
| 1268 | <h2>Public Events</h2> |
---|
| 1269 | <table cellspacing="0" class="member-table"> |
---|
| 1270 | <tr> |
---|
| 1271 | <th class="sig-header" colspan="2">Event</th> |
---|
| 1272 | <th class="msource-header">Defined By</th> |
---|
| 1273 | </tr> |
---|
| 1274 | <tr class="event-row inherited expandable"> |
---|
| 1275 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1276 | <td class="sig"> |
---|
| 1277 | <a id="Ext.data.JsonStore-add"></a> |
---|
| 1278 | <b>add</b> : ( <code>Store this</code>, <code>Ext.data.Record[] records</code>, <code>Number index</code> ) <div class="mdesc"> |
---|
| 1279 | <div class="short">Fires when Records have been added to the Store</div> |
---|
| 1280 | <div class="long"> |
---|
| 1281 | Fires when Records have been added to the Store <div class="mdetail-params"> |
---|
| 1282 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
| 1283 | <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> |
---|
| 1284 | </div> |
---|
| 1285 | </div> |
---|
| 1286 | </div> |
---|
| 1287 | </td> |
---|
| 1288 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-add" href="output/Ext.data.Store.html#event-add">Store</a></td> |
---|
| 1289 | </tr> |
---|
| 1290 | <tr class="event-row inherited alt expandable"> |
---|
| 1291 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1292 | <td class="sig"> |
---|
| 1293 | <a id="Ext.data.JsonStore-beforeload"></a> |
---|
| 1294 | <b>beforeload</b> : ( <code>Store this</code>, <code>Object options</code> ) <div class="mdesc"> |
---|
| 1295 | <div class="short">Fires before a request is made for a new data object. If the beforeload handler returns false |
---|
| 1296 | the load action will b...</div> |
---|
| 1297 | <div class="long"> |
---|
| 1298 | Fires before a request is made for a new data object. If the beforeload handler returns false |
---|
| 1299 | the load action will be canceled. <div class="mdetail-params"> |
---|
| 1300 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
| 1301 | <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> |
---|
| 1302 | </div> |
---|
| 1303 | </div> |
---|
| 1304 | </div> |
---|
| 1305 | </td> |
---|
| 1306 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-beforeload" href="output/Ext.data.Store.html#event-beforeload">Store</a></td> |
---|
| 1307 | </tr> |
---|
| 1308 | <tr class="event-row inherited expandable"> |
---|
| 1309 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1310 | <td class="sig"> |
---|
| 1311 | <a id="Ext.data.JsonStore-clear"></a> |
---|
| 1312 | <b>clear</b> : ( <code>Store this</code> ) <div class="mdesc"> |
---|
| 1313 | <div class="short">Fires when the data cache has been cleared.</div> |
---|
| 1314 | <div class="long"> |
---|
| 1315 | Fires when the data cache has been cleared. <div class="mdetail-params"> |
---|
| 1316 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
| 1317 | <ul><li><code>this</code> : Store<div class="sub-desc"></div></li> </ul> |
---|
| 1318 | </div> |
---|
| 1319 | </div> |
---|
| 1320 | </div> |
---|
| 1321 | </td> |
---|
| 1322 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-clear" href="output/Ext.data.Store.html#event-clear">Store</a></td> |
---|
| 1323 | </tr> |
---|
| 1324 | <tr class="event-row inherited alt expandable"> |
---|
| 1325 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1326 | <td class="sig"> |
---|
| 1327 | <a id="Ext.data.JsonStore-datachanged"></a> |
---|
| 1328 | <b>datachanged</b> : ( <code>Store this</code> ) <div class="mdesc"> |
---|
| 1329 | <div class="short">Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a |
---|
| 1330 | widget that ...</div> |
---|
| 1331 | <div class="long"> |
---|
| 1332 | Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a |
---|
| 1333 | widget that is using this Store as a Record cache should refresh its view. <div class="mdetail-params"> |
---|
| 1334 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
| 1335 | <ul><li><code>this</code> : Store<div class="sub-desc"></div></li> </ul> |
---|
| 1336 | </div> |
---|
| 1337 | </div> |
---|
| 1338 | </div> |
---|
| 1339 | </td> |
---|
| 1340 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-datachanged" href="output/Ext.data.Store.html#event-datachanged">Store</a></td> |
---|
| 1341 | </tr> |
---|
| 1342 | <tr class="event-row inherited expandable"> |
---|
| 1343 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1344 | <td class="sig"> |
---|
| 1345 | <a id="Ext.data.JsonStore-load"></a> |
---|
| 1346 | <b>load</b> : ( <code>Store this</code>, <code>Ext.data.Record[] records</code>, <code>Object options</code> ) <div class="mdesc"> |
---|
| 1347 | <div class="short">Fires after a new set of Records has been loaded.</div> |
---|
| 1348 | <div class="long"> |
---|
| 1349 | Fires after a new set of Records has been loaded. <div class="mdetail-params"> |
---|
| 1350 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
| 1351 | <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> |
---|
| 1352 | </div> |
---|
| 1353 | </div> |
---|
| 1354 | </div> |
---|
| 1355 | </td> |
---|
| 1356 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-load" href="output/Ext.data.Store.html#event-load">Store</a></td> |
---|
| 1357 | </tr> |
---|
| 1358 | <tr class="event-row inherited alt expandable"> |
---|
| 1359 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1360 | <td class="sig"> |
---|
| 1361 | <a id="Ext.data.JsonStore-loadexception"></a> |
---|
| 1362 | <b>loadexception</b> : () <div class="mdesc"> |
---|
| 1363 | <div class="short">Fires if an exception occurs in the Proxy during loading. |
---|
| 1364 | Called with the signature of the Proxy's "loadexception" ev...</div> |
---|
| 1365 | <div class="long"> |
---|
| 1366 | Fires if an exception occurs in the Proxy during loading. |
---|
| 1367 | Called with the signature of the Proxy's "loadexception" event. <div class="mdetail-params"> |
---|
| 1368 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
| 1369 | <ul><li>None.</li> </ul> |
---|
| 1370 | </div> |
---|
| 1371 | </div> |
---|
| 1372 | </div> |
---|
| 1373 | </td> |
---|
| 1374 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-loadexception" href="output/Ext.data.Store.html#event-loadexception">Store</a></td> |
---|
| 1375 | </tr> |
---|
| 1376 | <tr class="event-row inherited expandable"> |
---|
| 1377 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1378 | <td class="sig"> |
---|
| 1379 | <a id="Ext.data.JsonStore-metachange"></a> |
---|
| 1380 | <b>metachange</b> : ( <code>Store this</code>, <code>Object meta</code> ) <div class="mdesc"> |
---|
| 1381 | <div class="short">Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders.</div> |
---|
| 1382 | <div class="long"> |
---|
| 1383 | Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders. <div class="mdetail-params"> |
---|
| 1384 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
| 1385 | <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> |
---|
| 1386 | </div> |
---|
| 1387 | </div> |
---|
| 1388 | </div> |
---|
| 1389 | </td> |
---|
| 1390 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-metachange" href="output/Ext.data.Store.html#event-metachange">Store</a></td> |
---|
| 1391 | </tr> |
---|
| 1392 | <tr class="event-row inherited alt expandable"> |
---|
| 1393 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1394 | <td class="sig"> |
---|
| 1395 | <a id="Ext.data.JsonStore-remove"></a> |
---|
| 1396 | <b>remove</b> : ( <code>Store this</code>, <code>Ext.data.Record record</code>, <code>Number index</code> ) <div class="mdesc"> |
---|
| 1397 | <div class="short">Fires when a Record has been removed from the Store</div> |
---|
| 1398 | <div class="long"> |
---|
| 1399 | Fires when a Record has been removed from the Store <div class="mdetail-params"> |
---|
| 1400 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
| 1401 | <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> |
---|
| 1402 | </div> |
---|
| 1403 | </div> |
---|
| 1404 | </div> |
---|
| 1405 | </td> |
---|
| 1406 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-remove" href="output/Ext.data.Store.html#event-remove">Store</a></td> |
---|
| 1407 | </tr> |
---|
| 1408 | <tr class="event-row inherited expandable"> |
---|
| 1409 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
| 1410 | <td class="sig"> |
---|
| 1411 | <a id="Ext.data.JsonStore-update"></a> |
---|
| 1412 | <b>update</b> : ( <code>Store this</code>, <code>Ext.data.Record record</code>, <code>String operation</code> ) <div class="mdesc"> |
---|
| 1413 | <div class="short">Fires when a Record has been updated</div> |
---|
| 1414 | <div class="long"> |
---|
| 1415 | Fires when a Record has been updated <div class="mdetail-params"> |
---|
| 1416 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
| 1417 | <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: |
---|
| 1418 | <pre><code>Ext.data.Record.EDIT |
---|
| 1419 | Ext.data.Record.REJECT |
---|
| 1420 | Ext.data.Record.COMMIT</code></pre></div></li> </ul> |
---|
| 1421 | </div> |
---|
| 1422 | </div> |
---|
| 1423 | </div> |
---|
| 1424 | </td> |
---|
| 1425 | <td class="msource"><a ext:cls="Ext.data.Store" ext:member="#event-update" href="output/Ext.data.Store.html#event-update">Store</a></td> |
---|
| 1426 | </tr> |
---|
| 1427 | </table> |
---|
| 1428 | |
---|
| 1429 | </div> |
---|