jrtechs
/
jrtechs-vis
mirror of https://github.com/jrtechs/vis.git

vis.js==================
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:
- 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 a graph of network 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.  Filter, order, and cast items.
The vis.js library is developed by [Almende B.V](http://almende.com).

## 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](https://github.com/almende/vis.git).

## Load


To use a component, include the javascript file of vis in your web page:
```html<!DOCTYPE HTML><html><head>    <script src="components/vis/vis.js"></script></head><body>    <script type="text/javascript">        // ... load a visualization    </script></body></html>```
or load vis.js using require.js:
```jsrequire.config({    paths: {        vis: 'path/to/vis',    }});require(['vis'], function (math) {    // ... load a visualization});```

A timeline can be instantiated as:
```jsvar 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 thecomponent.

## Example

A basic example on loading a Timeline is shown below. More examples can befound in the [examples directory](https://github.com/almende/vis/tree/master/examples)of the project.
```html<!DOCTYPE HTML><html><head>    <title>Timeline basic demo</title>    <script src="components/vis/vis.js"></script>
    <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](https://github.com/mde/jake) as build tool.The build script uses [Browserify](http://browserify.org/) tobundle the source code into a library,and uses [UglifyJS](http://lisperator.net/uglifyjs/) to minify the code.The source code uses the module style of node (require and module.exports) toorganize dependencies.
To install all dependencies and build the library, run `npm install` in theroot of the project.
    cd vis    npm install
To be able to run jake from the command line, jake must be installed globally:
    sudo npm install -g jake
Then, the project can be build by executing jake in the root of the project:
    jake

## License

Copyright (C) 2010-2013 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, softwaredistributed 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 andlimitations under the License.