Documentation / jalali-js / TimelineOptions

Interface: TimelineOptions

Defined in: event-calendar.ts:18

Options for view: 'timeline'. Defaults match a vertical, circular-marker list with icons on and a single-sided rail.

Properties

alternating?

optional alternating?: boolean

Defined in: event-calendar.ts:33

Prefer layout: 'alternating'. When layout is omitted, true maps to alternating.

---

direction?

optional direction?: TimelineDirection

Defined in: event-calendar.ts:19

---

layout?

optional layout?: TimelineLayout

Defined in: event-calendar.ts:28

Card layout. single keeps every card on one side of the rail. alternating puts cards on both sides of a straight center rail. roadmap uses a serpentine dashed road with markers on the curve peaks. Default: 'single'.

---

markerShape?

optional markerShape?: TimelineMarkerShape

Defined in: event-calendar.ts:20

---

markerSize?

optional markerSize?: number

Defined in: event-calendar.ts:35

Marker diameter in CSS pixels. When omitted, CSS --jalali-timeline-marker-size applies.

---

showIcons?

optional showIcons?: boolean

Defined in: event-calendar.ts:21