Member Junction
    Preparing search index...

    Interface IEntityRelationshipUIConfiguration

    How this relationship appears on the parent entity's generated form.

    Nested under IEntityRelationshipConfiguration.UI so later UI concerns (group, default-expanded, badge) can sit beside inclusion without a migration.

    interface IEntityRelationshipUIConfiguration {
        FormRole?: "Primary" | "Detail";
        inclusion?: "None" | "Primary" | "More";
        join?: { fields: string[]; mode: "any" };
        showCount?: boolean;
        sortKey?: number;
        whenEmpty?: "more" | "show" | "hide";
    }
    Index

    Properties

    FormRole? inclusion? join? showCount? sortKey? whenEmpty?

    Properties

    FormRole?: "Primary" | "Detail"

    Alias of inclusion. 'Primary' maps to Primary, 'Detail' maps to More.

    inclusion?: "None" | "Primary" | "More"

    L1 inclusion on the parent form. Keyed conceptually by (parent, related entity), not by a single FK.

    • 'Primary' — first-class rail.
    • 'More' — candidate, parked in More.
    • 'None' — not a candidate. Not in More. Ranker never sees it.

    Omit = Auto (L2 ranker). See Forms Architecture §7d.

    join?: { fields: string[]; mode: "any" }

    Same-table OR of FKs for one parent-form section (Bill-To OR Ship-To Orders). Sibling ERs to the same related entity should be inclusion: 'None' so they do not sprout extra rail items.

    showCount?: boolean

    Prefetch this section's row count when the record loads and show it as a badge. Set false for known-expensive related entities.

    Omit = inherit the parent entity's UI.Form.ShowRelatedCounts, else true.

    sortKey?: number

    Higher = earlier among first-class related rail items (after Details, after lead contributions such as Overview). Omit = 0.

    whenEmpty?: "more" | "show" | "hide"

    What the parent form does with this section when it has 0 rows. Counts are fetched in one batched round trip when the record loads.

    • 'show' — always show (use when users create the first row here).
    • 'hide' — hide while empty. The "show empty fields" toolbar toggle reveals it.
    • 'more' — move into the More folder while empty; returns to its normal placement once it has rows.

    Omit = inherit the parent entity's UI.Form.RelatedWhenEmpty, else 'show'.

    Settings

    Member Visibility

    On This Page

    Properties