Class Index | File Index

Classes


Class Biojs.InteractionsFilterGraph


Version 1.0.0.

Extends Biojs.

Defined in: Biojs.InteractionsFilterGraph.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Graph display to highlight molecular interaction data.
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)
 
highlightFilterOption(dataElement, filterName)
Highlight a filter option in the graph
 
Unselect all the interactions in the graph
Methods borrowed from class Biojs:
addListener, extend, getId, listen, raiseEvent, removeListener, setEventHandlers, setOptions
Class Detail
Biojs.InteractionsFilterGraph(options)
Graph display to highlight molecular interaction data. NOTE: The selection radio button options will just work if the instance of your object is globlal. Example: "var instance; window.onload = function() {instance = new Biojs.InteractionsFilterGraph(...)};"
Author: Rafael Jimenez.
var instance = new Biojs.InteractionsFilterGraph({
	 	target: "YourOwnDivId",
     instanceName: "instance",
     graphHeight: '350px',
     graphWidth: '100%',
     interactions: {
		 "i1": ["P1","P2"],
	 	 "i2": ["P3","P4"],
		 "i3": ["P5","P6"],
		 "i4": ["P2","P6"],
		 "i5": ["P2","P4"],
		 "i6": ["P6","P1"],
		 "i7": ["P2","P6"]
		},
	 	filters:{
	 		timeSeries: {
				title: "Time after Sendai viral infection (hours)",
				presentation: "radio",
				active: true,
				dataType: "edges",
				data: {
				 "2":["i2","i3","i4"],
				 "6":["i2","i5","i6","i7"],
				 "12":["i1","i2","i3","i4","i6","i7"]
			}
		}
	}
});
Parameters:
{Object} options
An object with the options for this component.
Options detailed:
{string} target
Identifier of the DIV tag where the component should be displayed.
{string} instanceName
Instance name of the object
{string} interactions
Object with binary interactions including interactors
{string} filters
Filtering options use to highlight interactions in the graph
{string} graphHeight
[400] Graph height
{string} graphWidth
[400] Graph width
Requires:
Biojs.InteractionsFilterGraph.css
jQuery 1.7.2
Cytoscape.js (latest version strongly suggested)
Arbor JS (included with Cytoscape.js)
Field Detail
<inner> eventTypes
Array containing the supported event names

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

highlightFilterOption(dataElement, filterName)
Highlight a filter option in the graph
instance.highlightFilterOption("6","timeSeries");
instance.highlightFilterOption("2","timeSeries");
Parameters:
{string} dataElement Optional
Data element of one filter option.
{string} filterName Optional
Filter name of one filter option.

unselect()
Unselect all the interactions in the graph
instance.unselect();

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