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.

323 lines
8.7 KiB

11 years ago
11 years ago
11 years ago
11 years ago
9 years ago
  1. vis.js
  2. ==================
  3. <a href="https://github.com/almende/vis/issues/1781" target="_blank">
  4. <img align="right" src="https://raw.githubusercontent.com/almende/vis/master/misc/we_need_help.png">
  5. </a>
  6. Vis.js is a dynamic, browser based visualization library.
  7. The library is designed to be easy to use, handle large amounts
  8. of dynamic data, and enable manipulation of the data.
  9. The library consists of the following components:
  10. - DataSet and DataView. A flexible key/value based data set. Add, update, and
  11. remove items. Subscribe on changes in the data set. A DataSet can filter and
  12. order items, and convert fields of items.
  13. - DataView. A filtered and/or formatted view on a DataSet.
  14. - Graph2d. Plot data on a timeline with lines or barcharts.
  15. - Graph3d. Display data in a three dimensional graph.
  16. - Network. Display a network (force directed graph) with nodes and edges.
  17. - Timeline. Display different types of data on a timeline.
  18. The vis.js library is developed by [Almende B.V](http://almende.com).
  19. ## Install
  20. Install via npm:
  21. $ npm install vis
  22. Install via bower:
  23. $ bower install vis
  24. Link via cdnjs: http://cdnjs.com
  25. Or download the library from the github project:
  26. [https://github.com/almende/vis.git](https://github.com/almende/vis.git).
  27. ## Load
  28. To use a component, include the javascript and css files of vis in your web page:
  29. ```html
  30. <!DOCTYPE HTML>
  31. <html>
  32. <head>
  33. <script src="components/vis/dist/vis.js"></script>
  34. <link href="components/vis/dist/vis.css" rel="stylesheet" type="text/css" />
  35. </head>
  36. <body>
  37. <script type="text/javascript">
  38. // ... load a visualization
  39. </script>
  40. </body>
  41. </html>
  42. ```
  43. or load vis.js using require.js. Note that vis.css must be loaded too.
  44. ```js
  45. require.config({
  46. paths: {
  47. vis: 'path/to/vis/dist',
  48. }
  49. });
  50. require(['vis'], function (math) {
  51. // ... load a visualization
  52. });
  53. ```
  54. A timeline can be instantiated as:
  55. ```js
  56. var timeline = new vis.Timeline(container, data, options);
  57. ```
  58. Where `container` is an HTML element, `data` is an Array with data or a DataSet,
  59. and `options` is an optional object with configuration options for the
  60. component.
  61. ## Example
  62. A basic example on loading a Timeline is shown below. More examples can be
  63. found in the [examples directory](https://github.com/almende/vis/tree/master/examples)
  64. of the project.
  65. ```html
  66. <!DOCTYPE HTML>
  67. <html>
  68. <head>
  69. <title>Timeline basic demo</title>
  70. <script src="vis/dist/vis.js"></script>
  71. <link href="vis/dist/vis.css" rel="stylesheet" type="text/css" />
  72. <style type="text/css">
  73. body, html {
  74. font-family: sans-serif;
  75. }
  76. </style>
  77. </head>
  78. <body>
  79. <div id="visualization"></div>
  80. <script type="text/javascript">
  81. var container = document.getElementById('visualization');
  82. var data = [
  83. {id: 1, content: 'item 1', start: '2013-04-20'},
  84. {id: 2, content: 'item 2', start: '2013-04-14'},
  85. {id: 3, content: 'item 3', start: '2013-04-18'},
  86. {id: 4, content: 'item 4', start: '2013-04-16', end: '2013-04-19'},
  87. {id: 5, content: 'item 5', start: '2013-04-25'},
  88. {id: 6, content: 'item 6', start: '2013-04-27'}
  89. ];
  90. var options = {};
  91. var timeline = new vis.Timeline(container, data, options);
  92. </script>
  93. </body>
  94. </html>
  95. ```
  96. ## Build
  97. To build the library from source, clone the project from github
  98. $ git clone git://github.com/almende/vis.git
  99. The source code uses the module style of node (require and module.exports) to
  100. organize dependencies. To install all dependencies and build the library,
  101. run `npm install` in the root of the project.
  102. $ cd vis
  103. $ npm install
  104. Then, the project can be build running:
  105. $ npm run build
  106. To automatically rebuild on changes in the source files, once can use
  107. $ npm run watch
  108. This will both build and minify the library on changes. Minifying is relatively
  109. slow, so when only the non-minified library is needed, one can use the
  110. `watch-dev` script instead:
  111. $ npm run watch-dev
  112. ## Custom builds
  113. 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.
  114. The source code of vis.js consists of commonjs modules, which makes it possible to create custom bundles using tools like [Browserify](http://browserify.org/) or [Webpack](http://webpack.github.io/). This can be bundling just one visualization like the Timeline, or bundling vis.js as part of your own browserified web application.
  115. *Note that hammer.js version 2 is required as of v4.*
  116. #### Prerequisites
  117. Before you can do a build:
  118. - Install node.js and npm on your system: https://nodejs.org/
  119. - Install the following modules using npm: `browserify`, `babelify`, and `uglify-js`:
  120. ```
  121. $ [sudo] npm install -g browserify babelify uglify-js
  122. ```
  123. - Download or clone the vis.js project:
  124. ```
  125. $ git clone https://github.com/almende/vis.git
  126. ```
  127. - Install the dependencies of vis.js by running `npm install` in the root of the project:
  128. ```
  129. $ cd vis
  130. $ npm install
  131. ```
  132. #### Example 1: Bundle a single visualization
  133. 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:
  134. ```js
  135. exports.DataSet = require('./lib/DataSet');
  136. exports.Timeline = require('./lib/timeline/Timeline');
  137. ```
  138. Then create a custom bundle using browserify, like:
  139. $ browserify custom.js -t babelify -o vis-custom.js -s vis
  140. This will generate a custom bundle *vis-custom.js*, which exposes the namespace `vis` containing only `DataSet` and `Timeline`. The generated bundle can be minified using uglifyjs:
  141. $ uglifyjs vis-custom.js -o vis-custom.min.js
  142. The custom bundle can now be loaded like:
  143. ```html
  144. <!DOCTYPE HTML>
  145. <html>
  146. <head>
  147. <script src="vis-custom.min.js"></script>
  148. <link href="dist/vis.min.css" rel="stylesheet" type="text/css" />
  149. </head>
  150. <body>
  151. ...
  152. </body>
  153. </html>
  154. ```
  155. #### Example 2: Exclude external libraries
  156. 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:
  157. $ browserify index.js -t babelify -o vis-custom.js -s vis -x moment -x hammerjs
  158. This will generate a custom bundle *vis-custom.js*, which exposes the namespace `vis`, and has moment and hammerjs excluded. The generated bundle can be minified with uglifyjs:
  159. $ uglifyjs vis-custom.js -o vis-custom.min.js
  160. The custom bundle can now be loaded as:
  161. ```html
  162. <!DOCTYPE HTML>
  163. <html>
  164. <head>
  165. <!-- load external dependencies -->
  166. <script src="http://cdnjs.cloudflare.com/ajax/libs/moment.js/2.7.0/moment.min.js"></script>
  167. <script src="http://cdnjs.cloudflare.com/ajax/libs/hammer.js/1.1.3/hammer.min.js"></script>
  168. <!-- load vis.js -->
  169. <script src="vis-custom.min.js"></script>
  170. <link href="dist/vis.min.css" rel="stylesheet" type="text/css" />
  171. </head>
  172. <body>
  173. ...
  174. </body>
  175. </html>
  176. ```
  177. #### Example 3: Bundle vis.js as part of your (commonjs) application
  178. When writing a web application with commonjs modules, vis.js can be packaged automatically into the application. Create a file **app.js** containing:
  179. ```js
  180. var moment = require('moment');
  181. var DataSet = require('vis/lib/DataSet');
  182. var Timeline = require('vis/lib/timeline/Timeline');
  183. var container = document.getElementById('visualization');
  184. var data = new DataSet([
  185. {id: 1, content: 'item 1', start: moment('2013-04-20')},
  186. {id: 2, content: 'item 2', start: moment('2013-04-14')},
  187. {id: 3, content: 'item 3', start: moment('2013-04-18')},
  188. {id: 4, content: 'item 4', start: moment('2013-04-16'), end: moment('2013-04-19')},
  189. {id: 5, content: 'item 5', start: moment('2013-04-25')},
  190. {id: 6, content: 'item 6', start: moment('2013-04-27')}
  191. ]);
  192. var options = {};
  193. var timeline = new Timeline(container, data, options);
  194. ```
  195. Install the application dependencies via npm:
  196. $ npm install vis moment
  197. The application can be bundled and minified:
  198. $ browserify app.js -o app-bundle.js -t babelify
  199. $ uglifyjs app-bundle.js -o app-bundle.min.js
  200. And loaded into a webpage:
  201. ```html
  202. <!DOCTYPE HTML>
  203. <html>
  204. <head>
  205. <link href="node_modules/vis/dist/vis.min.css" rel="stylesheet" type="text/css" />
  206. </head>
  207. <body>
  208. <div id="visualization"></div>
  209. <script src="app-bundle.min.js"></script>
  210. </body>
  211. </html>
  212. ```
  213. ## Test
  214. To test the library, install the project dependencies once:
  215. $ npm install
  216. Then run the tests:
  217. $ npm test
  218. ## License
  219. Copyright (C) 2010-2015 Almende B.V.
  220. Vis.js is dual licensed under both
  221. * The Apache 2.0 License
  222. http://www.apache.org/licenses/LICENSE-2.0
  223. and
  224. * The MIT License
  225. http://opensource.org/licenses/MIT
  226. Vis.js may be distributed under either license.