FloatField

Source
import { FloatField } from "@prestojs/viewmodel";
Hierarchy

Examples

Default widget in a Form

Default formatter for FloatField

API

Constructor

new FloatField(?values)
Params:
ParameterTypeDescription
values
An object with the properties below
values.asyncChoicesAsyncChoicesInterface
values.blankboolean
values.blankAsNullboolean
values.choicesMap|[number, string][]
values.defaultValuenull|number|
values.formatterPropsRecord
values.helpTextstring
values.labelstring
values.maxValuestring|number
values.minValuestring|number
values.readOnlyboolean
values.widgetPropsRecord
values.writeOnlyboolean

Methods

clone()
Returns:Field
contributeToClass(viewModel)
Params:
ParameterTypeDescription
*viewModelViewModelConstructor
Returns:void
format(value)
Params:
ParameterTypeDescription
*valuenumber
Returns:any
getFormatterProps()
Returns:{[fieldName: string]: any }
getWidgetProps()
Returns:{[fieldName: string]: any }
isEqual(value1,value2)
Params:
ParameterTypeDescription
*value1number
*value2number
Returns:boolean
normalize(value)
Params:
ParameterTypeDescription
*valuestring|number
Returns:null|number
parse(value)
Params:
ParameterTypeDescription
*valueany
Returns:null|number
toJS(value)
Params:
ParameterTypeDescription
*valuenumber
Returns:null|string|number|Record
toString()
Returns:string

Properties

blank

Source
boolean

blankAsNull

Source
boolean

boundRecord

Source
undefined|ViewModelInterface

choices

Source
Map

defaultValue

Source
undefined|null|number|Promise

formatterProps

Source
Record

helpText

Source
string

isBound

Source
boolean

label

Source
string

maxValue

Source
string|number

minValue

Source
string|number

name

Source
string

readOnly

Source
boolean

value

Source
undefined|number

widgetProps

Source
Record

writeOnly

Source
boolean

Static Properties

fieldClassName

Source
string