cytoscape.js-cise
Description
CiSE(Circular Spring Embedder) is an algorithm based on the traditional force-directed layout scheme with extensions to move and rotate nodes in the same cluster as a group. Further local improvements may be obtained by flipping clusters and by swapping neighboring node pairs in the same cluster, reducing the edge crossing number.
The algorithm is implemented as a Cytoscape.js extension by i-Vis Lab in Bilkent University (demo)
Please cite the following when using this layout:
M. Belviranli, A. Dilek and U. Dogrusoz, "CiSE: A Circular Spring Embedder Layout Algorithm" in IEEE Transactions on Visualization & Computer Graphics, vol. 19, no. 06, pp. 953-966, 2013.
A detailed illustration of CiSE can also be found here.
Dependencies
- Cytoscape.js: ^3.2.0
- avsdf-base: ^1.0.0
- cose-base: ^1.0.0
Usage instructions
Download the library:
- via npm:
npm install cytoscape-cise
, - via bower:
bower install cytoscape-cise
, or - via direct download in the repository (probably from a tag).
Import the library as appropriate for your project:
ES import:
import cytoscape from 'cytoscape';
import cise from 'cytoscape-cise';
cytoscape.use( cise );
CommonJS require:
let cytoscape = require('cytoscape');
let cise = require('cytoscape-cise');
cytoscape.use( cise );
AMD:
require(['cytoscape', 'cytoscape-cise'], function( cytoscape, cise ){
cise( cytoscape );
});
Plain HTML/JS has the extension registered for you automatically, because no require()
is needed.
API
The following options are supported when calling the layout, e.g,
cy.layout({ name: 'cise', clusters: clusterInfo, ... }):
var default = {
name = 'cise',
clusters: clusterInfo,
animate: false,
refresh: 10,
animationDuration: undefined,
animationEasing: undefined,
fit: true,
padding: 30,
nodeSeparation: 12.5,
idealInterClusterEdgeLengthCoefficient: 1.4,
allowNodesInsideCircle: false,
maxRatioOfNodesInsideCircle: 0.1,
springCoeff: 0.45,
nodeRepulsion: 4500,
gravity: 0.25,
gravityRange: 3.8,
ready: function(){},
stop: function(){},
}
Build targets
npm run test
: Run Mocha tests in ./test
npm run build
: Build ./src/**
into cytoscape-cise.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 servernpm 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:
- Build the extension :
npm run build:release
- Commit the build :
git commit -am "Build for release"
- Bump the version number and tag:
npm version major|minor|patch
- Push to origin:
git push && git push --tags
- Publish to npm:
npm publish .
- If publishing to bower for the first time, you'll need to run
bower register cytoscape-cise https://github.com/iVis-at-Bilkent/cytoscape.js-cise.git
- Make a new release for Zenodo.
Team