Skip to main content

Class: SchemaField

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

Implements​

Indexable​

[key: string]: any

Constructors​

Constructor​

new SchemaField(field): SchemaField;

Parameters​

ParameterType
field{ [key: string]: any; }

Returns​

SchemaField

Methods​

getEnumLabel()​

getEnumLabel(value): string;

Parameters​

ParameterType
valuestring | number

Returns​

string

Properties​

db_default?​

optional db_default: string | number | boolean;

Implementation of​

SchemaFieldProps.db_default

db_type?​

optional db_type: SchemaFieldDbType;

Implementation of​

SchemaFieldProps.db_type

help?​

optional help: string;

Implementation of​

SchemaFieldProps.help

hiddenOnTable?​

optional hiddenOnTable: boolean;

Implementation of​

SchemaFieldProps.hiddenOnTable

label?​

optional label: string;

Implementation of​

SchemaFieldProps.label

name?​

optional name: string;

Implementation of​

SchemaFieldProps.name

options?​

optional options: ArrayIndexed<FormElementOptions>;

Implementation of​

SchemaFieldProps.options

parameterName?​

optional parameterName: string;

Implementation of​

SchemaFieldProps.parameterName

parameterNameShort?​

optional parameterNameShort: string;

Implementation of​

SchemaFieldProps.parameterNameShort

placeholder?​

optional placeholder: string;

Implementation of​

SchemaFieldProps.placeholder

protected?​

optional protected: boolean;

Implementation of​

SchemaFieldProps.protected

readonly?​

optional readonly: boolean;

Implementation of​

SchemaFieldProps.readonly

renamable?​

optional renamable: boolean;

Implementation of​

SchemaFieldProps.renamable

searchable?​

optional searchable: boolean;

Implementation of​

SchemaFieldProps.searchable

type​

type: SchemaFieldType;

Implementation of​

SchemaFieldProps.type

value?​

optional value: any;

Implementation of​

SchemaFieldProps.value

visible?​

optional visible: boolean;

Implementation of​

SchemaFieldProps.visible