Index

CGView.js

Pages Status Tests Status Last Commit License Docs

npm version bundle size Min+Gzip jsDelivr hits

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

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 distrubuted under the Apache Version 2.0 License.

Documentation Generation Date

Wed Sep 03 2025 12:32:06 GMT-0600 (Mountain Daylight Time)