X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/d41dc04ad17d1d9125fb2cf72db2b4782dbe3a8c..6b044c28b5f26fb99c86c237ffad19741c0f7f3d:/docs/output/Ext.data.Field.html?ds=sidebyside diff --git a/docs/output/Ext.data.Field.html b/docs/output/Ext.data.Field.html index 2b468462..831d0cdf 100644 --- a/docs/output/Ext.data.Field.html +++ b/docs/output/Ext.data.Field.html @@ -1,132 +1,117 @@ -
Package: | Ext.data |
Defined In: | DataField.js |
Class: | Field |
Extends: | Object |
This class encpasulates 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 | -|
---|---|---|
- |
-
- convert : Function
-
- (Optional) A function which converts the value provided by the Reader into an object that will be stored in the Recor...
-
- (Optional) 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
-
- (Optional) A format string for the Date.parseDate function, or "timestamp" if the value provided by the Reader is a U...
-
- (Optional) 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
-
- (Optional) The default value used when a Record is being created by a Reader when the item referenced by the mapping ...
-
- (Optional) The default value used when a Record is being created by a Reader when the item referenced by the mapping does not exist in the data object (i.e. undefined). (defaults to "")
- |
- Field | -
- |
-
- mapping : String
-
- (Optional) A path specification for use by the Ext.data.Reader implementation that is creating the Record to access t...
-
- (Optional) A path specification for use by the Ext.data.Reader implementation that is creating the Record to access the data value from the data object. If an Ext.data.JsonReader is being used, then this is a string containing the javascript expression to reference the data relative to the Record item's root. If an Ext.data.XmlReader is being used, this is an Ext.DomQuery path to the data item relative to the Record element. If the mapping expression is the same as the field name, this may be omitted.
- |
- 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
- |
- Field | -
- |
-
- sortDir : String
- (Optional) Initial direction to sort. "ASC" or "DESC"
- |
- Field | -
- |
-
- sortType : Function
-
- (Optional) A function which converts a Field's value to a comparable value in order to ensure correct sort ordering. ...
-
- (Optional) 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
- |
- Field | -
- |
-
- type : String
-
- (Optional) The data type for conversion to displayable value. Possible values are auto (Default, implies no conversio...
-
- (Optional) The data type for conversion to displayable value. Possible values are
-
|
- Field | -
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 (Optional) Used when converting received data into a Date when the type is specified as "date".
+A format string for t... (Optional) Used when converting received data into a Date when the type is specified as 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. See Date | 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 | 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 : Mixed The data type for automatic conversion from received data to the stored value if convert
+has not been specified. This... The data type for automatic conversion from received data to the stored value if convert
+has not been specified. This may be specified as a string value. Possible values are
+
This may also be specified by referencing a member of the Ext.data.Types class. +Developers may create their own application-specific data types by defining new members of the +Ext.data.Types class. | Field | |
useNull : Boolean (Optional) Use when converting received data into a Number type (either int or float). If the value cannot be parsed,... (Optional) Use when converting received data into a Number type (either int or float). If the value cannot be parsed, +null will be used if useNull is true, otherwise the value will be 0. Defaults to false | Field |