iVis-at-Bilkent/cytoscape.js-synched

Name: cytoscape.js-synched

Owner: iVis-at-Bilkent

Description: null

Created: 2018-04-10 12:44:50.0

Updated: 2018-04-19 11:04:18.0

Pushed: 2018-04-19 11:08:46.0

Homepage: null

Size: 13737

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

cytoscape-synched

Description

Synchronized layout (demo)

Dependencies

• Cytoscape.js ^3.2.0

Usage instructions

Download the library:

• via npm: npm install cytoscape-synched,
• via bower: bower install cytoscape-synched, or
• via direct download in the repository (probably from a tag).

Import the library as appropriate for your project:

ES import:

rt cytoscape from 'cytoscape';
rt synchedLayout from 'cytoscape-synched';

scape.use( synchedLayout );

CommonJS require:

cytoscape = require('cytoscape');
synchedLayout = require('cytoscape-synched');

scape.use( synchedLayout ); // register extension

AMD:

ire(['cytoscape', 'cytoscape-synched'], function( cytoscape, synchedLayout ){
nchedLayout( cytoscape ); // register extension

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

API

• let api = cy.synchedLayout('get'): get the extension instance
• api.applyMergedLayout(cy, cy2): apply merged layout
• api.applyUnnamedLayout(cy, cy2): apply unnamed layout

Build targets

• npm run build : Build ./src/** into cytoscape-synched.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-synched https://github.com/iVis-at-Bilkent/cytoscape.js-synched.git
7. Make a new release for Zenodo.