docs/output/Ext.data.ArrayReader.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.data.ArrayReader-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.data.ArrayReader-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.data.ArrayReader-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                             <a class="inner-link" href="#Ext.data.ArrayReader-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.ArrayReader"><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.data.DataReader" ext:member="" href="output/Ext.data.DataReader.html">DataReader</a>
  11   <img src="resources/elbow-end.gif"/><a ext:cls="Ext.data.JsonReader" ext:member="" href="output/Ext.data.JsonReader.html">JsonReader</a>
  12     <img src="resources/elbow-end.gif"/>ArrayReader</pre></div>
  13                 <h1>Class Ext.data.ArrayReader</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/ArrayReader.js" target="_blank">ArrayReader.js</a></td></tr>
  17             <tr><td class="label">Class:</td><td class="hd-info">ArrayReader</td></tr>
  18                                     <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.data.JsonReader" ext:member="" href="output/Ext.data.JsonReader.html">JsonReader</a></td></tr>
  19                     </table>
  20         <div class="description">
  21             *
  22 Data reader class to create an Array of <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Ext.data.Record</a> objects from an Array.
  23 Each element of that Array represents a row of data fields. The
  24 fields are pulled into a Record object using as a subscript, the <em>mapping</em> property
  25 of the field definition if it exists, or the field's ordinal position in the definition.<br>
  26 <p>
  27 Example code:.
  28 <pre><code>var Employee = Ext.data.Record.create([
  29     {name: <em>'name'</em>, mapping: 1},         <i>// <em>"mapping"</em> only needed <b>if</b> an <em>"id"</em> field is present which</i>
  30     {name: <em>'occupation'</em>, mapping: 2}    <i>// precludes using the ordinal position as the index.</i>
  31 ]);
  32 <b>var</b> myReader = <b>new</b> Ext.data.ArrayReader({
  33     id: 0                     <i>// The subscript within row Array that provides an ID <b>for</b> the Record (optional)</i>
  34 }, Employee);</code></pre>
  35 <p>
  36 This would consume an Array like this:
  37 <pre><code>[ [1, <em>'Bill'</em>, <em>'Gardener'</em>], [2, <em>'Ben'</em>, <em>'Horticulturalist'</em>] ]</code></pre>        </div>
  38
  39         <div class="hr"></div>
  40                 <a id="Ext.data.ArrayReader-configs"></a>
  41         <h2>Config Options</h2>
  42         <table cellspacing="0" class="member-table">
  43             <tr>
  44                 <th class="sig-header" colspan="2">Config Options</th>
  45                 <th class="msource-header">Defined By</th>
  46             </tr>
  47                 <tr class="config-row">\r
  48         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  49         <td class="sig">\r
  50         <a id="Ext.data.ArrayReader-id"></a>\r
  51             <b>id</b> : String            <div class="mdesc">\r
  52                             (optional) The subscript within row Array that provides an ID for the Record                        </div>\r
  53         </td>\r
  54         <td class="msource">ArrayReader</td>\r
  55     </tr>\r
  56         <tr class="config-row inherited alt">\r
  57         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  58         <td class="sig">\r
  59         <a id="Ext.data.ArrayReader-root"></a>\r
  60             <b>root</b> : String            <div class="mdesc">\r
  61                             name of the property which contains the Array of row objects.                        </div>\r
  62         </td>\r
  63         <td class="msource"><a ext:cls="Ext.data.JsonReader" ext:member="#root" href="output/Ext.data.JsonReader.html#root">JsonReader</a></td>\r
  64     </tr>\r
  65         <tr class="config-row inherited">\r
  66         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  67         <td class="sig">\r
  68         <a id="Ext.data.ArrayReader-successProperty"></a>\r
  69             <b>successProperty</b> : String            <div class="mdesc">\r
  70                             Name of the property from which to retrieve the success attribute used by forms.                        </div>\r
  71         </td>\r
  72         <td class="msource"><a ext:cls="Ext.data.JsonReader" ext:member="#successProperty" href="output/Ext.data.JsonReader.html#successProperty">JsonReader</a></td>\r
  73     </tr>\r
  74         <tr class="config-row inherited alt expandable">\r
  75         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  76         <td class="sig">\r
  77         <a id="Ext.data.ArrayReader-totalProperty"></a>\r
  78             <b>totalProperty</b> : String            <div class="mdesc">\r
  79                         <div class="short">Name of the property from which to retrieve the total number of records in the dataset. This is only needed if the wh...</div>\r
  80             <div class="long">\r
  81                 Name of the property from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server.            </div>\r
  82                         </div>\r
  83         </td>\r
  84         <td class="msource"><a ext:cls="Ext.data.JsonReader" ext:member="#totalProperty" href="output/Ext.data.JsonReader.html#totalProperty">JsonReader</a></td>\r
  85     </tr>\r
  86             </table>
  87                 <a id="Ext.data.ArrayReader-props"></a>
  88         <h2>Public Properties</h2>
  89                 <table cellspacing="0" class="member-table">
  90             <tr>
  91                 <th class="sig-header" colspan="2">Property</th>
  92                 <th class="msource-header">Defined By</th>
  93             </tr>
  94                 <tr class="property-row inherited expandable">\r
  95         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  96         <td class="sig">\r
  97         <a id="Ext.data.ArrayReader-jsonData"></a>\r
  98             <b>jsonData</b> : Object            <div class="mdesc">\r
  99                         <div class="short">After any data loads, the raw JSON data is available for further custom processing.  If no data is
 100 loaded or there is...</div>\r
 101             <div class="long">\r
 102                 After any data loads, the raw JSON data is available for further custom processing.  If no data is
 103 loaded or there is a load exception this property will be undefined.            </div>\r
 104                         </div>\r
 105         </td>\r
 106         <td class="msource"><a ext:cls="Ext.data.JsonReader" ext:member="#jsonData" href="output/Ext.data.JsonReader.html#jsonData">JsonReader</a></td>\r
 107     </tr>\r
 108         <tr class="property-row inherited alt">\r
 109         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 110         <td class="sig">\r
 111         <a id="Ext.data.ArrayReader-meta"></a>\r
 112             <b>meta</b> : Mixed            <div class="mdesc">\r
 113                             This DataReader's configured metadata as passed to the constructor.                        </div>\r
 114         </td>\r
 115         <td class="msource"><a ext:cls="Ext.data.DataReader" ext:member="#meta" href="output/Ext.data.DataReader.html#meta">DataReader</a></td>\r
 116     </tr>\r
 117             </table>
 118                 <a id="Ext.data.ArrayReader-methods"></a>
 119         <h2>Public Methods</h2>
 120                 <table cellspacing="0" class="member-table">
 121             <tr>
 122                 <th class="sig-header" colspan="2">Method</th>
 123                 <th class="msource-header">Defined By</th>
 124             </tr>
 125                 <tr class="method-row expandable">\r
 126         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 127         <td class="sig">\r
 128         <a id="Ext.data.ArrayReader-ArrayReader"></a>\r
 129             <b>ArrayReader</b>(&nbsp;<code>Object meta</code>, <code>Object recordType</code>&nbsp;)            <div class="mdesc">\r
 130                         <div class="short">Create a new ArrayReader</div>\r
 131             <div class="long">\r
 132                 Create a new ArrayReader    <div class="mdetail-params">\r
 133         <strong>Parameters:</strong>\r
 134         <ul><li><code>meta</code> : Object<div class="sub-desc">Metadata configuration options.</div></li><li><code>recordType</code> : Object<div class="sub-desc">Either an Array of field definition objects
 135 as specified to <a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">Ext.data.Record.create</a>,
 136 or a <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Record</a> constructor
 137 created using <a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">Ext.data.Record.create</a>.</div></li>        </ul>\r
 138         <strong>Returns:</strong>\r
 139         <ul>\r
 140             <li><code></code></li>\r
 141         </ul>\r
 142     </div>\r
 143                 </div>\r
 144                         </div>\r
 145         </td>\r
 146         <td class="msource">ArrayReader</td>\r
 147     </tr>\r
 148         <tr class="method-row inherited alt expandable">\r
 149         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 150         <td class="sig">\r
 151         <a id="Ext.data.ArrayReader-read"></a>\r
 152             <b>read</b>(&nbsp;<code>Object response</code>&nbsp;) : Object            <div class="mdesc">\r
 153                         <div class="short">
 154 This method is only used by a DataProxy which has retrieved data from a remote server.</div>\r
 155             <div class="long">\r
 156
 157 This method is only used by a DataProxy which has retrieved data from a remote server.    <div class="mdetail-params">\r
 158         <strong>Parameters:</strong>\r
 159         <ul><li><code>response</code> : Object<div class="sub-desc">The XHR object which contains the JSON data in its responseText.</div></li>        </ul>\r
 160         <strong>Returns:</strong>\r
 161         <ul>\r
 162             <li><code>Object</code><div class="sub-desc">data A data block which is used by an Ext.data.Store object as a cache of Ext.data.Records.</div></li>\r
 163         </ul>\r
 164     </div>\r
 165                 </div>\r
 166                         </div>\r
 167         </td>\r
 168         <td class="msource"><a ext:cls="Ext.data.JsonReader" ext:member="#read" href="output/Ext.data.JsonReader.html#read">JsonReader</a></td>\r
 169     </tr>\r
 170         <tr class="method-row expandable">\r
 171         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 172         <td class="sig">\r
 173         <a id="Ext.data.ArrayReader-readRecords"></a>\r
 174             <b>readRecords</b>(&nbsp;<code>Object o</code>&nbsp;) : Object            <div class="mdesc">\r
 175                         <div class="short">Create a data block containing Ext.data.Records from an Array.</div>\r
 176             <div class="long">\r
 177                 Create a data block containing Ext.data.Records from an Array.    <div class="mdetail-params">\r
 178         <strong>Parameters:</strong>\r
 179         <ul><li><code>o</code> : Object<div class="sub-desc">An Array of row objects which represents the dataset.</div></li>        </ul>\r
 180         <strong>Returns:</strong>\r
 181         <ul>\r
 182             <li><code>Object</code><div class="sub-desc">data A data block which is used by an Ext.data.Store object as a cache of Ext.data.Records.</div></li>\r
 183         </ul>\r
 184     </div>\r
 185                 </div>\r
 186                         </div>\r
 187         </td>\r
 188         <td class="msource">ArrayReader</td>\r
 189     </tr>\r
 190             </table>
 191                 <a id="Ext.data.ArrayReader-events"></a>
 192         <h2>Public Events</h2>
 193         <div class="no-members">This class has no public events.</div>
 194         </div>