Packageflare.data
Classpublic class DataField

A data field stores metadata for an individual data variable.



Public Properties
 PropertyDefined by
  defaultValue : Object
[read-only] The default value for this data field.
DataField
  format : String
[read-only] A formatting string for printing values of this field.
DataField
  id : String
[read-only] A unique id for the data field, often the name.
DataField
  label : String
[read-only] A label describing this data field, useful for axis titles.
DataField
  name : String
[read-only] The name of the data field.
DataField
  type : int
[read-only] The data type of this field.
DataField
Public Methods
 MethodDefined by
  
DataField(name:String, type:int, def:Object = null, id:String = null, format:String = null, label:String = null)
Creates a new DataField.
DataField
Property detail
defaultValueproperty
defaultValue:Object  [read-only]

The default value for this data field.

Implementation
    public function get defaultValue():Object
formatproperty 
format:String  [read-only]

A formatting string for printing values of this field.

Implementation
    public function get format():String

See also

flare.util.Stings.format
idproperty 
id:String  [read-only]

A unique id for the data field, often the name.

Implementation
    public function get id():String
labelproperty 
label:String  [read-only]

A label describing this data field, useful for axis titles.

Implementation
    public function get label():String
nameproperty 
name:String  [read-only]

The name of the data field.

Implementation
    public function get name():String
typeproperty 
type:int  [read-only]

The data type of this field.

Implementation
    public function get type():int

See also

flare.data.DataUtil.
Constructor detail
DataField()constructor
public function DataField(name:String, type:int, def:Object = null, id:String = null, format:String = null, label:String = null)

Creates a new DataField.

Parameters
name:String — the name of the data field
 
type:int — the data type of this field
 
def:Object (default = null) — the default value of this field
 
id:String (default = null) — a unique id for the field. If null, the name will be used
 
format:String (default = null) — a formatting string for printing values of this field
 
label:String (default = null) — a label describing this data field