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.
 
paintWig(start, end, target)
Draws area chart from wig file using D3.js based on the specified positions
 
setReference(ref_chr)
Select reference from Wig file from the given parameter and then parse Data for reference
Methods borrowed from class Biojs:
addListener, extend, getId, listen, raiseEvent, removeListener, 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: 'steelblue',
     dataSet: "../biojs/data/wigExplorerDataSet5.txt"
});
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} dataSet
File in text format including input data. Examples of text file ...
variableStep chrom=chr2 span=5
10    34
20    41
30    46
40    49
50    52

 ...

or

fixedStep chrom=chr2 start=10 step=10 span=5
34
41
46
49
52

 ...
{string} [selectionBackgroundColor]
Name of the colour to be set as background for area chart
Requires:
D3
jQuery UI 1.8.2+
jQuery Core 1.6.4
jQuery UI CSS 1.8.2
jQuery.tooltip
jQuery.tooltip CSS
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("path-to-wig.txt");
Parameters:
{string} dataSet
Location of the file with the input data in text format.
variableStep chrom=chr2 span=5
10    34
20    41
30    46
40    49
50    52

 ...

or

fixedStep chrom=chr2 start=10 step=10 span=5
34
41
46
49
52

 ...

paintWig(start, end, target)
Draws area chart from wig file using D3.js based on the specified positions
instance.paintWig(1000,100000,"target-div")
Parameters:
start
end
target

setReference(ref_chr)
Select reference from Wig file from the given parameter and then parse Data for reference
instance.setReference("ref_name")
Parameters:
ref_chr

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Apr 17 2014 17:42:43 GMT+0100 (BST)