Axinom Mosaic Libraries
    Preparing search index...

    Interface EntityFieldDefinition

    Definition of an entity field.

    interface EntityFieldDefinition {
        approval_behavior?: ApprovalBehavior;
        description?: string;
        field_name: string;
        field_type: "STRING";
        field_validation_rules?: FieldDefinitionValidationRule[];
        is_active?: boolean;
        sort_index?: number;
        title?: string;
        ui_field_custom_definition?: UiFieldCustomDefinition;
        ui_field_type: UiFieldType;
    }
    Index

    Properties

    approval_behavior? description? field_name field_type field_validation_rules? is_active? sort_index? title? ui_field_custom_definition? ui_field_type

    Properties

    approval_behavior?: ApprovalBehavior

    Configuration of the approval behavior for the field

    description?: string

    A description of the field definition

    field_name: string

    The string has a minimum length of one character and it cannot consist of only whitespace characters.

    field_type: "STRING"

    The data type of the field defined by this definition

    field_validation_rules?: FieldDefinitionValidationRule[]

    An array of field validation rules.

    is_active?: boolean

    Set to false if field definition should be deactivated, and send a separate declare command without the field after the field definition is deactivated to completely delete it.

    sort_index?: number

    The order in which this field should be displayed in relation to other fields of the same entity

    title?: string

    The title of the field definition

    ui_field_custom_definition?: UiFieldCustomDefinition

    Definition of custom Piral extension that should be used to display localization source value and translation editor field

    ui_field_type: UiFieldType

    The type of user interface element that should be used to display this field

    Settings

    Member Visibility

    On This Page

    Properties