Clear Up
SharpKit Reference

FieldConfig Class

Namespace: Ext.data

Base Types

System.Object

Constructors

Name Description
FieldConfig()

Properties

Name Description
allowBlank @private * Used for validating a {@link Ext.data.Model model}. Defaults to true. An empty value here will cause {@link Ext.data.Model}.{@link Ext.data.Model#isValid isValid} to evaluate to false.
convert * A function which converts the value provided by the Reader into an object that will be stored in the Model. It is passed the following parameters: * - **v** : Mixed * The data value as read by the Reader, if undefined will use the configured `{@link Ext.data.Field#defaultValue 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 {@link Ext.data.Model#fields fields} array. * Example of convert functions: * function fullName(v, record){ return record.name.last + ', ' + record.name.first; } * function location(v, record){ return !record.city ? '' : (record.city + ', ' + record.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' } ];
dateFormat * Used when converting received data into a Date when the {@link #type} is specified as `"date"`. * A format string for the {@link Ext.Date#parse 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 {@link Ext.Date}.
defaultValue * The default value used **when a Model is being created by a {@link Ext.data.reader.Reader Reader}** when the item referenced by the `{@link Ext.data.Field#mapping mapping}` does not exist in the data object (i.e. undefined). Defaults to "".
mapping * (Optional) A path expression for use by the {@link Ext.data.reader.Reader} implementation that is creating the {@link Ext.data.Model 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. * - {@link 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 {@link Ext.data.reader.Json#root root} Array. Defaults to the field name. * - {@link Ext.data.reader.Xml} * The mapping is an {@link Ext.DomQuery} path to the data item relative to the DOM element that represents the {@link Ext.data.reader.Xml#record record}. Defaults to the field name. * - {@link 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 {@link #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.
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 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.
persist * False to exclude this field from the {@link Ext.data.Model#modified} fields in a model. This will also exclude the field from being written using a {@link 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.
sortDir * Initial direction to sort (`"ASC"` or `"DESC"`). 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 {@link 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; } }
type * The data type for automatic conversion from received data to the *stored* value if `{@link Ext.data.Field#convert 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 {@link Ext.data.Types} class. * Developers may create their own application-specific data types by defining new members of the {@link Ext.data.Types} class.
useNull * 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.
© Copyright 2005-2011 SharpKit. All rights reserved.