Back to Pocketbase

Class NumberField

static/jsvm/classes/NumberField.html

latest6.2 KB
Original Source

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)Copy

Hierarchy

Implements

Index

Constructors

constructor

Methods

columnTypefindSettergetHiddengetIdgetNamegetSystemprepareValuesetHiddensetIdsetNamesetSystemtypevalidateSettingsvalidateValue

Properties

hiddenidmax?min?nameonlyIntpresentablerequiredsystem

Constructors

constructor

Parameters

Optional data: Partial<core.NumberField>

Returns NumberField

Methods

columnType

  • columnType(app): string

ColumnType implements [Field.ColumnType] interface method.

Parameters

app: App

Returns string

findSetter

FindSetter implements the [SetterFinder] interface.

Parameters

key: string

Returns SetterFunc

getHidden

  • getHidden(): boolean

GetHidden implements [Field.GetHidden] interface method.

Returns boolean

getId

  • getId(): string

GetId implements [Field.GetId] interface method.

Returns string

getName

  • getName(): string

GetName implements [Field.GetName] interface method.

Returns string

getSystem

  • getSystem(): boolean

GetSystem implements [Field.GetSystem] interface method.

Returns boolean

prepareValue

  • prepareValue(record, raw): any

PrepareValue implements [Field.PrepareValue] interface method.

Parameters

record: core.Record
raw: any

Returns any

setHidden

  • setHidden(hidden): void

SetHidden implements [Field.SetHidden] interface method.

Parameters

hidden: boolean

Returns void

setId

  • setId(id): void

SetId implements [Field.SetId] interface method.

Parameters

id: string

Returns void

setName

  • setName(name): void

SetName implements [Field.SetName] interface method.

Parameters

name: string

Returns void

setSystem

  • setSystem(system): void

SetSystem implements [Field.SetSystem] interface method.

Parameters

system: boolean

Returns void

type

  • type(): string

Type implements [Field.Type] interface method.

Returns string

validateSettings

  • validateSettings(ctx, app, collection): void

ValidateSettings implements [Field.ValidateSettings] interface method.

Parameters

ctx: context.Context
app: App
collection: core.Collection

Returns void

validateValue

  • validateValue(ctx, app, record): void

ValidateValue implements [Field.ValidateValue] interface method.

Parameters

ctx: context.Context
app: App
record: core.Record

Returns void

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.

Settings

Member Visibility

  • Inherited

Theme

OSLightDark

On This Page

Generated using TypeDoc