Hierarchy
Ext.BaseExt.data.Field
Requires
Ext.data.SortTypes
Ext.data.Types
Files
Field.js

Fields are used to define what a Model is. They aren't instantiated directly - instead, when we create a class that\nextends Ext.data.Model, it will automatically create a Field instance for each field configured in a Model. For example, we might set up a model like this:

\n\n

Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: [\n        'name', 'email',\n        {name: 'age', type: 'int'},\n        {name: 'gender', type: 'string', defaultValue: 'Unknown'}\n    ]\n});\n

\n\n

Four fields will have been created for the User Model - name, email, age and gender. Note that we specified a couple\nof different formats here; if we only pass in the string name of the field (as with name and email), the field is set\nup with the 'auto' type. It's as if we'd done this instead:

\n\n

Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: [\n        {name: 'name', type: 'auto'},\n        {name: 'email', type: 'auto'},\n        {name: 'age', type: 'int'},\n        {name: 'gender', type: 'string', defaultValue: 'Unknown'}\n    ]\n});\n

\n\n

Types and conversion

\n\n

The type is important - it's used to automatically convert data passed to the field into the correct format.\nIn our example above, the name and email fields used the 'auto' type and will just accept anything that is passed\ninto them. The 'age' field had an 'int' type however, so if we passed 25.4 this would be rounded to 25.

\n\n

Sometimes a simple type isn't enough, or we want to perform some processing when we load a Field's data. We can do\nthis using a convert function. Here, we're going to create a new field based on another:

\n\n

Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: [\n        {\n            name: 'firstName',\n            convert: function(value, record) {\n                var fullName  = record.get('name'),\n                    splits    = fullName.split(\" \"),\n                    firstName = splits[0];\n\n                return firstName;\n            }\n        },\n        'name', 'email',\n        {name: 'age', type: 'int'},\n        {name: 'gender', type: 'string', defaultValue: 'Unknown'}\n    ]\n});\n

\n\n

Now when we create a new User, the firstName is populated automatically based on the name:

\n\n

var ed = Ext.create('User', {name: 'Ed Spencer'});\n\nconsole.log(ed.get('firstName')); //logs 'Ed', based on our convert function\n

\n\n

Fields which are configured with a custom convert function are read after all other fields\nwhen constructing and reading records, so that if convert functions rely on other, non-converted fields\n(as in this example), they can be sure of those fields being present.

\n\n

In fact, if we log out all of the data inside ed, we'll see this:

\n\n

console.log(ed.data);\n\n//outputs this:\n{\n    age: 0,\n    email: \"\",\n    firstName: \"Ed\",\n    gender: \"Unknown\",\n    name: \"Ed Spencer\"\n}\n

\n\n

The age field has been given a default of zero because we made it an int type. As an auto field, email has defaulted\nto an empty string. When we registered the User model we set gender's defaultValue to 'Unknown' so we see\nthat now. Let's correct that and satisfy ourselves that the types work as we expect:

\n\n

ed.set('gender', 'Male');\ned.get('gender'); //returns 'Male'\n\ned.set('age', 25.4);\ned.get('age'); //returns 25 - we wanted an int, not a float, so no decimal places allowed\n

Defined By

Config options

Ext.data.Field
view source

allowBlank : Booleanprivate

Used for validating a model. ...

Used for validating a model. Defaults to true. An empty value here will cause\nExt.data.Model.isValid to evaluate to false.

Defaults to: true

Ext.data.Field
view source

convert : Function

A function which converts the value provided by the Reader into an object that will be stored in the Model. ...

A function which converts the value provided by the Reader into an object that will be stored in the Model.

\n\n

If configured as null, then no conversion will be applied to the raw data property when this Field\nis read. This will increase performance. but you must ensure that the data is of the correct type and does\nnot need converting.

\n\n

It is passed the following parameters:

\n\n

v : Mixed
\n\n
The data value as read by the Reader, if undefined will use the configured defaultValue.
rec : Ext.data.Model
\n\n
The data object containing the Model as read so far by the Reader. Note that the Model may not be fully populated\nat this point as the fields are read in the order that they are defined in your\nfields array.

\n\n\n

Example of convert functions:

\n\n

function fullName(v, record){\n    return record.data.last + ', ' + record.data.first;\n}\n\nfunction location(v, record){\n    return !record.data.city ? '' : (record.data.city + ', ' + record.data.state);\n}\n\nExt.define('Dude', {\n    extend: 'Ext.data.Model',\n    fields: [\n        {name: 'fullname',  convert: fullName},\n        {name: 'firstname', mapping: 'name.first'},\n        {name: 'lastname',  mapping: 'name.last'},\n        {name: 'city', defaultValue: 'homeless'},\n        'state',\n        {name: 'location',  convert: location}\n    ]\n});\n\n// create the data store\nvar store = Ext.create('Ext.data.Store', {\n    reader: {\n        type: 'json',\n        model: 'Dude',\n        idProperty: 'key',\n        root: 'daRoot',\n        totalProperty: 'total'\n    }\n});\n\nvar myData = [\n    { key: 1,\n      name: { first: 'Fat',    last:  'Albert' }\n      // notice no city, state provided in data object\n    },\n    { key: 2,\n      name: { first: 'Barney', last:  'Rubble' },\n      city: 'Bedrock', state: 'Stoneridge'\n    },\n    { key: 3,\n      name: { first: 'Cliff',  last:  'Claven' },\n      city: 'Boston',  state: 'MA'\n    }\n];\n

Ext.data.Field
view source

dateFormat : String

Used when converting received data into a Date when the type is specified as \"date\". ...

Used when converting received data into a Date when the type is specified as \"date\".

\n\n

The format dtring is also used when serializing Date fields for use by Writers.

\n\n

A format string for the Ext.Date.parse function, or \"timestamp\" if the value provided by\nthe Reader is a UNIX timestamp, or \"time\" if the value provided by the Reader is a javascript millisecond\ntimestamp. See Ext.Date.

Defaults to: null

Ext.data.Field
view source

defaultValue : Object

The default value used when the creating an instance from a raw data object, and the property referenced by the\nmappi...

The default value used when the creating an instance from a raw data object, and the property referenced by the\nmapping does not exist in that data object.

\n\n

May be specified as undefined to prevent defaulting in a value.

Defaults to: ""

Ext.data.Field
view source

mapping : String/Number

(Optional) A path expression for use by the Ext.data.reader.Reader implementation that is creating the\nModel to extra...

(Optional) A path expression for use by the Ext.data.reader.Reader implementation that is creating the\nModel to extract the Field value from the data object. If the path expression is the same\nas the field name, the mapping may be omitted.

\n\n

The form of the mapping expression depends on the Reader being used.

\n\n

Ext.data.reader.Json
\n\n
The mapping is a string containing the javascript expression to reference the data from an element of the data\nitem's root Array. Defaults to the field name.
Ext.data.reader.Xml
\n\n
The mapping is an Ext.DomQuery path to the data item relative to the DOM element that represents the\nrecord. Defaults to the field name.
Ext.data.reader.Array
\n\n
The mapping is a number indicating the Array index of the field's value. Defaults to the field specification's\nArray position.

\n\n\n

If a more complex value extraction strategy is required, then configure the Field with a convert\nfunction. This is passed the whole row object, and may interrogate it in whatever way is necessary in order to\nreturn the desired data.

Defaults to: null

Ext.data.Field
view source

name : String

The name by which the field is referenced within the Model. ...

The name by which the field is referenced within the Model. This is referenced by, for example, the dataIndex\nproperty in column definition objects passed to Ext.grid.property.HeaderContainer.

\n\n

Note: In the simplest case, if no properties other than name are required, a field definition may consist of\njust a String for the field name.

Ext.data.Field
view source

persist : Boolean

False to exclude this field from the Ext.data.Model.modified fields in a model. ...

False to exclude this field from the Ext.data.Model.modified fields in a model. This will also exclude\nthe field from being written using a Ext.data.writer.Writer. This option is useful when model fields are\nused to keep state on the client but do not need to be persisted to the server. Defaults to true.

Defaults to: true

Ext.data.Field
view source

serialize : Function

A function which converts the Model's value for this Field into a form which can be used by whatever Writer\nis being ...

A function which converts the Model's value for this Field into a form which can be used by whatever Writer\nis being used to sync data with the server.

\n\n

The function should return a string which represents the Field's value.

\n\n

It is passed the following parameters:

\n\n

v : Mixed
\n\n
The Field's value - the value to be serialized.
rec : Ext.data.Model
\n\n
The record being serialized.

\n\n

Ext.data.Field
view source

sortDir : String

Initial direction to sort (\"ASC\" or \"DESC\"). ...

Initial direction to sort (\"ASC\" or \"DESC\"). Defaults to \"ASC\".

Defaults to: "ASC"

Ext.data.Field
view source

sortType : Function

A function which converts a Field's value to a comparable value in order to ensure correct sort ordering. ...

A function which converts a Field's value to a comparable value in order to ensure correct sort ordering.\nPredefined functions are provided in Ext.data.SortTypes. A custom sort example:

\n\n

// current sort     after sort we want\n// +-+------+          +-+------+\n// |1|First |          |1|First |\n// |2|Last  |          |3|Second|\n// |3|Second|          |2|Last  |\n// +-+------+          +-+------+\n\nsortType: function(value) {\n   switch (value.toLowerCase()) // native toLowerCase():\n   {\n      case 'first': return 1;\n      case 'second': return 2;\n      default: return 3;\n   }\n}\n

Defaults to: null

Ext.data.Field
view source

type : String/Object

The data type for automatic conversion from received data to the stored value if\nconvert has not been specified. ...

The data type for automatic conversion from received data to the stored value if\nconvert has not been specified. This may be specified as a string value.\nPossible values are

\n\n

auto (Default, implies no conversion)
string
int
float
boolean
date

\n\n\n

This may also be specified by referencing a member of the Ext.data.Types class.

\n\n

Developers may create their own application-specific data types by defining new members of the Ext.data.Types class.

Ext.data.Field
view source

useNull : Boolean

Use when converting received data into a INT, FLOAT, BOOL or STRING type. ...

Use when converting received data into a INT, FLOAT, BOOL or STRING type. If the value cannot be\nparsed, null will be used if useNull is true, otherwise a default value for that type will be used:

\n\n

for INT and FLOAT - 0.
for STRING - \"\".
for BOOL - false.

\n\n\n

Note that when parsing of DATE type fails, the value will be null regardless of this setting.

Defaults to: false

Properties

Defined By

Hierarchy

Requires

Files

Types and conversion

Config options

Properties

Instance Properties

Static Properties

Methods

Instance Methods

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Static Methods

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Returns