Class Field

constructor

• new Field(o: Field | FieldCfg): Field

  Constructor

  Parameters

  • o: Field | FieldCfg

  Returns Field

attributes

calculated

class

Optionaldefault

Optionaldescription

disabled

Optionalexclude_from_mobile

Optionalexpression

Optionalfieldview

OptionalfieldviewObj

Optionalhelp

hidden

Optionalid

Optionalin_auto_save

input_type

is_fkey

is_unique

label

name

Optionaloptions

Optionalparent_field

OptionalpostText

Optionalpreset_options

primary_key

refname

Optionalreftable

Optionalreftable_name

Optionalreftype

required

OptionalshowIf

OptionalsourceURL

stored

Optionalsublabel

Optionaltab

Optionaltable

Optionaltable_id

Optionaltype

Optionaltypename

validator

form_name

• get form_name(): string

  ???

  Returns string

listKey

• get listKey(): any

  Returns any

multipartFormData

• get multipartFormData(): boolean

  Returns boolean

on_delete_sql

• get on_delete_sql(): string

  Returns string

presets

• get presets(): | { LoggedIn: (__namedParameters: { user: any }) => boolean }
  | null

  Returns { LoggedIn: (__namedParameters: { user: any }) => boolean } | null

pretty_type

• get pretty_type(): string

  Returns string

sql_bare_type

• get sql_bare_type(): string

  Returns string

sql_type

• get sql_type(): string

  Returns string

toBuilder

• get toBuilder(): any

  To Json

  Returns any

toJson

• get toJson(): any

  To Json

  Returns any

type_name

• get type_name(): string | undefined

  Returns string | undefined

add_unique_constraint

• add_unique_constraint(): Promise<void>

  Returns Promise<void>

alter_sql_type

• alter_sql_type(new_field: Field): Promise<void>

  Parameters

  • new_field: Field

  Returns Promise<void>

delete

• delete(): Promise<void>

  Returns Promise<void>

  Throws

distinct_values

• distinct_values(
      req?: any,
      where?: Where,
      only_present?: boolean,
  ): Promise<{ jsvalue?: boolean; label: string; value: string }[]>

  Distinct Values

  Parameters

  • Optionalreq: any
  • Optionalwhere: Where
  • Optionalonly_present: boolean

  Returns Promise<{ jsvalue?: boolean; label: string; value: string }[]>

enable_fkey_constraint

• enable_fkey_constraint(table: Table): Promise<void>

  Parameters

  • table: Table

  Returns Promise<void>

fill_fkey_options

• fill_fkey_options(
      force_allow_none?: boolean,
      where0?: Where,
      extraCtx?: any,
      optionsQuery?: any,
      formFieldNames?: string[],
      existingValue?: any,
      user?: any,
  ): Promise<void>

  Fills 'this.options' with values available via foreign key Could be used for in a to select a user

  Parameters

  • Optionalforce_allow_none: boolean = false
  • Optionalwhere0: Where
  • extraCtx: any = {}
  • OptionaloptionsQuery: any

    remote/local query to load rows from 'reftable_name'

  • OptionalformFieldNames: string[]
  • OptionalexistingValue: any
  • Optionaluser: any

  Returns Promise<void>

  fill_table

  • fill_table(): void

    Returns void

  generate

  • generate(): Promise<any>

    Returns Promise<any>

  remove_unique_constraint

  • remove_unique_constraint(): Promise<void>

    Returns Promise<void>

  set_calc_joinfields

  • set_calc_joinfields(): Promise<void>

    Returns Promise<void>

  showIfEnabled

  • showIfEnabled(whole_rec: any): boolean

    Parameters

    • whole_rec: any

    Returns boolean

  toggle_not_null

  • toggle_not_null(not_null: boolean): Promise<void>

    Parameters

    • not_null: boolean

    Returns Promise<void>

  update

  • update(v: Partial<Field> | Partial<FieldCfg>): Promise<void>

    Parameters

    • v: Partial<Field> | Partial<FieldCfg>

    Returns Promise<void>

  validate

  • validate(whole_rec: any): ResultMessage

    Parameters

    • whole_rec: any

    Returns ResultMessage

  Staticcreate

  • create(fld: Field | FieldCfg, bare?: boolean, id?: string): Promise<Field>

    Parameters

    • fld: Field | FieldCfg
    • bare: boolean = false
    • Optionalid: string

      optional id, if set, no '_sc_fields' entry is inserted

    Returns Promise<Field>

  Staticfind

  • find(where?: Where, selectopts?: SelectOptions): Promise<Field[]>

    Parameters

    • Optionalwhere: Where
    • Optionalselectopts: SelectOptions = ...

    Returns Promise<Field[]>

  StaticfindCached

  • findCached(where?: Where): Field[]

    Parameters

    • Optionalwhere: Where

    Returns Field[]

  StaticfindOne

  • findOne(where: Where): Promise<Field>

    Parameters

    • where: Where

    Returns Promise<Field>

  StaticgetTypeAttributes

  • getTypeAttributes(typeattribs?: any, table_id?: number): any

    Parameters

    • Optionaltypeattribs: any
    • Optionaltable_id: number

    Returns any

  StaticlabelToName

  • labelToName(label: string): string

    Label 2 Name

    Parameters

    • label: string

    Returns string

  StaticnameToLabel

  • nameToLabel(label: string): string

    Parameters

    • label: string

    Returns string

  Staticselect_options_query

  • select_options_query(
        table_name: string,
        where: string,
        attributes: any,
        extra_joinfields?: any,
        user?: any,
    ): Promise<any>

    Parameters

    • table_name: string
    • where: string
    • attributes: any
    • extra_joinfields: any = {}
    • Optionaluser: any

    Returns Promise<any>

  Settings

  Member Visibility

  Protected

• Inherited
• External