Class Index | File Index

Classes


Class Biojs.wigExplorer


Version 1.0.0.

Extends Biojs.

Defined in: Biojs.wigExplorer.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
This component uses the D3 library to visualise a wig formatted file as an area chart, with panning and zooming functionality.
Field Summary
Field Attributes Field Name and Description
<inner>  
Array containing the supported event names
<inner>  
opt
Default values for the options
Method Summary
Method Attributes Method Name and Description
 
constructor(options)
 
paintFeatures(dataSet)
Paint the features according to the values specified in the json object defined when creating the object.
Methods borrowed from class Biojs:
addListener, extend, getId, listen, raiseEvent, setEventHandlers, setOptions
Class Detail
Biojs.wigExplorer(options)
This component uses the D3 library to visualise a wig formatted file as an area chart, with panning and zooming functionality.
Author: Anil Thanki.
var instance = new Biojs.wigExplorer({
     target: "YourOwnDivId",
     selectionBackgroundColor: '#99FF00',
     dataSet: "../biojs/data/wigExplorerDataSet.tsv"
});
Parameters:
{Object} options
An object with the options for wigExplorer component.
Options detailed:
{string} target
Identifier of the DIV tag where the component should be displayed.
{string} [fontFamily='"Andale
mono", courier, monospace'] Font list to be applied to the component content.
{string} [fontColor="white"]
HTML color code for the font.
{string} [backgroundColor="#7BBFE9"]
Background color for the entire div content.
{Object} [selectionFontColor="white"]
This color will be used to change the font color of selected text.
{Object} [selectionBackgroundColor="yellow"]
This color will be used to change the background of selected text.
{string} dataSet
File in TSV format including input data. Example of TSV file ...
start    value
 10    34
 20    41
 30    46
 40    49
 ...
Requires:
D3
jQuery UI 1.8.2+
jQuery Core 1.6.4
biojs.wigExplorer.css
jQuery UI CSS 1.8.2
Field Detail
<inner> eventTypes
Array containing the supported event names

<inner> opt
Default values for the options
Method Detail
constructor(options)
Parameters:
options

paintFeatures(dataSet)
Paint the features according to the values specified in the json object defined when creating the object. This method initializes the holder, paints the slider and print button depending on the options, and paints the features and legend.
instance.paintFeatures("../biojs/data/wigExplorerDataSet2.tsv");
Parameters:
{string} dataSet
Location of the file with the input data in TSV format.
start    value
 10    34
 20    41
 30    46
 40    49
 ...

Documentation generated by JsDoc Toolkit 2.3.2 on Fri Aug 23 2013 13:38:38 GMT+0100 (BST)