docs/api/Ext.data.reader.Xml.html

   1 <!DOCTYPE html><html><head><title>Ext.data.reader.Xml | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.data.reader.Xml',
  13         docClass: 'Ext.data.reader.Xml',
  14         docReq: 'Ext.data.reader.Xml',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'Xml.html#Ext-data.reader.Xml';
  33     clsInfo = {"methods":["Xml","getData","getResponseData","read","readRecords"],"cfgs":["idProperty","implicitIncludes","messageProperty","record","root","successProperty","totalProperty"],"properties":["rawData","xmlData"],"events":[],"subclasses":[]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Xml.html#Ext-data.reader.Xml" target="_blank">Ext.data.reader.Xml</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.data.reader.Reader.html" rel="Ext.data.reader.Reader" class="cls docClass">Ext.data.reader.Reader</a><div class="subclass"><strong>Ext.data.reader.Xml</strong></div></div></pre><p>The XML Reader is used by a Proxy to read a server response that is sent back in XML format. This usually
  38 happens as a result of loading a Store - for example we might create something like this:</p>
  39
  40
  41
  42
  43 <pre class="prettyprint"><code>Ext.define('User', {
  44     extend: 'Ext.data.Model',
  45     fields: ['id', 'name', 'email']
  46 });
  47
  48 var store = new Ext.data.Store({
  49     model: 'User',
  50     proxy: {
  51         type: 'ajax',
  52         url : 'users.xml',
  53         reader: {
  54             type: 'xml',
  55             record: 'user'
  56         }
  57     }
  58 });
  59 </code></pre>
  60
  61
  62
  63
  64 <p>The example above creates a 'User' model. Models are explained in the <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a> docs if you're
  65 not already familiar with them.</p>
  66
  67
  68
  69
  70 <p>We created the simplest type of XML Reader possible by simply telling our <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Store</a>'s
  71 <a href="Ext.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="docClass">Proxy</a> that we want a XML Reader. The Store automatically passes the configured model to the
  72 Store, so it is as if we passed this instead:
  73
  74 <pre class="prettyprint"><code>reader: {
  75     type : 'xml',
  76     model: 'User',
  77     record: 'user'
  78 }
  79 </code></pre>
  80
  81 <p>The reader we set up is ready to read data from our server - at the moment it will accept a response like this:</p>
  82
  83 <pre class="prettyprint"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
  84 &lt;user&gt;
  85     &lt;id&gt;1&lt;/id&gt;
  86     &lt;name&gt;Ed Spencer&lt;/name&gt;
  87     &lt;email&gt;ed@sencha.com&lt;/email&gt;
  88 &lt;/user&gt;
  89 &lt;user&gt;
  90     &lt;id&gt;2&lt;/id&gt;
  91     &lt;name&gt;Abe Elias&lt;/name&gt;
  92     &lt;email&gt;abe@sencha.com&lt;/email&gt;
  93 &lt;/user&gt;
  94 </code></pre>
  95
  96 <p>The XML Reader uses the configured <a href="Ext.data.reader.Xml.html#record" rel="Ext.data.reader.Xml#record" class="docClass">record</a> option to pull out the data for each record - in this case we
  97 set record to 'user', so each &lt;user&gt; above will be converted into a User model.</p>
  98
  99 <p><u>Reading other XML formats</u></p>
 100
 101 <p>If you already have your XML format defined and it doesn't look quite like what we have above, you can usually
 102 pass XmlReader a couple of configuration options to make it parse your format. For example, we can use the
 103 <a href="Ext.data.reader.Xml.html#root" rel="Ext.data.reader.Xml#root" class="docClass">root</a> configuration to parse data that comes back like this:</p>
 104
 105 <pre class="prettyprint"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
 106 &lt;users&gt;
 107     &lt;user&gt;
 108         &lt;id&gt;1&lt;/id&gt;
 109         &lt;name&gt;Ed Spencer&lt;/name&gt;
 110         &lt;email&gt;ed@sencha.com&lt;/email&gt;
 111     &lt;/user&gt;
 112     &lt;user&gt;
 113         &lt;id&gt;2&lt;/id&gt;
 114         &lt;name&gt;Abe Elias&lt;/name&gt;
 115         &lt;email&gt;abe@sencha.com&lt;/email&gt;
 116     &lt;/user&gt;
 117 &lt;/users&gt;
 118 </code></pre>
 119
 120 <p>To parse this we just pass in a <a href="Ext.data.reader.Xml.html#root" rel="Ext.data.reader.Xml#root" class="docClass">root</a> configuration that matches the 'users' above:</p>
 121
 122 <pre class="prettyprint"><code>reader: {
 123     type  : 'xml',
 124     root  : 'users',
 125     record: 'user'
 126 }
 127 </code></pre>
 128
 129 <p>Note that XmlReader doesn't care whether your <a href="Ext.data.reader.Xml.html#root" rel="Ext.data.reader.Xml#root" class="docClass">root</a> and <a href="Ext.data.reader.Xml.html#record" rel="Ext.data.reader.Xml#record" class="docClass">record</a> elements are nested deep inside
 130 a larger structure, so a response like this will still work:
 131
 132 <pre class="prettyprint"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
 133 &lt;deeply&gt;
 134     &lt;nested&gt;
 135         &lt;xml&gt;
 136             &lt;users&gt;
 137                 &lt;user&gt;
 138                     &lt;id&gt;1&lt;/id&gt;
 139                     &lt;name&gt;Ed Spencer&lt;/name&gt;
 140                     &lt;email&gt;ed@sencha.com&lt;/email&gt;
 141                 &lt;/user&gt;
 142                 &lt;user&gt;
 143                     &lt;id&gt;2&lt;/id&gt;
 144                     &lt;name&gt;Abe Elias&lt;/name&gt;
 145                     &lt;email&gt;abe@sencha.com&lt;/email&gt;
 146                 &lt;/user&gt;
 147             &lt;/users&gt;
 148         &lt;/xml&gt;
 149     &lt;/nested&gt;
 150 &lt;/deeply&gt;
 151 </code></pre>
 152
 153 <p><u>Response metadata</u></p>
 154
 155 <p>The server can return additional data in its response, such as the <a href="Ext.data.reader.Xml.html#totalProperty" rel="Ext.data.reader.Xml#totalProperty" class="docClass">total number of records</a>
 156 and the <a href="Ext.data.reader.Xml.html#successProperty" rel="Ext.data.reader.Xml#successProperty" class="docClass">success status of the response</a>. These are typically included in the XML response
 157 like this:</p>
 158
 159 <pre class="prettyprint"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
 160 &lt;total&gt;100&lt;/total&gt;
 161 &lt;success&gt;true&lt;/success&gt;
 162 &lt;users&gt;
 163     &lt;user&gt;
 164         &lt;id&gt;1&lt;/id&gt;
 165         &lt;name&gt;Ed Spencer&lt;/name&gt;
 166         &lt;email&gt;ed@sencha.com&lt;/email&gt;
 167     &lt;/user&gt;
 168     &lt;user&gt;
 169         &lt;id&gt;2&lt;/id&gt;
 170         &lt;name&gt;Abe Elias&lt;/name&gt;
 171         &lt;email&gt;abe@sencha.com&lt;/email&gt;
 172     &lt;/user&gt;
 173 &lt;/users&gt;
 174 </code></pre>
 175
 176 <p>If these properties are present in the XML response they can be parsed out by the XmlReader and used by the
 177 Store that loaded it. We can set up the names of these properties by specifying a final pair of configuration
 178 options:</p>
 179
 180 <pre class="prettyprint"><code>reader: {
 181     type: 'xml',
 182     root: 'users',
 183     totalProperty  : 'total',
 184     successProperty: 'success'
 185 }
 186 </code></pre>
 187
 188 <p>These final options are not necessary to make the Reader work, but can be useful when the server needs to report
 189 an error or if it needs to indicate that there is a lot of data available of which only a subset is currently being
 190 returned.</p>
 191
 192 <p><u>Response format</u></p>
 193
 194 <p><b>Note:</b> in order for the browser to parse a returned XML document, the Content-Type header in the HTTP
 195 response must be set to "text/xml" or "application/xml". This is very important - the XmlReader will not
 196 work correctly otherwise.</p>
 197
 198 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-idProperty" class="member f inherited"><a href="Ext.data.reader.Xml.html#config-idProperty" rel="config-idProperty" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Reader.html" class="definedIn docClass">Ext.data.reader.Reader</a><br/><a href="../source/Reader.html#Ext-data.reader.Reader-cfg-idProperty" class="viewSource">view source</a></div><a name="idProperty"></a><a name="config-idProperty"></a><a href="Ext.data.reader.Xml.html#" rel="config-idProperty" class="cls expand">idProperty</a><span> : String</span></div><div class="description"><div class="short">Name of the property within a row object
 199 that contains a record identifier value.  Defaults to The id of the model.
 200 I...</div><div class="long"><p>Name of the property within a row object
 201 that contains a record identifier value.  Defaults to <tt>The id of the model</tt>.
 202 If an idProperty is explicitly specified it will override that of the one specified
 203 on the model</p>
 204 </div></div></div><div id="config-implicitIncludes" class="member inherited"><a href="Ext.data.reader.Xml.html#config-implicitIncludes" rel="config-implicitIncludes" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Reader.html" class="definedIn docClass">Ext.data.reader.Reader</a><br/><a href="../source/Reader.html#Ext-data.reader.Reader-cfg-implicitIncludes" class="viewSource">view source</a></div><a name="implicitIncludes"></a><a name="config-implicitIncludes"></a><a href="Ext.data.reader.Xml.html#" rel="config-implicitIncludes" class="cls expand">implicitIncludes</a><span> : Boolean</span></div><div class="description"><div class="short">True to automatically parse models nested within other models in a response
 205 object. See the Ext.data.reader.Reader in...</div><div class="long"><p>True to automatically parse models nested within other models in a response
 206 object. See the <a href="Ext.data.reader.Reader.html" rel="Ext.data.reader.Reader" class="docClass">Ext.data.reader.Reader</a> intro docs for full explanation. Defaults to true.</p>
 207 </div></div></div><div id="config-messageProperty" class="member inherited"><a href="Ext.data.reader.Xml.html#config-messageProperty" rel="config-messageProperty" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Reader.html" class="definedIn docClass">Ext.data.reader.Reader</a><br/><a href="../source/Reader.html#Ext-data.reader.Reader-cfg-messageProperty" class="viewSource">view source</a></div><a name="messageProperty"></a><a name="config-messageProperty"></a><a href="Ext.data.reader.Xml.html#" rel="config-messageProperty" class="cls expand">messageProperty</a><span> : String</span></div><div class="description"><div class="short"><p>The name of the property which contains a response message.
 208 This property is optional.</p>
 209 </div><div class="long"><p>The name of the property which contains a response message.
 210 This property is optional.</p>
 211 </div></div></div><div id="config-record" class="member ni"><a href="Ext.data.reader.Xml.html#config-record" rel="config-record" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Xml.html" class="definedIn docClass">Ext.data.reader.Xml</a><br/><a href="../source/Xml.html#Ext-data.reader.Xml-cfg-record" class="viewSource">view source</a></div><a name="record"></a><a name="config-record"></a><a href="Ext.data.reader.Xml.html#" rel="config-record" class="cls expand">record</a><span> : String</span></div><div class="description"><div class="short"><p>The DomQuery path to the repeated element which contains record information.</p>
 212 </div><div class="long"><p>The DomQuery path to the repeated element which contains record information.</p>
 213 </div></div></div><div id="config-root" class="member inherited"><a href="Ext.data.reader.Xml.html#config-root" rel="config-root" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Reader.html" class="definedIn docClass">Ext.data.reader.Reader</a><br/><a href="../source/Reader.html#Ext-data.reader.Reader-cfg-root" class="viewSource">view source</a></div><a name="root"></a><a name="config-root"></a><a href="Ext.data.reader.Xml.html#" rel="config-root" class="cls expand">root</a><span> : String</span></div><div class="description"><div class="short">Required.  The name of the property
 214 which contains the Array of row objects.  Defaults to undefined.
 215 An exception wil...</div><div class="long"><p><b>Required</b>.  The name of the property
 216 which contains the Array of row objects.  Defaults to <tt>undefined</tt>.
 217 An exception will be thrown if the root property is undefined. The data
 218 packet value for this property should be an empty array to clear the data
 219 or show no data.</p>
 220 </div></div></div><div id="config-successProperty" class="member inherited"><a href="Ext.data.reader.Xml.html#config-successProperty" rel="config-successProperty" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Reader.html" class="definedIn docClass">Ext.data.reader.Reader</a><br/><a href="../source/Reader.html#Ext-data.reader.Reader-cfg-successProperty" class="viewSource">view source</a></div><a name="successProperty"></a><a name="config-successProperty"></a><a href="Ext.data.reader.Xml.html#" rel="config-successProperty" class="cls expand">successProperty</a><span> : String</span></div><div class="description"><div class="short">Name of the property from which to
 221 retrieve the success attribute. Defaults to success.  See
 222 Ext.data.proxy.Proxy.exc...</div><div class="long"><p>Name of the property from which to
 223 retrieve the success attribute. Defaults to <tt>success</tt>.  See
 224 <a href="Ext.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="docClass">Ext.data.proxy.Proxy</a>.<a href="Ext.data.proxy.Proxy.html#exception" rel="Ext.data.proxy.Proxy#exception" class="docClass">exception</a>
 225 for additional information.</p>
 226 </div></div></div><div id="config-totalProperty" class="member inherited"><a href="Ext.data.reader.Xml.html#config-totalProperty" rel="config-totalProperty" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Reader.html" class="definedIn docClass">Ext.data.reader.Reader</a><br/><a href="../source/Reader.html#Ext-data.reader.Reader-cfg-totalProperty" class="viewSource">view source</a></div><a name="totalProperty"></a><a name="config-totalProperty"></a><a href="Ext.data.reader.Xml.html#" rel="config-totalProperty" class="cls expand">totalProperty</a><span> : String</span></div><div class="description"><div class="short">Name of the property from which to
 227 retrieve the total number of records in the dataset. This is only needed
 228 if the wh...</div><div class="long"><p>Name of the property from which to
 229 retrieve the total number of records in the dataset. This is only needed
 230 if the whole dataset is not passed in one go, but is being paged from
 231 the remote server.  Defaults to <tt>total</tt>.</p>
 232 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-rawData" class="member f inherited"><a href="Ext.data.reader.Xml.html#property-rawData" rel="property-rawData" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Reader.html" class="definedIn docClass">Ext.data.reader.Reader</a><br/><a href="../source/Reader.html#Ext-data.reader.Reader-property-rawData" class="viewSource">view source</a></div><a name="rawData"></a><a name="property-rawData"></a><a href="Ext.data.reader.Xml.html#" rel="property-rawData" class="cls expand">rawData</a><span> : Mixed</span></div><div class="description"><div class="short"><p>The raw data object that was last passed to readRecords. Stored for further processing if needed</p>
 233 </div><div class="long"><p>The raw data object that was last passed to readRecords. Stored for further processing if needed</p>
 234 </div></div></div><div id="property-xmlData" class="member ni"><a href="Ext.data.reader.Xml.html#property-xmlData" rel="property-xmlData" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Xml.html" class="definedIn docClass">Ext.data.reader.Xml</a><br/><a href="../source/Xml.html#Ext-data.reader.Xml-property-xmlData" class="viewSource">view source</a></div><a name="xmlData"></a><a name="property-xmlData"></a><a href="Ext.data.reader.Xml.html#" rel="property-xmlData" class="cls expand">xmlData</a><span> : Object</span></div><div class="description"><div class="short"><p>DEPRECATED - will be removed in <a href="Ext.html" rel="Ext" class="docClass">Ext</a> JS 5.0. This is just a copy of this.rawData - use that instead</p>
 235 </div><div class="long"><p>DEPRECATED - will be removed in <a href="Ext.html" rel="Ext" class="docClass">Ext</a> JS 5.0. This is just a copy of this.rawData - use that instead</p>
 236 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Xml" class="member f inherited"><a href="Ext.data.reader.Xml.html#method-Xml" rel="method-Xml" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Reader.html" class="definedIn docClass">Ext.data.reader.Reader</a><br/><a href="../source/Reader.html#Ext-data.reader.Reader-method-constructor" class="viewSource">view source</a></div><a name="Xml"></a><a name="method-Xml"></a><a href="Ext.data.reader.Xml.html#" rel="method-Xml" class="cls expand">Xml</a>(
 237 <span class="pre">Object config</span>)
 238  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
 239 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>Optional config object</p>
 240 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 241 </li></ul></div></div></div><div id="method-getData" class="member ni"><a href="Ext.data.reader.Xml.html#method-getData" rel="method-getData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Xml.html" class="definedIn docClass">Ext.data.reader.Xml</a><br/><a href="../source/Xml.html#Ext-data.reader.Xml-method-getData" class="viewSource">view source</a></div><a name="getData"></a><a name="method-getData"></a><a href="Ext.data.reader.Xml.html#" rel="method-getData" class="cls expand">getData</a>(
 242 <span class="pre">Object data</span>)
 243  : Object</div><div class="description"><div class="short"><p>Normalizes the data object</p>
 244 </div><div class="long"><p>Normalizes the data object</p>
 245 <h3 class="pa">Parameters</h3><ul><li><span class="pre">data</span> : Object<div class="sub-desc"><p>The raw data object</p>
 246 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>Returns the documentElement property of the data object if present, or the same object if not</p>
 247 </li></ul></div></div></div><div id="method-getResponseData" class="member inherited"><a href="Ext.data.reader.Xml.html#method-getResponseData" rel="method-getResponseData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Reader.html" class="definedIn docClass">Ext.data.reader.Reader</a><br/><a href="../source/Reader.html#Ext-data.reader.Reader-method-getResponseData" class="viewSource">view source</a></div><a name="getResponseData"></a><a name="method-getResponseData"></a><a href="Ext.data.reader.Xml.html#" rel="method-getResponseData" class="cls expand">getResponseData</a>(
 248 <span class="pre">Object response</span>)
 249  : Object</div><div class="description"><div class="short">Takes a raw response object (as passed to this.read) and returns the useful data segment of it. This must be implemen...</div><div class="long"><p>Takes a raw response object (as passed to this.read) and returns the useful data segment of it. This must be implemented by each subclass</p>
 250 <h3 class="pa">Parameters</h3><ul><li><span class="pre">response</span> : Object<div class="sub-desc"><p>The responce object</p>
 251 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The useful data from the response</p>
 252 </li></ul></div></div></div><div id="method-read" class="member inherited"><a href="Ext.data.reader.Xml.html#method-read" rel="method-read" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Reader.html" class="definedIn docClass">Ext.data.reader.Reader</a><br/><a href="../source/Reader.html#Ext-data.reader.Reader-method-read" class="viewSource">view source</a></div><a name="read"></a><a name="method-read"></a><a href="Ext.data.reader.Xml.html#" rel="method-read" class="cls expand">read</a>(
 253 <span class="pre">Object response</span>)
 254  : Ext.data.ResultSet</div><div class="description"><div class="short">Reads the given response object. This method normalizes the different types of response object that may be passed
 255 to ...</div><div class="long"><p>Reads the given response object. This method normalizes the different types of response object that may be passed
 256 to it, before handing off the reading of records to the <a href="Ext.data.reader.Xml.html#readRecords" rel="Ext.data.reader.Xml#readRecords" class="docClass">readRecords</a> function.</p>
 257 <h3 class="pa">Parameters</h3><ul><li><span class="pre">response</span> : Object<div class="sub-desc"><p>The response object. This may be either an XMLHttpRequest object or a plain JS object</p>
 258 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.ResultSet</span>&nbsp; &nbsp;<p>The parsed ResultSet object</p>
 259 </li></ul></div></div></div><div id="method-readRecords" class="member ni"><a href="Ext.data.reader.Xml.html#method-readRecords" rel="method-readRecords" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.reader.Xml.html" class="definedIn docClass">Ext.data.reader.Xml</a><br/><a href="../source/Xml.html#Ext-data.reader.Xml-method-readRecords" class="viewSource">view source</a></div><a name="readRecords"></a><a name="method-readRecords"></a><a href="Ext.data.reader.Xml.html#" rel="method-readRecords" class="cls expand">readRecords</a>(
 260 <span class="pre">Object doc</span>)
 261  : Ext.data.ResultSet</div><div class="description"><div class="short"><p>Parses an XML document and returns a ResultSet containing the model instances</p>
 262 </div><div class="long"><p>Parses an XML document and returns a ResultSet containing the model instances</p>
 263 <h3 class="pa">Parameters</h3><ul><li><span class="pre">doc</span> : Object<div class="sub-desc"><p>Parsed XML document</p>
 264 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.ResultSet</span>&nbsp; &nbsp;<p>The parsed result set</p>
 265 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>