Properties
Methods
Events
Config Options
Direct Link
ReaderJsonReader
| Package: | Ext.data |
| Defined In: | ArrayReader.js |
| Class: | ArrayReader |
| Extends: | JsonReader |
Data reader class to create an Array of Ext.data.Record objects from an Array.
Each element of that Array represents a row of data fields. The
fields are pulled into a Record object using as a subscript, the mapping property
of the field definition if it exists, or the field's ordinal position in the definition.
Example code:
var Employee = Ext.data.Record.create([
{name: 'name', mapping: 1}, // "mapping" only needed if an "id" field is present which
{name: 'occupation', mapping: 2} // precludes using the ordinal position as the index.
]);
var myReader = new Ext.data.ArrayReader({
idIndex: 0
}, Employee);This would consume an Array like this:
[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ]| Config Options | Defined By | |
|---|---|---|
| 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 | |
| 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 | |
| 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 | |
|---|---|---|
| jsonData : Mixed DEPRECATED - will be removed in Ext JS 5.0. This is just a copy of this.rawData - use that instead | JsonReader | |
| rawData : Mixed The raw data object that was last passed to readRecords. Stored for further processing if needed | Reader | |
| Method | Defined By | |
|---|---|---|
ArrayReader( Object meta, Array/Object recordType )
Create a new ArrayReader Create a new ArrayReader Parameters:
| ArrayReader | |
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 data )
:
Ext.data.ResultSetReads a JSON object and returns a ResultSet. Uses the internal getTotal and getSuccess extractors to
retrieve meta da... Reads a JSON object and returns a ResultSet. Uses the internal getTotal and getSuccess extractors to
retrieve meta data from the response, and extractData to turn the JSON data into model instances. Parameters:
| JsonReader | |