Generator class for creating timeline components that display related entity data in chronological order. This component is ideal for showing time-based relationships like activity logs, event histories, deal stages, or any date-sequenced data.

The timeline component provides:

  • Chronological visualization of related records
  • Configurable horizontal or vertical layout
  • Flexible field mapping for dates, titles, and descriptions
  • Automatic filtering based on parent entity relationships

Hierarchy (view full)

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

    Throws

    Error if the foreign key field cannot be found