Class Biojs.DetailsFrame

Version 1.0.0.

Extends Biojs.

Defined in: Biojs.DetailsFrame.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Biojs.DetailsFrame(options) This component creates a floating div as a pop-up window to visualize a list of annotations on an entity.

Field Summary
Field Attributes	Field Name and Description
<inner>	eventTypes Array containing the supported event names
<inner>	opt Default values for the options

Method Summary
Method Attributes	Method Name and Description
	constructor(options)
	updateFeatures(details, order) The content of the frame can be changed by using this method.

Methods borrowed from class Biojs:: addListener, extend, getId, listen, raiseEvent, setEventHandlers, setOptions

Event Summary
Event Attributes	Event Name and Description
	onFeaturesUpdated(actionPerformed)

Class Detail

Biojs.DetailsFrame(options)

This component creates a floating div as a pop-up window to visualize a list of annotations on an entity. Eg. Protein, Interaction, Gene, etc
Author: Gustavo A. Salazar.

					var instance = new Biojs.DetailsFrame({
					     target: "YourOwnDivId",
					     features: {
					    	 "id":"P64747",
					    	 "description":"Uncharacterized protein Rv0893c/MT0917","Gene-Name":"Rv0893c",
					    	 "%GC":" 60.63",
					    	 "Location":" Unknown",
					    	 "Chrom-Location":" 946",
					    	 "Strand-Direction":" -1",
					    	 "Cordon-Bias":" 0.07692",
					    	 "Funct-Class":" unknown",
					    	 "Degree":" 15",
					    	 "Betweenness":" 784.68",
					    	 "Closeness":" 0.24790",
					    	 "Eigen":" 0.00003",
					    	 "Hub":" N",
					    	 "Sass-Infect":" 0",
					    	 "Sass-Growth":" 0",
					    	 "GO-Growth":" 0",
					    	 "TDR":" 0",
					    	 "UniProt":" 0",
					    	 "DDTRP":" 0",
					    	 "Gas-Nic":" 0",
					    	 "#-Paralogs":" 11",
					    	 "Mtb-cplx":" 11",
					    	 "Mtb":" 7",
					    	 "Corynebacterineae":" 0",
					    	 "Actinomycetales":" 0",
					    	 "Actinobacteridae":" 0",
					    	 "Bacteria":"0",
					    	 "Non-bacteria":"0",
					    	 "H.sapiens":"0",
					    	 "in_leprae":"0",
					    	 "DN/DS":"0.48",
					    	 "Codon-Volatility":"0.1"
					   	}
					});

Parameters:
{Object} options: An object with the options for the Details Frame component.

Options detailed:
{string} target: Identifier of the DIV tag where the component should be displayed.
{object} features: Object with the features to display, every attribute is displayed as an item in the list. The attribute id, is used for the title of the frame. The attribute description has a different style at the beggining of the list
{boolean} [minizable=true]: to indicate if the window is minizable. default value: true
{boolean} [draggable=true]: to indicate if the window can be draggable. default value: true

Requires:: jQuery Core 1.7.2; jQuery UI 1.8.2; jQuery UI CSS 1.8.2; Details frame CSS

Field Detail

<inner> eventTypes

Array containing the supported event names

<inner> opt

Default values for the options

Method Detail

constructor(options)

Parameters:
options

updateFeatures(details, order)

The content of the frame can be changed by using this method.

instance.updateFeatures({id:"newId",description:"new description",newFeature:"its value",otherFeature:"another value"});

Parameters:
{Object} details: An object with the features to display in the Details Frame component.
order

Event Detail

onFeaturesUpdated(actionPerformed)

	instance.onFeaturesUpdated(function( objEvent ) {
		alert("Features have been updated!"); 
	});

Parameters:
{function} actionPerformed: A function which receives an Biojs.Event object as argument. It gets activated when the features of the frame have been updated

Classes

Class Biojs.DetailsFrame