Up  Next

Class type Ext_data_reader_Reader.t


class type t = object .. end
Inherits 
method metaData : 'a. 'a Js.t Js.readonly_prop

The raw meta data that was most recently read, if any. Meta data can include existing Reader config options like idProperty, totalProperty, etc. that get automatically applied to the Reader, and those can still be accessed directly from the Reader if needed. However, meta data is also often used to pass other custom data to be processed by application code. For example, it is common when reconfiguring the data model of a grid to also pass a corresponding column model config to be applied to the grid. Any such data will not get applied to the Reader directly (it just gets passed through and is ignored by Ext). This metaData property gives you access to all meta data that was passed, including any such custom data ignored by the reader.

This is a read-only property, and it will get replaced each time a new meta data object is passed to the reader. Note that typically you would handle proxy's metachange event which passes this exact same meta object to listeners. However this property is available if it's more convenient to access it via the reader directly in certain cases.


method rawData : 'b. 'b Js.t Js.prop

The raw data object that was last passed to readRecords. Stored for further processing if needed.


method getResponseData : 'c. 'c Js.t -> Ext_data_ResultSet.t Js.t Js.meth

Takes a raw response object (as passed to the read method) and returns the useful data segment from it. This must be implemented by each subclass.

Parameters:

Returns: 


method read : 'd. 'd Js.t -> Ext_data_ResultSet.t Js.t Js.meth

Reads the given response object. This method normalizes the different types of response object that may be passed to it. If it's an XMLHttpRequest object, hand off to the subclass' getResponseData method. Else, hand off the reading of records to the readRecords method.

Parameters:

Returns: 


method readRecords : 'e. 'e Js.t -> Ext_data_ResultSet.t Js.t Js.meth

Abstracts common functionality used by all Reader subclasses. Each subclass is expected to call this function before running its own logic and returning the Ext.data.ResultSet instance. For most Readers additional processing should not be needed.

Parameters:

Returns: