https://github.com/ivis-at-bilkent/cytoscape.js-chola

Orthogonal layout for graphs with compound nodes

https://github.com/ivis-at-bilkent/cytoscape.js-chola

Repository

Orthogonal layout for graphs with compound nodes

https://github.com/iVis-at-Bilkent/cytoscape.js-chola/blob/unstable/

cytoscape-chola
================================================================================


## Description

Othogonal layout extension for Cytoscape.js ([demo](https://raw.githack.com/iVis-at-Bilkent/cytoscape.js-chola/unstable/demo-compound.html))

## Dependencies

 * Cytoscape.js ^3.2.0
 * 


## Usage instructions

Download the library:
 * via npm: `npm install cytoscape-chola`,
 * via bower: `bower install cytoscape-chola`, or
 * via direct download in the repository (probably from a tag).

Import the library as appropriate for your project:

ES import:

```js
import cytoscape from 'cytoscape';
import chola from 'cytoscape-chola';

cytoscape.use( chola );
```

CommonJS require:

```js
let cytoscape = require('cytoscape');
let chola = require('cytoscape-chola');

cytoscape.use( chola ); // register extension
```

AMD:

```js
require(['cytoscape', 'cytoscape-chola'], function( cytoscape, chola ){
  chola( cytoscape ); // register extension
});
```

Plain HTML/JS has the extension registered for you automatically, because no `require()` is needed.


## API

TODO describe the API of the extension here.


## Build targets

* `npm run test` : Run Mocha tests in `./test`
* `npm run build` : Build `./src/**` into `cytoscape-chola.js`
* `npm run watch` : Automatically build on changes with live reloading (N.b. you must already have an HTTP server running)
* `npm run dev` : Automatically build on changes with live reloading with webpack dev server
* `npm run lint` : Run eslint on the source

N.b. all builds use babel, so modern ES features can be used in the `src`.


## Publishing instructions

This project is set up to automatically be published to npm and bower.  To publish:

1. Build the extension : `npm run build:release`
1. Commit the build : `git commit -am "Build for release"`
1. Bump the version number and tag: `npm version major|minor|patch`
1. Push to origin: `git push && git push --tags`
1. Publish to npm: `npm publish .`
1. If publishing to bower for the first time, you'll need to run `bower register cytoscape-chola https://github.com/iVis-at-Bilkent/cytoscape-chola.git`
1. [Make a new release](https://github.com/iVis-at-Bilkent/cytoscape-chola/releases/new) for Zenodo.

Owner

GitHub Events