Properties Methods Events Config Options Direct Link
DataReader
  JsonReader
    ArrayReader

Class Ext.data.ArrayReader

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

Config OptionsDefined By
 id : Number
The subscript within row Array that provides an ID for the Record. Deprecated. Use idIndex instead.
ArrayReader
 idIndex : Number
The subscript within row Array that provides an ID for the Record.
ArrayReader
 idProperty : String
[id] Name of the property within a row object that contains a record identifier value. Defaults to id
JsonReader
 messageProperty : String
[undefined] Optional name of a property within a server-response that represents a user-feedback message.
DataReader

Public Properties

PropertyDefined By
 buildExtractors : Object
Abstract method, overridden in DataReader extensions such as Ext.data.JsonReader and Ext.data.XmlReader
DataReader
 extractValues : Object
Abstract method overridden in DataReader extensions such as Ext.data.JsonReader and Ext.data.XmlReader
DataReader
 getId : Object
Abstract method created in extension's buildExtractors impl.
DataReader
 getMessage : Object
Abstract method created in extension's buildExtractors impl.
DataReader
 getRoot : Object
Abstract method created in extension's buildExtractors impl.
DataReader
 getSuccess : Object
Abstract method created in extension's buildExtractors impl.
DataReader
 getTotal : Object
Abstract method created in extension's buildExtractors impl.
DataReader
 meta : Mixed
This JsonReader's metadata as passed to the constructor, or as passed in the last data packet's metaData property.
JsonReader

Public Methods

MethodDefined By

Public Events

This class has no public events.