visjs-network

A dynamic, browser-based network visualization library. A network-visualization focused fork of the visualization library vis.js

See this github issue comment for some project history.


visjs-network is designed to be easy to use, handle dynamic data, and enable data manipulation.
The library consists of the following components:

- Network. Display a network (force directed graph) with nodes and edges.
- 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.

The vis.js library was originally developed by Dutch R&D Company Almende B.V.

Install

Install via yarn:

yarn add visjs-network

Install via npm:

npm install visjs-network

Install via bower:

bower install visjs-network

Or download the library from the github project:
https://github.com/visjs-community/visjs-network.git.

Load

To use a component, include the javascript and css files of vis in your web page:

``html










`

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

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

Example

Examples can be
found in the examples directory
of the project.

Build

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

git clone git://github.com/visjs-community/visjs-network.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 yarn or npm install in the root of the project.

cd vis
yarn

Then, the project can be built by running:

yarn build

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

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

yarn watch-dev

Custom builds

The folder dist contains bundled versions of vis.js for direct use in the browser. These bundles contain all the visualizations and include external dependencies such as _hammer.js_ and _moment.js_.

The source code of vis.js consists of commonjs modules, which makes it possible to create custom bundles using tools like Browserify or Webpack. 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._

$3

Before you can do a custom build:

- Install _node.js_ and _npm_ on your system: https://nodejs.org/
- Install _yarn_ on your system: https://yarnpkg.com/en/
- Install the following modules globally using yarn: browserify, babelify, and uglify-js:

`
yarn global add browserify babelify uglify-js
`

- Download or clone the vis.js project:

`
git clone https://github.com/visjs-community/visjs-network.git
`

- Install the dependencies of vis.js by running yarn or npm install in the root of the project:

`
cd vis
npm install
`

$3

#### Example 1: Bundle only a single visualization type

For example, to create a bundle with just the Timeline and DataSet, create an index file named custom.js in the root of the project, containing:

`js
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 [env] ] -o dist/vis-custom.js -s vis

This will generate a custom bundle _vis-custom.js_, which exposes the namespace vis containing only DataSet and Timeline. You can pass additional options to babelify and browserify as needed (e.g. to customise the browsers that are supported).

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:

`html







...


`

#### Example 2: Exclude external libraries

The default bundle vis.js is standalone and includes external dependencies such as _hammer.js_ and _moment.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 excluding _moment.js_ and _hammer.js_, run browserify in the root of the project:

browserify index.js -t [ babelify --presets [env] ] -o dist/vis-custom.js -s vis -x moment -x hammerjs

This will generate a custom bundle _vis-custom.js_, which exposes the namespace vis, and has _moment.js_ and _hammer.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:

`html












...


`

#### Example 3: Bundle vis.js as part of your (commonjs) application

When writing a web application with commonjs modules, vis.js can be packaged automatically into the application. Create a file app.js containing:

`js
var moment = require('moment')
var DataSet = require('vis/lib/DataSet')
var Timeline = require('vis/lib/timeline/Timeline')

var container = document.getElementById('visualization')
var data = new DataSet([
{ 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') }
])
var options = {}
var timeline = new Timeline(container, data, options)
`

The application can be bundled and minified:

browserify app.js -o dist/app-bundle.js -t babelify
uglifyjs dist/app-bundle.js -o dist/app-bundle.min.js

And loaded into a webpage:

`html

`

#### Example 4: Integrate vis.js components directly in your webpack build

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-").

TODO: add analogous Network example

`js
import { DataSet, Timeline } from 'vis/index-timeline-graph2d'

var container = document.getElementById('visualization')
var data = new DataSet()
var timeline = new Timeline(container, data, {})
`

To get this to work you'll need to add some babel-loader-setting to your webpack-config:

`js
module: {
module: {
rules: [{
test: /node_modules[\\\/]vis[\\\/].*\.js$/,
loader: 'babel-loader',
query: {
cacheDirectory: true,
presets: [ "babel-preset-env" ].map(require.resolve),
plugins: [
"transform-es3-property-literals", // #2452
"transform-es3-member-expression-literals", // #2566
"transform-runtime" // #2566
]
}
}]
}
}
``

There is also an demo-project showing the integration of vis.js using webpack.

Test

To test the library, install the project dependencies once:

yarn

Then run the tests:

yarn test

Contribute

Contributions to the vis.js library are very welcome!

$3

This project exists thanks to all the people who already contributed.

License

Copyright (C) 2010-2018 Almende B.V. and Contributors

Vis.js is dual licensed under both

- The Apache 2.0 License
http://www.apache.org/licenses/LICENSE-2.0

and

- The MIT License
http://opensource.org/licenses/MIT

Vis.js may be distributed under either license.