Class type Ext_data_reader_Reader.configs


class type configs = object .. end
Inherits
method idProperty : Js.js_string Js.t Js.prop

Name of the property within a row object that contains a record identifier value. Defaults to the id of the model. If an idProperty is explicitly specified it will take precedence over idProperty defined on the model.


method implicitIncludes : bool Js.t Js.prop

True to automatically parse models nested within other models in a response object. See the Ext.data.reader.Reader intro docs for full explanation.

Defaults to: true

method messageProperty : Js.js_string Js.t Js.prop

The name of the property which contains a response message. This property is optional.


method readRecordsOnFailure : bool Js.t Js.prop

True to extract the records from a data packet even if the successProperty returns false.

Defaults to: true

method root : Js.js_string Js.t Js.prop

The name of the property which contains the data items corresponding to the Model(s) for which this Reader is configured. For JSON reader it's a property name (or a dot-separated list of property names if the root is nested). For XML reader it's a CSS selector. For Array reader the root is not applicable since the data is assumed to be a single-level array of arrays.

By default the natural root of the data will be used: the root JSON array, the root XML element, or the array.

The data packet value for this property should be an empty array to clear the data or show no data.

Defaults to: ''

method successProperty : Js.js_string Js.t Js.prop

Name of the property from which to retrieve the success attribute, the value of which indicates whether a given request succeeded or failed (typically a boolean or 'true'|'false'). See Ext.data.proxy.Server.exception for additional information.

Defaults to: "success"

method totalProperty : Js.js_string Js.t Js.prop

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"