Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 2.36 KB

README.md

File metadata and controls

79 lines (52 loc) · 2.36 KB
Raw

cytoscape-layvo

Description

Layout quality evaluation tool (demo)

Dependencies

  • Cytoscape.js ^3.2.0

Usage instructions

Download the library:

  • via npm: npm install cytoscape-layvo,
  • via bower: bower install cytoscape-layvo, 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 layvo from 'cytoscape-layvo';

cytoscape.use( layvo );

CommonJS require:

let cytoscape = require('cytoscape');
let layvo = require('cytoscape-layvo');

cytoscape.use( layvo ); // register extension

AMD:

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

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

API

  • let api = cy.layvo('get'): get the extension instance
  • api.generalProperties(): get general layout metrics
  • api.generalProperties(nodes, edges): get general layout metrics for the given array of nodes and edges
  • api.differenceMetrics(cy, cy2): get synchronized layout similarity metrics

Build targets

  • npm run test : Run Mocha tests in ./test
  • npm run build : Build ./src/** into cytoscape-layvo.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
  2. Commit the build : git commit -am "Build for release"
  3. Bump the version number and tag: npm version major|minor|patch
  4. Push to origin: git push && git push --tags
  5. Publish to npm: npm publish .
  6. If publishing to bower for the first time, you'll need to run bower register cytoscape-layvo https://github.com/iVis-at-Bilkent/cytoscape-layvo.git
  7. Make a new release for Zenodo.