Class NumberField

NumberField defines "number" type field for storing numeric (float64) value.

The respective zero record field value is 0.

The following additional setter keys are available:

  - "fieldName+" - appends to the existing record value. For example:
    record.Set("total+", 5)
  - "fieldName-" - subtracts from the existing record value. For example:
    record.Set("total-", 5)

Hierarchy

core.NumberField
- NumberField

Implements

core.NumberField

Index

Constructors

constructor

new NumberField(data?): NumberField
Parameters
- Optional data: Partial<core.NumberField>
Returns NumberField
Inherited from core.NumberField.constructor
- Defined in types.d.ts:346

Methods

columnType

columnType(app): string
ColumnType implements [Field.ColumnType] interface method.
Parameters
- app: App
Returns string
Inherited from NumberField.columnType
- Defined in types.d.ts:10185

findSetter

findSetter(key): SetterFunc
FindSetter implements the [SetterFinder] interface.
Parameters
- key: string
Returns SetterFunc
Inherited from NumberField.findSetter
- Defined in types.d.ts:10209

getHidden

getHidden(): boolean
GetHidden implements [Field.GetHidden] interface method.

Returns boolean
Inherited from NumberField.getHidden
- Defined in types.d.ts:10173

getId

getId(): string
GetId implements [Field.GetId] interface method.

Returns string
Inherited from NumberField.getId
- Defined in types.d.ts:10137

getName

getName(): string
GetName implements [Field.GetName] interface method.

Returns string
Inherited from NumberField.getName
- Defined in types.d.ts:10149

getSystem

getSystem(): boolean
GetSystem implements [Field.GetSystem] interface method.

Returns boolean
Inherited from NumberField.getSystem
- Defined in types.d.ts:10161

prepareValue

prepareValue(record, raw): any
PrepareValue implements [Field.PrepareValue] interface method.
Parameters
- record: core.Record
- raw: any
Returns any
Inherited from NumberField.prepareValue
- Defined in types.d.ts:10191

setHidden

setHidden(hidden): void
SetHidden implements [Field.SetHidden] interface method.
Parameters
- hidden: boolean
Returns void
Inherited from NumberField.setHidden
- Defined in types.d.ts:10179

setId

setId(id): void
SetId implements [Field.SetId] interface method.
Parameters
- id: string
Returns void
Inherited from NumberField.setId
- Defined in types.d.ts:10143

setName

setName(name): void
SetName implements [Field.SetName] interface method.
Parameters
- name: string
Returns void
Inherited from NumberField.setName
- Defined in types.d.ts:10155

setSystem

setSystem(system): void
SetSystem implements [Field.SetSystem] interface method.
Parameters
- system: boolean
Returns void
Inherited from NumberField.setSystem
- Defined in types.d.ts:10167

type

type(): string
Type implements [Field.Type] interface method.

Returns string
Inherited from NumberField.type
- Defined in types.d.ts:10131

validateSettings

validateSettings(ctx, app, collection): void
ValidateSettings implements [Field.ValidateSettings] interface method.
Parameters
- ctx: context.Context
- app: App
- collection: core.Collection
Returns void
Inherited from NumberField.validateSettings
- Defined in types.d.ts:10203

validateValue

validateValue(ctx, app, record): void
ValidateValue implements [Field.ValidateValue] interface method.
Parameters
- ctx: context.Context
- app: App
- record: core.Record
Returns void
Inherited from NumberField.validateValue
- Defined in types.d.ts:10197

Properties

hidden

hidden: boolean

Hidden hides the field from the API response.

id

id: string

Id is the unique stable field identifier.

It is automatically generated from the name when adding to a collection FieldsList.

`Optional` max

max?: number

Max specifies the max allowed field value.

Leave it nil to skip the validator.

`Optional` min

min?: number

Min specifies the min allowed field value.

Leave it nil to skip the validator.

name

name: string

Name (required) is the unique name of the field.

onlyInt

onlyInt: boolean

OnlyInt will require the field value to be integer.

presentable

presentable: boolean

Presentable hints the Dashboard UI to use the underlying field record value in the relation preview label.

required

required: boolean

Required will require the field value to be non-zero.

system

system: boolean

System prevents the renaming and removal of the field.

Class NumberField

Hierarchy

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Optional data: Partial<core.NumberField>

Returns NumberField

Methods

columnType

Parameters

app: App

Returns string

findSetter

Parameters

key: string

Returns SetterFunc

getHidden

Returns boolean

getId

Returns string

getName

Returns string

getSystem

Returns boolean

prepareValue

Parameters

record: core.Record

raw: any

Returns any

setHidden

Parameters

hidden: boolean

Returns void

setId

Parameters

id: string

Returns void

setName

Parameters

name: string

Returns void

setSystem

Parameters

system: boolean

Returns void

type

Returns string

validateSettings

Parameters

ctx: context.Context

app: App

collection: core.Collection

Returns void

validateValue

Parameters

ctx: context.Context

app: App

record: core.Record

Returns void

Properties

hidden

id

Optional max

Optional min

name

onlyInt

presentable

required

system

Settings

Member Visibility

Theme

On This Page

`Optional` data: Partial<core.NumberField>

`Optional` max

`Optional` min