Documentation Pages
Start with installation and concepts, explore the core APIs, or use a focused feature guide.
Getting Started
Core API
Timeline
Initialization, timeline options, zoom, pan, date scale styling, viewport behaviour, and timeline methods.
Article
Article data, card layout, image handling, article options, styles, period lines, stacking, and methods.
Lane
Lane schema, configuration, layout, styling, article overrides, and lane methods.
Time Band
Time band data, configuration, visual style, and methods.
Events
Event names, handler signatures, payloads, and legacy callback notes.
Charts
Timeline-aligned chart data, options, styles, and methods.
Dates and Dmy
DateValue inputs, timezone-free strings, BCE and deep-time dates, formatting, arithmetic, comparison, and precision.
Guides
Parent Date Labels
Add optional higher-level calendar context with stable row spacing, scale selection, styling, and sticky transitions.
Custom Card Layouts
Register canvas card renderers with measured hit areas, inherited state styles, responsive selection, and safe fallbacks.
Debugging and Logging
Enable console logging, customize its prefix, and inspect timeline density regions with optional visual overlays.