Field model class, usually used as part of the FieldsList model.

Hierarchy

Implements

Constructors

Methods

  • ColumnType returns the DB column definition of the field.

    Parameters

    Returns string

  • PrepareValue returns a properly formatted field value based on the provided raw one.

    This method is also called on record construction to initialize its default field value.

    Parameters

    Returns any

  • SetHidden changes the field hidden flag state.

    Parameters

    • hidden: boolean

    Returns void

  • SetId changes the field id.

    Parameters

    • id: string

    Returns void

  • SetName changes the field name.

    Parameters

    • name: string

    Returns void

  • SetSystem changes the field system flag state.

    Parameters

    • system: boolean

    Returns void

  • Type returns the unique type of the field.

    Returns string

Generated using TypeDoc