Skip to content

An interactive element for visualizing sequence coverage in delimited regions

License

Notifications You must be signed in to change notification settings

jviz-deprecated/jviz-coverviewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CoverViewer

An interactive module for visualizing sequence coverage in delimited regions.

Installation

Use the jviz CLI for installing this module:

jviz install coverviewer

Reference

Options

API

coverviewer.draw(start)

Draw the coverage values starting at the position given by the argument start.

coverviewer.move(status)

Enable or disable the move action. If no argument is provided, this method will return the actual status.

coverviewer.clear()

Clear all layers.

Events

coverviewer.on('drag:start', handler)

Emit the handler function when the user press the left mouse button. The handler function will be called with the following arguments:

  • start: coverage draw start position.
  • end: coverage draw end position.

coverviewer.on('drag:move', handler)

Emit the handler function when the user moves the coverage graphic. The handler function will be called with the following arguments:

  • start: actual coverage draw start position.
  • end: actual coverage draw end position.

coverviewer.on('drag:stop', handler)

Emit the handler function when the user release the left mouse button. The handler function will be called with the following arguments:

  • start: actual coverage draw start position.
  • end: actual coverage draw end position.

License

MIT LICENSE © The Jviz Team.

Releases

No releases published

Packages

No packages published

Languages