Package: | Ext.data |
Defined In: | DataField.js |
Class: | Field |
Extends: | Object |
This class encapsulates the field definition information specified in the field definition objects passed to Ext.data.Record.create.
Developers do not need to instantiate this class. Instances are created by Ext.data.Record.create and cached in the fields property of the created Record constructor's prototype.
Config Options | Defined By | |
---|---|---|
allowBlank : Boolean Used for validating a record, defaults to true.
An empty value here will cause Ext.data.Record.isValid
to evaluate to... Used for validating a record, defaults to true.
An empty value here will cause Ext.data.Record.isValid
to evaluate to false. | Field | |
convert : Function A function which converts the value provided by the Reader into an object that will be stored
in the Record. It is pa... A function which converts the value provided by the Reader into an object that will be stored
in the Record. It is passed the following parameters:
| Field | |
dateFormat : String A format string for the Date.parseDate function, or "timestamp" if the
value provided by the Reader is a UNIX timesta... A format string for the Date.parseDate function, or "timestamp" if the
value provided by the Reader is a UNIX timestamp, or "time" if the value provided by the Reader is a
javascript millisecond timestamp. | Field | |
defaultValue : Mixed | Field | |
mapping : String/Number (Optional) A path expression for use by the Ext.data.DataReader implementation
that is creating the Record to extract... (Optional) A path expression for use by the Ext.data.DataReader implementation that is creating the Record to extract the Field value from the data object. If the path expression is the same as the field name, the mapping may be omitted. The form of the mapping expression depends on the Reader being used.
If a more complex value extraction strategy is required, then configure the Field with a convert function. This is passed the whole row object, and may interrogate it in whatever way is necessary in order to return the desired data. | Field | |
name : String The name by which the field is referenced within the Record. This is referenced by, for example,
the dataIndex proper... The name by which the field is referenced within the Record. This is referenced by, for example,
the dataIndex property in column definition objects passed to Ext.grid.ColumnModel.
Note: In the simplest case, if no properties other than name are required, a field definition may consist of just a String for the field name. | Field | |
sortDir : String Initial direction to sort ("ASC" or "DESC"). Defaults to
"ASC". | Field | |
sortType : Function A function which converts a Field's value to a comparable value in order to ensure
correct sort ordering. Predefined ... A function which converts a Field's value to a comparable value in order to ensure
correct sort ordering. Predefined functions are provided in Ext.data.SortTypes. A custom
sort example:
| Field | |
type : String The data type for conversion to displayable value if convert
has not been specified. Possible values are
<div class="... The data type for conversion to displayable value if convert
has not been specified. Possible values are
| Field |