cytoscape-elk
Description
The elk layout algorithm adapter for Cytoscape.js (demo)
This discrete layout creates good results for most graphs and it supports compound nodes.
Dependencies
- Cytoscape.js ^3.2.0
- elkjs ^0.3.0
Usage instructions
Download the library:
- via npm:
npm install cytoscape-elk
, - via bower:
bower install cytoscape-elk
, or - via direct download in the repository (probably from a tag).
Import the library as appropriate for your project:
ES import:
;; cytoscape;
CommonJS require:
let cytoscape = ;let elk = ; cytoscape; // register extension
AMD:
;
Plain HTML/JS has the extension registered for you automatically, because no require()
is needed.
API
var options = nodeDimensionsIncludeLabels: false // Boolean which changes whether label dimensions are included when calculating node dimensions fit: true // Whether to fit padding: 20 // Padding on fit animate: false // Whether to transition the node positions { return true; } // Whether to animate specific nodes when animation is on; non-animated nodes immediately go to their final positions animationDuration: 500 // Duration of animation in ms if enabled animationEasing: undefined // Easing of animation if enabled { return pos; } // A function that applies a transform to the final node position ready: undefined // Callback on layoutready stop: undefined // Callback on layoutstop elk: // All options are available at http://www.eclipse.org/elk/reference.html // 'org.eclipse.elk.' can be dropped from the Identifier // Or look at demo.html for an example. // Enums use the name of the enum e.g. // 'searchOrder': 'DFS' { return null; } // Edges with a non-nil value are skipped when geedy edge cycle breaking is enabled; cy;
Build targets
npm run test
: Run Mocha tests in./test
npm run build
: Build./src/**
intocytoscape-elk.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-elk https://github.com/jfstephe/cytoscape.js-elk.git