Skip to content

Repository files navigation

Pages Status Tests Status Last Commit License Docs

npm version bundle size jsDelivr hits DOI

CGView.js is a Circular Genome Viewing tool for visualizing and interacting with small genomes.

Citing CGView.js

Grant JR and Stothard P
CGView.js: a JavaScript package for visualizing small genomes.
Journal of Open Source Software, 2026, 11(122), 9930.
https://doi.org/10.21105/joss.09930

Resources

Install

npm install cgview

See Installation Instructions for additional ways to setup CGView.js.

Usage

import * as CGView from 'cgview';
import 'cgview/dist/cgview.css';
 
cgv = new CGView.Viewer('#my-viewer', {
  height: 500,
  width: 500,
  sequence: {
    // The length of the sequence
    length: 1000
    // Or, you can provide a sequence
    // seq: 'ATGTAGCATGCATCAGTAGCTA...'
  }
});

// Draw the map
cgv.draw()

See the tutorials to learn how to add features and plots, including how to use CGParse.js to convert GenBank and EMBL files into maps.

License

CGView.js is distributed under the Apache Version 2.0 License.

About

CGView.js creates interactive circular and linear genome maps.

Topics

Resources

Code of conduct

Contributing

Stars

48 stars

Watchers

4 watching

Forks

Releases

Used by

Contributors

Languages