Skip to content

peterferencz/timelinR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TimelinR

My simple timeline implementation

Features

! This timeline is single-lined. If two points get too close, they will  just simply overlap. !
  • Supports ranges and points

Usage

const timeline = new TimelinR(element, data, options);

Data

{
    from: number,
    to: optional number,
    text: optional string
}

Options

a JSON object with the following optional properties

name type default description
start number 0 Where should the timeline start
zoom number 1 How much segments should be visible at any moment (It is a bit counterintuitive, because bigger value means less "zoom")
minZoom number 60 The minimum amount of zoom
maxZoom number 1 The maximum amount of zoom
minOffset number 0 Should not be changed, change start instead
maxOffset number 60 The maximum amount of offset
showCurrentTime boolean true Whether to show the red line
canModify boolean true Wether the user can move, resize and rename data points
backgroundCollapseAt number 20 When zooming out, this is the zoom threshold to hit to collapse the segments
backgroundCollapse number 10 When collapsing the background, this is the new interval for segments
labelText function(number) :string (i) => i What to display at each segment
onZoomChanged callback(number):void (zoom)=>{} A callback for when the zoom changes
onOffsetChanged callback(number):void (offfset)=>{} A callback for when the offset chages
onDataChanged callback(array[data]):void (data)=>{} A callback for when data was moved, resized or renamed

About

A javascript single line timeline library

Resources

Stars

Watchers

Forks