kinimesi / cytoscape-svg

A Cytoscape.js extension to export the current graph view as an SVG.
https://kinimesi.github.io/cytoscape-svg
GNU General Public License v3.0
35 stars 5 forks source link
cytoscapejs cytoscapejs-extension svg

cytoscape-svg

Description

Export the current graph view as an SVG image. (demo)

The exported SVG can be saved as a PDF with svg2pdf.js libary. See an example in demo.html

Dependencies

Usage instructions

Download the library:

Import the library as appropriate for your project:

ES import:

import cytoscape from 'cytoscape';
import svg from 'cytoscape-svg';

cytoscape.use( svg );

CommonJS require:

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

cytoscape.use( svg ); // register extension

AMD:

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

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

API

cy.svg(options)

Build targets

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-svg https://github.com/kinimesi/cytoscape-svg.git
  7. Make a new release for Zenodo.