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

jos 458ff2aba2 Updated ignore files in bower.json		10 years ago
dist	Fixed another bug in determining the items currently visible (see #197)	10 years ago
docs	Added support for title for both items and groups	10 years ago
examples	Reworked all code to commonjs modules. Replaced the build script with Gulp	10 years ago
lib	Cleaned up an unused variable	10 years ago
misc	Released version 3.0.0	10 years ago
test	Reworked the tests a little (still not close to a proper unit test though)	10 years ago
.gitignore	experiment with new hierarchical solver	10 years ago
.npmignore	Bumped version number to 0.7.0-SNAPSHOT	10 years ago
HISTORY.md	Fixed #206: removed check for number of arguments in callbacks `onAdd`, `onUpdate`, `onRemove`, and `onMove`.	10 years ago
LICENSE	Initial import	11 years ago
NOTICE	Functions `select` and `unselect` on Items working	10 years ago
README.md	Added scripts to package.json. Fixed watching for css changes too.	10 years ago
bower.json	Updated ignore files in bower.json	10 years ago
gulpfile.js	Some minor improvements to the build script	10 years ago
index.js	Reworked all code to commonjs modules. Replaced the build script with Gulp	10 years ago
package.json	Some minor improvements to the build script	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. A DataSet can filter and order items, and convert fields of items.
DataView. A filtered and/or formatted view on a DataSet.
Graph2d. Plot data on a timeline with lines or barcharts.
Graph3d. Display data in a three dimensional graph.
Network. Display a network (force directed graph) with nodes and edges.
Timeline. Display different types of data on a timeline.

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 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

To automatically rebuild on changes in the source files, once can use

npm run watch

This will both build and minify the library on changes. Minifying is relatively slow, so when only the non-minified library is needed, one can use the watch-dev script instead:

npm run watch-dev

Test

To test the library, install the project dependencies once:

npm install

Then run the tests:

npm test

License

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.