- Notifications
You must be signed in to change notification settings - Fork1.5k
almende/vis
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
❗This project is not maintained anymore! (SeeIssue #4259 for details)
We welcome you to use the libraries from thevisjs community from now on.
Vis.js is a dynamic, browser based visualization library.The library is designed to be easy to use, handle large amountsof 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, andremove items. Subscribe on changes in the data set. A DataSet can filter andorder 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 was initially developed byAlmende B.V.
Install via npm:
npm install vis
Install via bower:
bower install vis
Link via cdnjs:https://cdnjs.com/libraries/vis
Or download the library from the github project:https://github.com/almende/vis.git.
To use a component, include the javascript and css files of vis in your web page:
<!DOCTYPE HTML><html><head><scriptsrc="vis/dist/vis.min.js"></script><linkhref="vis/dist/vis.min.css"rel="stylesheet"type="text/css"/></head><body><scripttype="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/dist',}});require(['vis'],function(math){// ... load a visualization});
A timeline can be instantiated as:
vartimeline=newvis.Timeline(container,data,options);
Wherecontainer is an HTML element,data is an Array with data or a DataSet,andoptions is an optional object with configuration options for thecomponent.
A basic example on loading a Timeline is shown below. More examples can befound in theexamples directoryof the project.
<!DOCTYPE HTML><html><head><title>Timeline basic demo</title><scriptsrc="vis/dist/vis.min.js"></script><linkhref="vis/dist/vis.min.css"rel="stylesheet"type="text/css"/><styletype="text/css">body,html {font-family: sans-serif; }</style></head><body><divid="visualization"></div><scripttype="text/javascript">varcontainer=document.getElementById('visualization');vardata=[{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'}];varoptions={};vartimeline=newvis.Timeline(container,data,options);</script></body></html>
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) toorganize dependencies. To install all dependencies and build the library,runnpm install in the root of the project.
cd visnpm installThen, 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 relativelyslow, so when only the non-minified library is needed, one can use thewatch-dev script instead:
npm run watch-dev
The folderdist contains bundled versions of vis.js for direct use in the browser. These bundles contain all the visualizations and include external dependencies such ashammer.js andmoment.js.
The source code of vis.js consists of commonjs modules, which makes it possible to create custom bundles using tools likeBrowserify orWebpack. This can be bundling just one visualization like the Timeline, or bundling vis.js as part of your own browserified web application.
Note that hammer.js version 2 is required as of v4.
Before you can do a build:
- Installnode.js andnpm on your system:https://nodejs.org/
- Install the following modules using npm:
browserify,babelify, anduglify-js:
[sudo] npm install -g browserify babelify uglify-js
- Download or clone the vis.js project:
git clone https://github.com/almende/vis.git
- Install the dependencies of vis.js by running
npm installin the root of the project:
cd visnpm installFor example, to create a bundle with just the Timeline and DataSet, create an index file namedcustom.js in the root of the project, containing:
exports.DataSet=require('./lib/DataSet');exports.Timeline=require('./lib/timeline/Timeline');
Then create a custom bundle using browserify, like:
browserify custom.js -t [ babelify --presets [es2015] ] -o dist/vis-custom.js -s vis
This will generate a custom bundlevis-custom.js, which exposes the namespacevis containing onlyDataSet andTimeline. The generated bundle can be minified using uglifyjs:
uglifyjs dist/vis-custom.js -o dist/vis-custom.min.js
The custom bundle can now be loaded like:
<!DOCTYPE HTML><html><head><scriptsrc="dist/vis-custom.min.js"></script><linkhref="dist/vis.min.css"rel="stylesheet"type="text/css"/></head><body> ...</body></html>
The default bundlevis.js is standalone and includes external dependencies such ashammer.js andmoment.js. When these libraries are already loaded by the application, vis.js does not need to include these dependencies itself too. To build a custom bundle of vis.js excludingmoment.js andhammer.js, run browserify in the root of the project:
browserify index.js -t [ babelify --presets [es2015] ] -o dist/vis-custom.js -s vis -x moment -x hammerjs
This will generate a custom bundlevis-custom.js, which exposes the namespacevis, and hasmoment.js andhammer.js excluded. The generated bundle can be minified with uglifyjs:
uglifyjs dist/vis-custom.js -o dist/vis-custom.min.js
The custom bundle can now be loaded as:
<!DOCTYPE HTML><html><head><!-- load external dependencies --><scriptsrc="http://cdnjs.cloudflare.com/ajax/libs/moment.js/2.17.1/moment.min.js"></script><scriptsrc="http://cdnjs.cloudflare.com/ajax/libs/hammer.js/2.0.8/hammer.min.js"></script><!-- load vis.js --><scriptsrc="dist/vis-custom.min.js"></script><linkhref="dist/vis.min.css"rel="stylesheet"type="text/css"/></head><body> ...</body></html>
When writing a web application with commonjs modules, vis.js can be packaged automatically into the application. Create a fileapp.js containing:
varmoment=require('moment');varDataSet=require('vis/lib/DataSet');varTimeline=require('vis/lib/timeline/Timeline');varcontainer=document.getElementById('visualization');vardata=newDataSet([{id:1,content:'item 1',start:moment('2013-04-20')},{id:2,content:'item 2',start:moment('2013-04-14')},{id:3,content:'item 3',start:moment('2013-04-18')},{id:4,content:'item 4',start:moment('2013-04-16'),end:moment('2013-04-19')},{id:5,content:'item 5',start:moment('2013-04-25')},{id:6,content:'item 6',start:moment('2013-04-27')}]);varoptions={};vartimeline=newTimeline(container,data,options);
The application can be bundled and minified:
browserify app.js -o dist/app-bundle.js -t babelifyuglifyjs dist/app-bundle.js -o dist/app-bundle.min.js
And loaded into a webpage:
<!DOCTYPE HTML><html><head><linkhref="node_modules/vis/dist/vis.min.css"rel="stylesheet"type="text/css"/></head><body><divid="visualization"></div><scriptsrc="dist/app-bundle.min.js"></script></body></html>
You can integrate e.g. the timeline component directly in you webpack build.Therefor you can e.g. import the component-files from root direcory (starting with "index-").
import{DataSet,Timeline}from'vis/index-timeline-graph2d';varcontainer=document.getElementById('visualization');vardata=newDataSet();vartimeline=newTimeline(container,data,{});
To get this to work you'll need to add some babel-loader-setting to your webpack-config:
module:{module:{rules:[{test:/node_modules[\\\/]vis[\\\/].*\.js$/,loader:'babel-loader',query:{cacheDirectory:true,presets:["babel-preset-es2015"].map(require.resolve),plugins:["transform-es3-property-literals",// #2452"transform-es3-member-expression-literals",// #2566"transform-runtime"// #2566]}}]}}
There is also andemo-project showing the integration of vis.js using webpack.
To test the library, install the project dependencies once:
npm install
Then run the tests:
npm runtestCopyright (C) 2010-2017 Almende B.V. and Contributors
Vis.js is dual licensed under both
and
Vis.js may be distributed under either license.