Hierarchy

Methods

  • ColumnType returns the DB column definition of the field.

    Parameters

    Returns string

  • GetHidden returns the field hidden flag state.

    Returns boolean

  • GetId returns the field id.

    Returns string

  • GetName returns the field name.

    Returns string

  • GetSystem returns the field system flag state.

    Returns boolean

  • 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

  • Parameters

    • data: string | number[]

    Returns void

  • ValidateSettings validates the current field settings.

    Parameters

    Returns void

  • ValidateSettings validates the current field value associated with the provided record.

    Parameters

    Returns void

Properties

type: string

Generated using TypeDoc