blessed-components - v1.20.0
    Preparing search index...

    Interface RenderTimelineOptions

    Options accepted by renderTimeline.

    interface RenderTimelineOptions {
        emptyText?: string;
        height: number;
        items: readonly TimelineItem[];
        markers?: StatusMarkers;
        offset?: number;
        showMarker?: boolean;
        showTimestamp?: boolean;
        width: number;
        locale?: string;
        timeZone?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    emptyText?: string

    Text displayed when no items exist.

    height: number

    Maximum number of rendered rows.

    items: readonly TimelineItem[]

    Ordered timeline items. Caller-owned data is never mutated.

    markers?: StatusMarkers

    Semantic marker characters.

    offset?: number

    First rendered item index.

    showMarker?: boolean

    Whether to include semantic markers.

    true

    showTimestamp?: boolean

    Whether to include timestamps when present.

    true

    width: number

    Maximum terminal-cell width of each row.

    locale?: string
    timeZone?: string