Home Reference Source

Function

Static Public Summary
public

compareAll(cmp: *): *

public

convertDate(value: *, toType: *, options: *): *

public

numericalDisplay(value: *): *

public

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

Parse an Immutable Map object and return the resulting field.
public

parseRef(field: *): *

public

parseTemplate(template: *, renderData: *, options: {}): *

public

registerDataTypes(register: *)

public

registerType(type: *, Type: DataType | ViewType)

Registers a custom data or view type.
public

registerViewTypes(register: *)

public

textDisplay(value: *): *

public

truthyDisplay(value: *): *

Static Public

public compareAll(cmp: *): * source 

import {compareAll} from 'formatron/src/types/view/utils.js'

Params:

NameTypeAttributeDescription
cmp *

Return:

*

public convertDate(value: *, toType: *, options: *): * source 

import {convertDate} from 'formatron/src/utils.js'

Params:

NameTypeAttributeDescription
value *
toType *
options *

Return:

*

public numericalDisplay(value: *): * source 

import {numericalDisplay} from 'formatron/src/types/view/utils.js'

Params:

NameTypeAttributeDescription
value *

Return:

*

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

import {parseField} from 'formatron/src/types/index.js'

Parse an Immutable Map object and return the resulting field. The Immutable Map field must contain a type field which represents the typeName to attempt to parse the field as.

Params:

NameTypeAttributeDescription
type *

One of Types.DATA, Types.VIEW
field Immutable.Map

The field represented by an Immutable Map.

Return:

*

Throw:

*

Will throw an error if an invalid type or field.get('type') is passed in.

public parseRef(field: *): * source 

import {parseRef} from 'formatron/src/refs.js'

Params:

NameTypeAttributeDescription
field *

Return:

*

public parseTemplate(template: *, renderData: *, options: {}): * source 

import parseTemplate from 'formatron/src/template.js'

Params:

NameTypeAttributeDescription
template *
renderData *
options {}
  • optional
  • default: {}

Return:

*

public registerDataTypes(register: *) source 

import {registerDataTypes} from 'formatron/src/types/register.js'

Params:

NameTypeAttributeDescription
register *

public registerType(type: *, Type: DataType | ViewType) source 

import {registerType} from 'formatron/src/types/index.js'

Registers a custom data or view type. They must inherit from the appropriate base class (see DataType and ViewType).

Params:

NameTypeAttributeDescription
type *

One of Types.DATA, Types.VIEW
Type DataType | ViewType

The class to be registered

Throw:

*

Will throw an error if an invalid type is passed in.

public registerViewTypes(register: *) source 

import {registerViewTypes} from 'formatron/src/types/register.js'

Params:

NameTypeAttributeDescription
register *

public textDisplay(value: *): * source 

import {textDisplay} from 'formatron/src/types/view/utils.js'

Params:

NameTypeAttributeDescription
value *

Return:

*

public truthyDisplay(value: *): * source 

import {truthyDisplay} from 'formatron/src/types/view/utils.js'

Params:

NameTypeAttributeDescription
value *

Return:

*