Ext_data_Field.configs

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

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

It is passed the following parameters:

v : Mixed

The data value as read by the Reader, if undefined will use the configured defaultValue.
rec : Ext.data.Model

The data object containing the Model as read so far by the Reader. Note that the Model may not be fully populated at this point as the fields are read in the order that they are defined in your fields array.

Example of convert functions:

function fullName(v, record){
    return record.data.last + ', ' + record.data.first;
}

function location(v, record){
    return !record.data.city ? '' : (record.data.city + ', ' + record.data.state);
}

Ext.define('Dude', {
    extend: 'Ext.data.Model',
    fields: [
        {name: 'fullname',  convert: fullName},
        {name: 'firstname', mapping: 'name.first'},
        {name: 'lastname',  mapping: 'name.last'},
        {name: 'city', defaultValue: 'homeless'},
        'state',
        {name: 'location',  convert: location}
    ]
});

// create the data store
var store = Ext.create('Ext.data.Store', {
    reader: {
        type: 'json',
        model: 'Dude',
        idProperty: 'key',
        root: 'daRoot',
        totalProperty: 'total'
    }
});

var myData = [
    { key: 1,
      name: { first: 'Fat',    last:  'Albert' }
      // notice no city, state provided in data object
    },
    { key: 2,
      name: { first: 'Barney', last:  'Rubble' },
      city: 'Bedrock', state: 'Stoneridge'
    },
    { key: 3,
      name: { first: 'Cliff',  last:  'Claven' },
      city: 'Boston',  state: 'MA'
    }
];

Serves as a default for the dateReadFormat and dateWriteFormat config options. This will be used in place of those other configurations if not specified.

A format string for the Ext.Date.parse 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 Ext.Date.

It is quite important to note that while this config is optional, it will default to using the base JavaScript Date object's parse function if not specified, rather than Ext.Date.parse. This can cause unexpected issues, especially when converting between timezones, or when converting dates that do not have a timezone specified. The behavior of the native Date.parse is implementation-specific, and depending on the value of the date string, it might return the UTC date or the local date. For this reason it is strongly recommended that you always specify an explicit date format when parsing dates.

Used when converting received data into a Date when the type is specified as "date". This configuration takes precedence over dateFormat. See dateFormat for more information.

Used to provide a custom format when serializing dates with a Ext.data.writer.Writer. If this is not specified, the dateFormat will be used. See the Ext.data.writer.Writer docs for more information on writing dates.

Note that to use a JsonWriter to send Microsoft format "JSON" dates, which are in fact invalid JSON, it is not possible to use the standard date serialization pathway or native browser JSON production.

To use a JsonWriter to write dates in a JSON packet in the form "\/Date(1357372800000)\/" configure the field like this:

{ type: 'date', dateFormat: 'MS', // To parse incoming dates from server correctly serialize: Ext.identityFn // An ExtJS-supplied function which returns the arg unchanged }

Then override ExtJS's JSON date serialize function:

Ext.JSON.encodeDate = function (d) { return '"' + Ext.Date.format(d, 'MS') + '"'; };

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

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

Defaults to: ""

(Optional) A path expression for use by the Ext.data.reader.Reader implementation that is creating the Model 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.

Ext.data.reader.Json

The mapping is a string containing the javascript expression to reference the data from an element of the data item's root Array. Defaults to the field name.
Ext.data.reader.Xml

The mapping is an Ext.DomQuery path to the data item relative to the DOM element that represents the record. Defaults to the field name.
Ext.data.reader.Array

The mapping is a number indicating the Array index of the field's value. Defaults to the field specification's Array position.

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.

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

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.

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

Defaults to: true

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

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

It is passed the following parameters:

v : Mixed

The Field's value - the value to be serialized.
rec : Ext.data.Model

The record being serialized.

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

Defaults to: "ASC"

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:

// current sort     after sort we want
// +-+------+          +-+------+
// |1|First |          |1|First |
// |2|Last  |          |3|Second|
// |3|Second|          |2|Last  |
// +-+------+          +-+------+

sortType: function(value) {
   switch (value.toLowerCase()) // native toLowerCase():
   {
      case 'first': return 1;
      case 'second': return 2;
      default: return 3;
   }
}

May also be set to a String value, corresponding to one of the named sort types in Ext.data.SortTypes.

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

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

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.

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

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

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

Defaults to: false

Class type Ext_data_Field.configs