Skip to content

Latest commit

 

History

History
61 lines (48 loc) · 1.67 KB

README.md

File metadata and controls

61 lines (48 loc) · 1.67 KB
Raw

TimeLine

This module is a layer/layout manager for time based visualisations written on top of d3.js.
The module by itself doesn't accomplish much as long as you don't pass it in some visualisation layer or component.
This illustrates how you could use with a segment visualiser.

Status

This library is under heavy development and subject to change.
Evert new API breaking change we will be adding snapshots to the repository so you can always fetch a working copy.

For an in depth explanation on the philosophy and usage of this library please refer to this blog post.

Usage

Creating the timeLine layout

var graph = timeLine()
  .width(800)
  .height(150)
  .xDomain([0, 100]);

Data

Will be passed to a visualiser.

var data = 
  [{
      "start": 37,
      "duration": 4,
      "color": "#414FBA" },
    { "start": …},
    { "start": …}
  ];

Creating the Visualiser layer

var seg = segmentVis()
  .data(data)
  .name('segments')
  .opacity(0.5);

Adding the Visualiser layer and drawing everything

// we add layers like this
graph.layer(seg);
// we pass in the drawing method from our timeline object
d3.select('.timeline').call(graph.draw);

License

This module is released under the BSD-3-Clause license.

Acknowledgments

This code is part of the WAVE project, funded by ANR (The French National Research Agency), ContInt program, 2012-2015.