A jviz module to build an ideogram.
Use the jviz CLI for installing this module:
jviz install ideogram
- Options: a compilation with all the options that you can provide to the ideogram constructor.
- API: all the commands to manipulate the ideogram.
- Events: the ideogram module emits events when the user interacts with the tool. Here we present all the events available.
Open the provided chromosome. The index
argument must be a string with the chromosome name.
Return an array with all the chromosomes.
Return an array with all the regions for a given chromosome. The name
argument must be an string with the name of the wanted chromosome.
Return an array with the marked regions. The name
argument must be an string with the name of the wanted chromosome.
Emit the handler
function when the user clicks on a chromosome on the ideogram. The handler
function will be called with the following arguments:
name
: the chromosome name.index
: the index of the chromosome on the genome list.
Emit the handler
function when the user clicks on a region. The handler
function will be called with the following arguments:
name
: region name.chromosome
: chromosome where the region is located.start
: region start position.end
: region end position.
Emit the handler
function when the user clicks on the preview button.
Emit the handler
function when the user clicks on the table button.
MIT LICENSE © The Jviz Team.