# webcola

> WebCola =======

Latest version **3.4.0** (published 2019-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install webcola
pnpm add webcola
yarn add webcola
bun add webcola
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.4.0 |
| Published | 2019-05-10 |
| First published | 2014-12-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2097 |
| Author | Tim Dwyer |
| Maintainers | jkschneider, tgdwyer |
| Keywords | Graph, Layout, Constraints, Optimization |

## Links

- npm: https://www.npmjs.com/package/webcola
- Repository: https://github.com/tgdwyer/WebCola
- Issues: https://github.com/tgdwyer/WebCola/issues
- npm.io page: https://npm.io/package/webcola

## Dependencies (4)

- [d3-drag](https://npm.io/package/d3-drag.md) ^1.0.4
- [d3-shape](https://npm.io/package/d3-shape.md) ^1.3.5
- [d3-timer](https://npm.io/package/d3-timer.md) ^1.0.5
- [d3-dispatch](https://npm.io/package/d3-dispatch.md) ^1.0.3

## Alternatives

- [apollo-link-http-common](https://npm.io/package/apollo-link-http-common.md) — 879.0K weekly downloads
- [react-relay](https://npm.io/package/react-relay.md) — 336.8K weekly downloads
- [relay-test-utils](https://npm.io/package/relay-test-utils.md) — 181.6K weekly downloads
- [@vendure/core](https://npm.io/package/@vendure/core.md) — 14.8K weekly downloads
- [@pnpm/deps.graph-sequencer](https://npm.io/package/@pnpm/deps.graph-sequencer.md) — 13.4K weekly downloads

## Recent versions

- 3.4.0 (latest) — 2019-05-10
- 3.3.9 — 2019-03-12
- 3.3.8 — 2018-02-01
- 3.3.7 — 2018-01-22
- 3.3.6 — 2017-07-11
- 3.3.5 — 2017-05-17
- 3.3.4 — 2017-05-04
- 3.3.3 — 2017-02-27
- 3.3.2 — 2017-02-16
- 3.3.1 — 2017-02-16
- 3.3.0 — 2016-12-09
- 3.2.0 — 2016-12-07
- 3.1.3 — 2015-11-24
- 3.1.2 — 2015-08-20
- 0.1.1 — 2014-12-04
- … 1 more at https://npm.io/package/webcola/versions

## README

WebCola [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
=======

JavaScript constraint based layout for high-quality graph visualization and exploration 
using D3.js and other web-based graphics libraries.

<p align="center">
  <a href="http://marvl.infotech.monash.edu/webcola/examples/smallworldwithgroups.html">
    <img width="400" alt="Graph with simple groups" src="WebCola/examples/smallworldwithgroups.png" />
  </a>
  <a href="http://marvl.infotech.monash.edu/webcola/examples/alignment.html">
    <img width="400" alt="Graph with alignment constraints" src="WebCola/examples/alignment.png" />
  </a>
</p>

[Homepage with code and more examples](http://marvl.infotech.monash.edu/webcola)

Note: While D3 adaptor supports both D3 v3 and D3 v4, WebCoLa's interface is styled like D3 v3. Follow the setup in our homepage for more details.

Installation
------------

#### Browser:

    <!-- Minified version -->
    <script src="http://marvl.infotech.monash.edu/webcola/cola.min.js"></script>
    <!-- Full version -->
    <script src="http://marvl.infotech.monash.edu/webcola/cola.js"></script>

These files can also be accessed from [GitHub](WebCola/cola.js) ([minified](WebCola/cola.min.js)).

#### Npm:
	
	npm install webcola --save

You can also install it through npm by first adding it to `package.json`:

    "dependencies": {
      "webcola": "latest"
    }
Then by running `npm install`.

#### Bower:

	bower install webcola --save

If you use TypeScript, you can get complete TypeScript definitions by installing [tsd 0.6](https://github.com/DefinitelyTyped/tsd) and running `tsd link`.

Building
--------

*Linux/Mac/Windows Command Line:*

 - install [node.js](http://nodejs.org)
 - install grunt from the command line using npm (comes with node.js):

        npm install -g grunt-cli

 - from the WebCola directory:

        npm install

 - build, minify and test:

        grunt

This creates the `cola.js` and `cola.min.js` files in the `WebCola` directory, generates `index.js` for npm, and runs tests.

*Visual Studio:*

 - get the [typescript plugin](http://www.typescriptlang.org/#Download)
 - open webcola.sln

Running
-------

*Linux/Mac/Windows Command Line:*

Install the Node.js http-server module:

    npm install -g http-server

After installing http-server, we can serve out the example content in the WebCola directory.

    http-server WebCola

The default configuration of http-server will serve the exampes on [http://localhost:8080](http://localhost:8080).

---
_Source: https://npm.io/package/webcola · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._