SchemaField

A Schema field descriptor. Contains field name, label, type, etc.

Implements

• SchemaFieldProps

Indexable

[key: string]: any

Index

Constructors

• constructor

Properties

• db_default
• db_type
• help
• label
• name
• options
• parameterName
• parameterNameShort
• placeholder
• protected
• readonly
• renamable
• searchable
• type
• value
• visible

Methods

• getEnumLabel

Constructors

constructor

• new SchemaField(field: {}): SchemaField

• Parameters

  • field: {}

  Returns SchemaField

Properties

optionaldb_default

db_default?: string | number | boolean

Implementation of SchemaFieldProps.db_default

optionaldb_type

db_type?: string

Implementation of SchemaFieldProps.db_type

optionalhelp

help?: string

Implementation of SchemaFieldProps.help

optionallabel

label?: string

Implementation of SchemaFieldProps.label

optionalname

name?: string

Implementation of SchemaFieldProps.name

optionaloptions

options?: ArrayIndexed<{}>

Implementation of SchemaFieldProps.options

optionalparameterName

parameterName?: string

Implementation of SchemaFieldProps.parameterName

optionalparameterNameShort

parameterNameShort?: string

Implementation of SchemaFieldProps.parameterNameShort

optionalplaceholder

placeholder?: string

Implementation of SchemaFieldProps.placeholder

optionalprotected

protected?: boolean

Implementation of SchemaFieldProps.protected

optionalreadonly

readonly?: boolean

Implementation of SchemaFieldProps.readonly

optionalrenamable

renamable?: boolean

Implementation of SchemaFieldProps.renamable

optionalsearchable

searchable?: boolean

Implementation of SchemaFieldProps.searchable

type

type: string

Implementation of SchemaFieldProps.type

optionalvalue

value?: any

Implementation of SchemaFieldProps.value

optionalvisible

visible?: boolean

Implementation of SchemaFieldProps.visible

Methods

getEnumLabel

• getEnumLabel(value: string | number): string

• Parameters

  • value: string | number

  Returns string