Member Junction
    Preparing search index...

    Class EntityDataGridRelatedEntityGenerator

    Default generator class for creating EntityDataGrid components that display related entity data in a standard data grid format. This is the most commonly used related entity display component, providing full CRUD capabilities, filtering, sorting, and pagination.

    The EntityDataGrid component provides:

    • Tabular display of related entity records using AG Grid
    • In-line editing capabilities
    • Advanced filtering and search
    • Column sorting and customization
    • Client-side and infinite scroll pagination
    • Automatic state persistence
    • Integration with MemberJunction user views
    • Automatic relationship parameter binding
    • Rich Before/After cancelable event system

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    Methods

    • Helper method that returns the name of the foreign key field in the specified entity that links to the related entity. Useful for building relationship queries and joins.

      Parameters

      • entityName: string

        The name of the entity containing the foreign key

      • relatedEntityName: string

        The name of the entity being referenced

      Returns string

      The name of the foreign key field

      Error if the foreign key field cannot be found

    • Returns the name of the parent-record property that a related entity's foreign key points at — the value to bind into a '<fk>=' + record.<property> filter. A foreign key references exactly one column: for a single-column parent key that is the key itself; for a composite parent key it is the key column named by fk.RelatedEntityFieldName.

      Parameters

      • parentEntity: EntityInfo

        The entity whose form hosts the related-entity component

      • fk: EntityFieldInfo

        The foreign key field on the related entity that links back to parentEntity

      Returns string

      The parent key column the FK references

      Error if a composite-key parent's FK does not resolve to one of its key columns