Socket
Socket
Sign inDemoInstall

cytoscape-svg

Package Overview
Dependencies
1
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    cytoscape-svg

Export the current graph view as a SVG.


Version published
Weekly downloads
707
decreased by-36.93%
Maintainers
1
Install size
66.8 kB
Created
Weekly downloads
 

Readme

Source

cytoscape-svg

Description

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

Dependencies

  • Cytoscape.js ^3.2.0
  • canvas2svg

Usage instructions

Download the library:

  • via npm: npm install cytoscape-svg,
  • via bower: bower install cytoscape-svg, 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 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)
  • options: the export options
    • full: Whether to export the current viewport view (false, default) or the entire graph (true).
    • scale: This value specifies a positive number that scales the size of the resultant image.
    • bg: The background color of the SVG (transparent by default).

Build targets

  • npm run test : Run Mocha tests in ./test
  • npm run build : Build ./src/** into cytoscape-svg.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-svg https://github.com/kinimesi/cytoscape-svg.git
  7. Make a new release for Zenodo.

Keywords

FAQs

Last updated on 25 May 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc