vis.js is a dynamic, browser-based visualization library
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
josdejong 9c8f5cb61f Updated history 10 years ago
css Switched to 2-space indentation 10 years ago
dist Fixed some more merge conflicts 10 years ago
docs Merge branch 'alex_dev' into develop 10 years ago
download Released version 0.4.0 10 years ago
examples Merge branch 'alex_dev' into develop 10 years ago
img Updated to v0.2.0 10 years ago
misc Updated version number to 0.5.0-SNAPSHOT 10 years ago
src Using new DataSet API consistently 10 years ago
test Renamed DataSet functions `subscribe` and `unsubscribe` to `on` and `off` 10 years ago
tools Switched to 2-space indentation 10 years ago
.gitignore fixed BUG! barnes hut functional but slower than almende linear approx algorithm. Now to fix the naming of functions and explain code... 10 years ago
.npmignore Released version 0.1.0 11 years ago
CNAME CNAME file added 11 years ago
HISTORY.md Updated history 10 years ago
Jakefile.js Merge branch 'alex_dev' into develop 10 years ago
LICENSE Initial import 11 years ago
NOTICE Functions `select` and `unselect` on Items working 10 years ago
README.md Functions `select` and `unselect` on Items working 10 years ago
bower.json Updated version number to 0.5.0-SNAPSHOT 10 years ago
favicon.ico Replaced logo 11 years ago
index.html Released version 0.4.0 10 years ago
package.js Released version 0.3.0 10 years ago
package.json Implemented dragging items 10 years ago
updateversion.js Released version 0.3.0 10 years ago

README.md

vis.js

Vis.js is a dynamic, browser based visualization library. The library is designed to be easy to use, handle large amounts of dynamic data, and enable manipulation of the data. The library consists of the following components:

  • DataSet and DataView. A flexible key/value based data set. Add, update, and remove items. Subscribe on changes in the data set. Filter and order items and convert fields of items.
  • Timeline. Display different types of data on a timeline. The timeline and the items on the timeline can be interactively moved, zoomed, and manipulated.
  • Graph. Display an interactive graph or network with nodes and edges.

The vis.js library is developed by Almende B.V.

Install

Install via npm:

npm install vis

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 files of vis in your web page:

<!DOCTYPE HTML>
<html>
<head>
  <script src="components/vis/dist/vis.js"></script>
  <link href="components/vis/dist/vis.css" rel="stylesheet" type="text/css" />
</head>
<body>
  <script type="text/javascript">
    // ... load a visualization
  </script>
</body>
</html>

or load vis.js using require.js. Note that vis.css must be loaded too.

require.config({
  paths: {
    vis: 'path/to/vis',
  }
});
require(['vis'], function (math) {
  // ... load a visualization
});

A timeline can be instantiated as:

var timeline = new vis.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 directory of the project.

<!DOCTYPE HTML>
<html>
<head>
  <title>Timeline basic demo</title>
  <script src="vis/dist/vis.js"></script>
  <link href="vis/dist/vis.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 vis.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. The build script uses Browserify to bundle the source code into a library, and uses UglifyJS to minify the code. The source code uses the module style of node (require and module.exports) to organize dependencies.

To install all dependencies and build the library, run npm install in the root of the project.

cd vis
npm install

Then, the project can be build running:

npm run build

Test

To test teh library, install the project dependencies once:

npm install

Then run the tests:

npm test

License

Copyright (C) 2010-2014 Almende B.V.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.