Interface 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

Implemented by

Methods

columnType findSetter getHidden getId getName getSystem prepareValue setHidden setId setName setSystem type validateSettings validateValue

Properties

help hidden id max? min? name onlyInt presentable required system

Methods

columnType

  • ColumnType implements [Field.ColumnType] interface method.

    Parameters

    Returns string

findSetter

  • FindSetter implements the [SetterFinder] interface.

    Parameters

    • key: string

    Returns SetterFunc

getHidden

  • GetHidden implements [Field.GetHidden] interface method.

    Returns boolean

getId

  • GetId implements [Field.GetId] interface method.

    Returns string

getName

  • GetName implements [Field.GetName] interface method.

    Returns string

getSystem

  • GetSystem implements [Field.GetSystem] interface method.

    Returns boolean

prepareValue

  • PrepareValue implements [Field.PrepareValue] interface method.

    Parameters

    Returns any

setHidden

  • SetHidden implements [Field.SetHidden] interface method.

    Parameters

    • hidden: boolean

    Returns void

setId

  • SetId implements [Field.SetId] interface method.

    Parameters

    • id: string

    Returns void

setName

  • SetName implements [Field.SetName] interface method.

    Parameters

    • name: string

    Returns void

setSystem

  • SetSystem implements [Field.SetSystem] interface method.

    Parameters

    • system: boolean

    Returns void

type

  • Type implements [Field.Type] interface method.

    Returns string

validateSettings

  • ValidateSettings implements [Field.ValidateSettings] interface method.

    Parameters

    Returns void

validateValue

  • ValidateValue implements [Field.ValidateValue] interface method.

    Parameters

    Returns void

Properties

help

help: string

Help is an extra text explaining what the field is about. It is usually shown in Dashboard UI under the field input.

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

Theme

On This Page

Generated using TypeDoc