Class Field

constructor

• new Field(o): Field

• Constructor

  Parameters

  • o: Field | FieldCfg

  Returns Field

attributes

calculated

class

Optional default

Optional description

disabled

Optional expression

Optional fieldview

Optional help

hidden

Optional id

Optional in_auto_save

input_type

is_fkey

is_unique

label

name

Optional options

Optional parent_field

Optional postText

primary_key

refname

Optional reftable

Optional reftable_name

Optional reftype

required

Optional showIf

Optional sourceURL

stored

Optional sublabel

Optional tab

Optional table

Optional table_id

Optional type

Optional typename

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(): null | {
      LoggedIn: ((__namedParameters) => boolean);
  }

• Returns null | {
      LoggedIn: ((__namedParameters) => boolean);
  }

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(): undefined | string

• Returns undefined | string

add_unique_constraint

• add_unique_constraint(): Promise<void>

• Returns Promise<void>

alter_sql_type

• alter_sql_type(new_field): Promise<void>

• Parameters

  • new_field: Field

  Returns Promise<void>

delete

• delete(): Promise<void>

• Returns Promise<void>

  Throws

distinct_values

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

• Distinct Values

  Parameters

  • Optional req: any

  • Optional where: Where

  • Optional only_present: boolean

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

enable_fkey_constraint

• enable_fkey_constraint(table): Promise<void>

• Parameters

  • table: Table

  Returns Promise<void>

fill_fkey_options

• fill_fkey_options(force_allow_none?, where0?, extraCtx?, optionsQuery?, formFieldNames?, existingValue?, user?): Promise<void>

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

  Parameters

  • Optional force_allow_none: boolean = false

  • Optional where0: Where

  • extraCtx: any = {}

  • Optional optionsQuery: any

    remote/local query to load rows from 'reftable_name'

  • Optional formFieldNames: string[]

  • Optional existingValue: any

  • Optional user: 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>

  showIfEnabled

  • showIfEnabled(whole_rec): boolean

  • Parameters

    • whole_rec: any

    Returns boolean

  toggle_not_null

  • toggle_not_null(not_null): Promise<void>

  • Parameters

    • not_null: boolean

    Returns Promise<void>

  update

  • update(v): Promise<void>

  • Parameters

    • v: Row

    Returns Promise<void>

  validate

  • validate(whole_rec): ResultMessage

  • Parameters

    • whole_rec: any

    Returns ResultMessage

  Static create

  • create(fld, bare?, id?): Promise<Field>

  • Parameters

    • fld: Field | FieldCfg

    • bare: boolean = false

    • Optional id: string

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

    Returns Promise<Field>

  Static find

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

  • Parameters

    • Optional where: Where

    • Optional selectopts: SelectOptions = ...

    Returns Promise<Field[]>

  Static findOne

  • findOne(where): Promise<Field>

  • Parameters

    • where: Where

    Returns Promise<Field>

  Static getTypeAttributes

  • getTypeAttributes(typeattribs?, table_id?): any

  • Parameters

    • Optional typeattribs: any

    • Optional table_id: number

    Returns any

  Static labelToName

  • labelToName(label): string

  • Label 2 Name

    Parameters

    • label: string

    Returns string

  Static nameToLabel

  • nameToLabel(label): string

  • Parameters

    • label: string

    Returns string

  Static select_options_query

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

  • Parameters

    • table_name: string

    • where: string

    • attributes: any

    • extra_joinfields: any = {}

    • Optional user: any

    Returns Promise<any>

  Settings

  Member Visibility

  Protected

• Inherited
• External