Introduction
Explore graph modelling, analysis and interactive visualisation.
Cytoscape.js lets you model, analyse and display networks. Nodes represent things, edges connect them, and application data describes their attributes. Use graph algorithms to find paths and groups, then layouts and styles to make the relationships visible.
A graph instance is the core, usually named cy. Methods such as
cy.nodes() return collections: ordered sets of element handles. A single element is also a
collection, so the same methods work on one element or many. Begin with
Getting started, then read
Notation & glossary for graph concepts, coordinates and data.
#Factsheet
| At a glance | Cytoscape.js |
|---|---|
| Purpose | Graph modelling, analysis and interactive visualisation. |
| Data model | Nodes, directed edges, loops, parallel edges and compound containment. |
| Analysis | Traversal, set operations and algorithms from breadth-first search to PageRank. |
| Display | Layouts, declarative styles, animation, and desktop/touch interaction. |
| Execution | Browser rendering, or headless graph work without a canvas. |
| Language and types | JavaScript package with TypeScript declarations. |
| License | MIT, including commercial use under its terms. |
These pages describe the preview. Its package version is
4.0.0-unstable; see Releases for published distributions and
Supported environments for runtime requirements.
Graph reads and writes are synchronous; methods returning promises explain
when to await completion.
#Who uses Cytoscape.js
The project's adopter list includes Amazon, Google and Microsoft, research resources such as GeneMANIA and Pathway Commons, and libraries such as Mermaid. It documents the wider Cytoscape.js ecosystem. Browse that list for more examples across industry, research, government and open-source software, or share your use case.
#About
Cytoscape.js is an open-source network library for application developers and researchers. It combines a graph model and analysis API with optional interactive rendering. Use it in a browser interface, on a server, or in a headless analysis task.
The project originated at the Donnelly Centre, University of Toronto, as reported in the original publication. Development is collaborative: the GitHub repository contains source, issues, discussions and contribution guidance.
#Packages
The published package is cytoscape on npm. Use Getting started to choose a version and install it. The entries documented in this preview are:
| Entry | Use it for |
|---|---|
cytoscape |
Interactive browser graphs, with rendering and pointer gestures. |
cytoscape/headless |
Graph queries, CPU algorithms and layouts without a canvas. |
cytoscape/headless-gpu |
Headless work with GPU algorithms or GPU force layouts. |
The entries share a graph API, with capabilities appropriate to each build. Check Supported environments before choosing a renderer or GPU executor.
#Releases
Find published versions and release notes in GitHub releases, and package distribution tags on npm. Use documentation matching the version installed in your application. These pages document an unreleased preview. See Migration for changes from earlier releases and archived documentation.
#Citation
When publishing work that uses Cytoscape.js, cite Franz et al. (2016), Bioinformatics 32(2), 309–311, doi:10.1093/bioinformatics/btv557. Record the software version used so the analysis can be reproduced. The project's Zenodo record provides version-specific software citations where available.
#Publications
- Cytoscape.js: a graph theory library for visualisation and analysis — Franz et al., Bioinformatics (2016), the original library paper.
- Cytoscape.js 2023 update: a graph theory library for visualization and analysis — Franz et al., Bioinformatics 39(1), btad031 (2023), describing enhancements introduced from 2015 to 2022.
These papers describe the project's published history. Use this reference and its migration notes for the preview's current API contracts.
#Funding
Cytoscape.js has received NIH support, including through the National Resource for Network Biology (NRNB). The original paper's funding acknowledgements list P41 GM103504, R01 GM070743 and U41 HG006623. These are historical acknowledgements; current project support and participation information is available through NRNB and the Cytoscape Consortium.
#Cytoscape Consortium
The Cytoscape Consortium is an independent not-for-profit organisation supporting open software and public resources for biological networks. Cytoscape.js is part of the broader Cytoscape community, alongside the Cytoscape platform. Visit the consortium for its mission, participating projects and support information.
#License
Cytoscape.js is distributed under the MIT license. It permits use, modification and redistribution, including in commercial applications, subject to its notice requirements. The software is provided without warranty. Consult the license shipped with the version you use; separately installed extensions and other packages have their own licenses.
#Guides
- Notation & glossary
- Getting started
- Task recipes
- Core
- Initialisation and lifecycle
- Graph manipulation
- Accessing elements
- Data and scratch
- Metadata and environment
- Events
- Viewport manipulation
- Interaction controls
- Emphasis
- Animation
- Layout
- Style and legends
- Export and snapshots
- Independent views
- Collection
- Metadata and identity
- Iteration and aggregation
- Comparison
- Building and filtering
- Data and scratch
- Graph manipulation
- Position and dimensions
- Edge points
- Selection
- Grab, lock and pannability
- Visibility and emphasis
- Style
- Events
- Animation
- Layout
- Traversing
- Compound nodes
- Algorithms
- Queries
- Style
- Events
- Layouts
- Animations
- Extensions
- Performance
- Feature availability
- Migration