Clear Up
SharpKit Reference

FieldConfig Class


Base Types



Name Description


Name Description
allowBlank Used for validating a model. Defaults to true. An empty value here will cause to evaluate to false. Defaults to: true
convert 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 :

    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 + ', ' +;
                function location(v, record){
                return ! ? '' : ( + ', ' +;
                Ext.define('Dude', {
                extend: '',
                fields: [
                {name: 'fullname',  convert: fullName},
                {name: 'firstname', mapping: 'name.first'},
                {name: 'lastname',  mapping: 'name.last'},
                {name: 'city', defaultValue: 'homeless'},
                {name: 'location',  convert: location}
                // create the data store
                var store = Ext.create('', {
                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'
    dateFormat Used when converting received data into a Date when the type is specified as "date". The format dtring is also used when serializing Date fields for use by Writers. 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. Defaults to: null
    defaultValue 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: ""
    mapping (Optional) A path expression for use by the 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.

    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.


    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.


    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. Defaults to: null
    name 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 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.
    persist False to exclude this field from the fields in a model. This will also exclude the field from being written using a 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
    serialize 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 :

    The record being serialized.

  • sortDir Initial direction to sort ("ASC" or "DESC"). Defaults to "ASC". Defaults to: "ASC"
    sortType A function which converts a Field's value to a comparable value in order to ensure correct sort ordering. Predefined functions are provided in 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;
    Defaults to: null
    type 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 class. Developers may create their own application-specific data types by defining new members of the class.
    useNull 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
    © Copyright 2005-2011 SharpKit. All rights reserved.