Metadata about relationships between entities including display preferences for the UI. Defines foreign key relationships and how they should be represented in the user interface.

Hierarchy (view full)

Constructors

Properties

AutoUpdateFromSchema: boolean = true
  • Field Name: AutoUpdateFromSchema
  • Display Name: Auto Update From Schema
  • SQL Data Type: bit
  • Default Value: true
  • Description: Indicates whether this relationship should be automatically updated by CodeGen. When set to 0, the record will not be modified by CodeGen. Defaults to true.
BundleInAPI: boolean = null
DisplayComponent: string = null
DisplayComponentConfiguration: string = null
DisplayComponentID: string = null
DisplayIcon: string = null
DisplayIconType: "None" | "Related Entity Icon" | "Custom" = 'Related Entity Icon'
DisplayInForm: boolean = null
DisplayLocation: "After Field Tabs" | "Before Field Tabs" = 'After Field Tabs'
DisplayName: string = null
DisplayUserViewID: string = null
DisplayUserViewName: string = null
Entity: string = null
EntityBaseTable: string = null
EntityBaseView: string = null
EntityID: string = null
EntityKeyField: string = null
ID: string = null

Primary Key

IncludeInParentAllQuery: boolean = null
JoinEntityInverseJoinField: string = null
JoinEntityJoinField: string = null
JoinView: string = null
RelatedEntity: string = null
RelatedEntityBaseTable: string = null
RelatedEntityBaseTableCodeName: string = null
RelatedEntityBaseView: string = null
RelatedEntityClassName: string = null
RelatedEntityCodeName: string = null
RelatedEntityID: string = null
RelatedEntityJoinField: string = null
Sequence: number = null
Type: string = null
__mj_CreatedAt: Date = null
__mj_UpdatedAt: Date = null

Methods

  • Copies initialization data from a plain object to the class instance. Only copies properties that already exist on the class to prevent creating new fields. Special handling for DefaultValue fields to extract actual values from SQL Server syntax.

    Parameters

    • initData: any

      The initialization data object

    Returns void