Properties
Methods
Events
Config Options
Direct Link
ReaderXmlReader
| Package: | Ext.data |
| Defined In: | XmlReader.js |
| Class: | XmlReader |
| Extends: | Reader |
Xml Reader
| Config Options | Defined By | |
|---|---|---|
| id : String DEPRECATED - this will be removed in Ext JS 5.0. Please use idProperty instead | XmlReader | |
| idPath : String DEPRECATED - this will be removed in Ext JS 5.0. Please use idProperty instead | XmlReader | |
| idProperty : String Name of the property within a row object
that contains a record identifier value. Defaults to id | Reader | |
| implicitIncludes : Boolean True to automatically parse models nested within other models in a JSON
object. See JsonReader intro docs for full ex... True to automatically parse models nested within other models in a JSON
object. See JsonReader intro docs for full explanation. Defaults to true. | Reader | |
| record : String The DomQuery path to the repeated element which contains record information.
This is an alias for the root config opt... The DomQuery path to the repeated element which contains record information.
This is an alias for the root config option. | XmlReader | |
| root : String Required. The name of the property
which contains the Array of row objects. Defaults to undefined.
An exception wil... Required. The name of the property
which contains the Array of row objects. Defaults to undefined.
An exception will be thrown if the root property is undefined. The data
packet value for this property should be an empty array to clear the data
or show no data. | Reader | |
| success : String DEPRECATED - this will be removed in Ext JS 5.0. Please use successProperty instead | XmlReader | |
| successProperty : String Name of the property from which to
retrieve the success attribute. Defaults to success. See
Ext.data.DataProxy.excep... Name of the property from which to
retrieve the success attribute. Defaults to success. See
Ext.data.DataProxy.exception
for additional information. | Reader | |
| totalProperty : String Name of the property from which to
retrieve the total number of records in the dataset. This is only needed
if the wh... 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. Defaults to total. | Reader | |
| Property | Defined By | |
|---|---|---|
| rawData : Mixed The raw data object that was last passed to readRecords. Stored for further processing if needed | Reader | |
| xmlData : Object DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.rawData - use that instead | XmlReader | |
| Method | Defined By | |
|---|---|---|
getData( Object data )
:
ObjectNormalizes the data object Normalizes the data object Parameters:
| XmlReader | |
getResponseData( Object response )
:
ObjectTakes a raw response object (as passed to this.read) and returns the useful data segment of it. This must be implemen... 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 Parameters:
| Reader | |
read( Object response )
:
Ext.data.ResultSetReads the given response object. This method normalizes the different types of response object that may be passed
to ... Reads the given response object. This method normalizes the different types of response object that may be passed
to it, before handing off the reading of records to the readRecords function. Parameters:
| Reader | |
readRecords( Object doc )
:
Ext.data.ResultSetParses an XML document and returns a ResultSet containing the model instances Parses an XML document and returns a ResultSet containing the model instances Parameters:
| XmlReader | |