Home Reference Source 
import DataType from 'formatron/src/types/view/data/index.js'
public class | source

DataType

Extends:

* → DataType

The base view type for displaying data from the model.

Static Member Summary

Static Public Members
public static

The default ref.
public static

Static Method Summary

Static Public Methods
public static

parseOptions(field: *, parseField: *): Immutable.Map

Parses the ref option into a {@Ref} type.

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

options: *

Method Summary

Public Methods
public

filter(filterValue: *, rowValue: *, dataType: *): *

Filters the value by calling the underlying field's filter function. If the field is not found, call the super's filter function instead.
public
public

getDisplay(renderData: *): object

public

getField(renderData: *): DataType

public

getFieldAndValue(renderData: *): object

Returns the field and value of the underlying data type.
public
public

getRef(): Ref

Returns the reference to the underlying data.
public

getValue(renderData: RenderData): object

public

initialize(renderData: *): *

public

isEditable(): bool

Returns whether the underlying data type should be editable or not.

Static Public Members

public static defaultRef: * source

The default ref. This references the root of a passed in value (aka, the value itself).

public static typeName: * source

Static Public Methods

public static parseOptions(field: *, parseField: *): Immutable.Map source

Parses the ref option into a {@Ref} type.

Params:

NameTypeAttributeDescription
field *
parseField *

Return:

Immutable.Map

The parsed options.

Public Constructors

public constructor() source

Public Members

public options: * source

Public Methods

public filter(filterValue: *, rowValue: *, dataType: *): * source

Filters the value by calling the underlying field's filter function. If the field is not found, call the super's filter function instead.

Params:

NameTypeAttributeDescription
filterValue *
rowValue *
dataType *

Return:

*

public getDefaultValue(): ViewType source

Return:

ViewType

A default value encoded as a view type.

public getDisplay(renderData: *): object source

Params:

NameTypeAttributeDescription
renderData *

Return:

object

The undeflying value of the data type formatted for human consumption.

public getField(renderData: *): DataType source

Params:

NameTypeAttributeDescription
renderData *

Return:

DataType

The underlying data type.

public getFieldAndValue(renderData: *): object source

Returns the field and value of the underlying data type.

Params:

NameTypeAttributeDescription
renderData *

Return:

object

public getPlaceholder(): string source

Return:

string

A placeholder associated with the view.

public getRef(): Ref source

Returns the reference to the underlying data. Defaults to an empty

Return:

Ref

public getValue(renderData: RenderData): object source

Params:

NameTypeAttributeDescription
renderData RenderData

The render data to get the value of.

Return:

object

The underlying value of the data type.

public initialize(renderData: *): * source

Params:

NameTypeAttributeDescription
renderData *

Return:

*

public isEditable(): bool source

Returns whether the underlying data type should be editable or not. Defaults to true.

Return:

bool

true if editable.