centurion-erp-ui
    Preparing search index...

    Class APIDataFieldRelationship

    RelationShip Data field

    This data field correlates to a html <input type="select" />

    0.9.0

    Hierarchy

    • APIDataFieldBase<this>
      • APIDataFieldRelationship
    Index

    Constructors

    constructor

    Properties

    choices help_text label read_only required type write_only

    Constructors

    Properties

    choices: { display_name: string; value: string | number }[]

    What are the available choices for this field.

    Type Declaration

    • display_name: string

      Value the user sees in the dropdown

    • value: string | number

      Correlation ID. This value must match the value you store in the database to reference this object. This value will generally be the Primary Key.

    help_text

    help_text: string

    Field Description. This will be displayed for the user.

    label: string

    Label the field will be given

    read_only: boolean

    Is this field read-only?

    The value of this field should be based off of the users permissions. The UI uses this value to determine if when creating/editing that an editable field be displayed to the user.

    required: boolean

    Is this field mandatory.

    When the value is true The user will not be able to submit the form.

    type: "Relationship"

    What is the type of the data field.

    write_only: boolean

    Is the data field a write-only field. When set to true, the user will not be able to edit the field.

    The value of this field should be based off of the users permissions.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties