spyrian

Spyrian visualises time-based, hierarchical data, providing an interpretation efficient overview. Feed spyrian data, then watch it turn into something pretty.

How to install

npm install spyrian

How to use

1. Require spyrian:

var spyrian = require("spyrian");

2. Provide spyrian with an overview feeder function to be used to obtain data for the visualisation:

spyrian(function(from, to, callback) {
  var data = [
    {"key0": "a", "key1": "0", "timestamp": 1349942762095, "heat": 0, "link": "2"},
    {"key0": "b", "key1": "1", "timestamp": 1349725871295, "heat": 1, "link": "0"},
    {"key0": "c", "key1": "2", "timestamp": 1350731714596, "heat": 0, "link": "1"}
  ];

  callback(null, data); // Node.js callback convention
});

3. Configure the hierarchy:

spyrian.hierarchy
  .id("key0")
    .id("key1")
    .heat("heat")
    .link("link");

Each id() call provides spyrian with a nesting level, where the passed in property name or function is used to obtain the id of the node under which events are nested at a particular nesting level.

heat() takes in a property or function (along with other optional arguments) invoked for each datum to obtain the value to be used in determining the colors of nodes and links in the visualisation.

link() takes in a property or function invoked for each datum to obtain the id of a leaf node in the hierarchy used as the target for the link (where the source of the link is the node under which the datum was nested using id()). The obtained links are used to display the lines in the visualisation.

4. Start spyrian!:

spyrian.start()

For more, take a look at the API and annotated source