Configuration settings for timeline component instances. Defines how related entity data should be displayed in a chronological timeline format, including which fields to use for dates, titles, and descriptions.

Hierarchy (view full)

Constructors

Properties

DateField: string

The name of the field in the related entity that contains the date/timestamp for positioning items on the timeline (e.g., 'CreatedAt', 'EventDate')

DescriptionField?: string

Optional field name for longer description text displayed in the timeline item. Typically contains detailed information about the timeline event.

DisplayOrientation?: "horizontal" | "vertical" = 'vertical'

Controls the visual layout of the timeline. Vertical timelines stack items top-to-bottom, while horizontal timelines arrange items left-to-right.

Default

'vertical'
SubTitleField?: string

Optional field name for subtitle text displayed below the main title. Useful for additional context or secondary information.

TitleField: string

The name of the field in the related entity that contains the main title text to display for each timeline item (e.g., 'Title', 'Name', 'Subject')