Internal representation of a timeline event. Created by mapping source records to this structure.

interface MJTimelineEvent<T> {
    config: TimelineEventConfig;
    date: Date;
    description?: string;
    entity: T;
    groupIndex: number;
    id: string;
    imageUrl?: string;
    isExpanded: boolean;
    subtitle?: string;
    title: string;
}

Type Parameters

  • T = any

    The type of the source record (defaults to any)

Properties

Display configuration for this event. Merged from group defaults and per-event overrides.

date: Date

Event date extracted from DateFieldName.

description?: string

Event description/body text.

entity: T

Reference to the original source record. Can be a BaseEntity or plain object.

groupIndex: number

Index of the parent group in the groups array.

id: string

Unique identifier for this event. Extracted from the source record using IdFieldName.

imageUrl?: string

Image URL if configured.

isExpanded: boolean

Current expansion state.

subtitle?: string

Optional subtitle extracted from SubtitleFieldName.

title: string

Event title extracted from TitleFieldName.