vis.js is a dynamic, browser-based visualization library

josdejong b4a26e8b28 Bower package created		11 years ago
bin/timeline	Readme updated, example added	11 years ago
lib	Initial import	11 years ago
src	Readme updated, example added	11 years ago
test	Readme updated, example added	11 years ago
.gitignore	Initial import	11 years ago
Jakefile.js	Readme updated, example added	11 years ago
LICENSE	Initial import	11 years ago
NOTICE	Initial import	11 years ago
README.md	Readme updated, example added	11 years ago
bower.json	Bower package created	11 years ago
package.json	Readme updated, example added	11 years ago

README.md

vis.js

Vis.js is a dynamic, browser based visualization library. The library is designed to be easy to use, to handle large amounts of dynamic data, and to enable manipulation of the data. The library consists of Timeline, LineChart, LineChart3d, Graph, and Treegrid.

Vis.js Library is part of CHAP, the Common Hybrid Agent Platform, developed by Almende B.V.

Install

Install via bower:

bower install vis

Or download the library from the github project: https://github.com/almende/vis.git.

Load

To use a component, include the javascript and css file of the component in your webpage. For example for the Timeline:

<script src="../timeline.js"></script>
<link href="../timeline.css" rel="stylesheet" type="text/css" />

A timeline can be instantiated as:

var timeline = new Timeline(container, data, options);

Where container is an HTML element, data is an Array with data or a DataSet, and options is an optional object with configuration options for the component.

Example

A basic example on loading a Timeline is shown below. More examples can be found in the examples directories of each component.

<!DOCTYPE HTML>
<html>
<head>
    <title>Timeline basic demo</title>
    <script src="../timeline.js"></script>
    <link href="../timeline.css" rel="stylesheet" type="text/css" />

    <style type="text/css">
        body, html {
            font-family: sans-serif;
        }
    </style>
</head>
<body>
<div id="visualization"></div>

<script type="text/javascript">
    var container = document.getElementById('visualization');
    var data = [
        {id: 1, content: 'item 1', start: '2013-04-20'},
        {id: 2, content: 'item 2', start: '2013-04-14'},
        {id: 3, content: 'item 3', start: '2013-04-18'},
        {id: 4, content: 'item 4', start: '2013-04-16', end: '2013-04-19'},
        {id: 5, content: 'item 5', start: '2013-04-25'},
        {id: 6, content: 'item 6', start: '2013-04-27'}
    ];
    var options = {};
    var timeline = new Timeline(container, data, options);
</script>
</body>
</html>

Build

To build the library from source, clone the project from github

git clone git://github.com/almende/vis.git

The project uses jake as build tool. To be able to run jake from the command line, jake must be installed globally:

sudo npm install -g jake

Then, the project can be build by executing jake in the root of the project:

cd vis
jake

This will build the library for each of the components. The built libraries can be found in the directory bin, and includes examples.