X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/0494b8d9b9bb03ab6c22b34dae81261e3cd7e3e6..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Ext.data.ArrayReader.html diff --git a/docs/output/Ext.data.ArrayReader.html b/docs/output/Ext.data.ArrayReader.html deleted file mode 100644 index b90e681b..00000000 --- a/docs/output/Ext.data.ArrayReader.html +++ /dev/null @@ -1,63 +0,0 @@ -
DataReader - JsonReader - 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 | Defined By | |
---|---|---|
fields : Array/Object Either an Array of Field definition objects (which
-will be passed to Ext.data.Record.create, or a Record
-constructor ... Either an Array of Field definition objects (which -will be passed to Ext.data.Record.create, or a Record -constructor created from Ext.data.Record.create. | DataReader | |
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 | |
root : String [undefined] Required. The name of the property
-which contains the Array of row objects. Defaults to undefined.
-An e... [undefined] 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. | JsonReader | |
totalProperty : String [total] Name of the property from which to
-retrieve the total number of records in the dataset. This is only needed
-i... [total] 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. | JsonReader |
Property | Defined 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 | |
jsonData : Object After any data loads, the raw JSON data is available for further custom processing. If no data is
-loaded or there is... After any data loads, the raw JSON data is available for further custom processing. If no data is
-loaded or there is a load exception this property will be undefined. | JsonReader | |
meta : Mixed This JsonReader's metadata as passed to the constructor, or as passed in
-the last data packet's metaData property. | JsonReader |
Method | Defined By | |
---|---|---|
ArrayReader( Object meta , Array/Object recordType )
- Create a new ArrayReader Create a new ArrayReader Parameters:
| ArrayReader | |
isData( Object data )
- :
- BooleanReturns true if the supplied data-hash looks and quacks like data. Checks to see if it has a key
-corresponding to id... Returns true if the supplied data-hash looks and quacks like data. Checks to see if it has a key
-corresponding to idProperty defined in your DataReader config containing non-empty pk. Parameters:
| DataReader | |
read( Object response )
- :
- ObjectThis method is only used by a DataProxy which has retrieved data from a remote server. This method is only used by a DataProxy which has retrieved data from a remote server. Parameters:
| JsonReader | |
readRecords( Object o )
- :
- ObjectCreate a data block containing Ext.data.Records from an Array. Create a data block containing Ext.data.Records from an Array. Parameters:
| ArrayReader | |
readResponse( String action , Object response )
- :
- ResponseDecode a JSON response from server. Decode a JSON response from server. Parameters:
| JsonReader | |
realize( Record/Record[] record , Object/Object[] data )
- :
- voidUsed for un-phantoming a record after a successful database insert. Sets the records pk along with new data from ser... Used for un-phantoming a record after a successful database insert. Sets the records pk along with new data from server.
-You must return at least the database pk using the idProperty defined in your DataReader configuration. The incoming
-data from server will be merged with the data in the local record.
-In addition, you must return record-data from the server in the same order received.
-Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be suppressed. Parameters:
| DataReader | |
update( Record/Record[] rs , Object/Object[] data )
- :
- voidUsed for updating a non-phantom or "real" record's data with fresh data from server after remote-save.
-If returning d... Used for updating a non-phantom or "real" record's data with fresh data from server after remote-save.
-If returning data from multiple-records after a batch-update, you must return record-data from the server in
-the same order received. Will perform a commit as well, un-marking dirty-fields. Store's "update" event will be
-suppressed as the record receives fresh new data-hash Parameters:
| DataReader |