TimelineModel API in JavaScript Timeline API control

Interface for a class Timeline

Properties

beforeItemRender

EmitType<TimelineRenderingEventArgs>

Event triggers before rendering each item.

created

EmitType<Event>

Event callback that is raised after rendering the timeline.

align

string | TimelineAlign

Defines the alignment of item content within the Timeline. The possible values are:

• Before
• After
• Alternate
• AlternateReverse

    <div id="timeline"> </div>

import { Timeline, ItemModel } from '@syncfusion/ej2-layouts';

const textContent: ItemModel[] = [
    { content: 'Cart' },
    { content: 'Personal Info' },
    { content: 'Delivery Address' },
    { content: 'Payment' }
];

let timelineObj: Timeline = new Timeline({
    items : textContent,
    align: 'before'
});
timelineObj.appendTo('#timeline');

cssClass

string

Defines the CSS class to customize the Timeline appearance.

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

enableRtl

boolean

Enable or disable rendering component in right to left direction.

items

TimelineItemModel[]

Defines the list of items.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

orientation

string | TimelineOrientation

Defines the orientation type of the Timeline. The possible values are:

• Horizontal
• vertical

    <div id="timeline"> </div>

import { Timeline } from '@syncfusion/ej2-layouts';

let timelineObj: Timeline = new Timeline({
    items: [{}, {}, {}, {}],
    orientation: 'horizontal'
});
timelineObj.appendTo('#timeline');

reverse

boolean

Defines whether to show the timeline items in reverse order or not.

template

string | Function

Defines the template content for each timeline item. The template context will contain the item model.

    <div id="timeline"> </div>

import { Timeline } from '@syncfusion/ej2-layouts';

let timelineObj: Timeline = new Timeline({
    items: [{}, {}, {}, {}],
    template: '<span>${currentItem}</span>'
});
timelineObj.appendTo('#timeline');