Class Biojs.PDBprints

Version 1.0.0.

Extends Biojs.

Defined in: Biojs.PDBprints.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Biojs.PDBprints(options) This is the description of the PDBprints component.

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)
	printsLayout(printsdata)
	printsLayout1(conf, printsdata)

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

Event Summary
Event Attributes	Event Name and Description
	onClick(actionPerformed)
	onHelloSelected(actionPerformed)

Class Detail

Biojs.PDBprints(options)

This is the description of the PDBprints component. This component renders a set of icons to give a quick summary of salient features of a PDB entry. See more info on PDBprints at http://pdbe.org/prints
Author: Swanand Gore.

var instance = new Biojs.PDBprints({
		targets : [
         {divid:"YourOwnDivId",     pdbids:["1aac","1cbs"]}
     ]
});

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

Options detailed:

{list} targets

This is a list of configuration options, each corresponding to PDBprints to be rendered in a div. Each config consists of following:

pdbids: PDB entry ids for which prints are to be rendered.
divid: the id of div in which the prints are to be rendered.
rapha: A Raphael object instead of div to render PDBprints into.
startX: X-coordinate of point where rendering the array of PDBprints will start in the Raphael canvas
startY: Y-coordinate of point point where rendering the array of PDBprints will start in the Raphael canvas
interval: gap between successive PDBprints in a vertical or horizontal array
size: length of an icon logo in PDBprints
orient: vertical or horizontal rendering fo PDBprints

Requires:: Raphael 2.1.0; jQuery Core 1.6.4

Field Detail

<inner> eventTypes

Array containing the supported event names

<inner> opt

Default values for the options

Method Detail

constructor(options)

Parameters:
options

printsLayout(printsdata)

Parameters:
printsdata

printsLayout1(conf, printsdata)

Parameters:
conf
printsdata

Event Detail

onClick(actionPerformed)

instance.onClick(
   function( objEvent ) {
      alert("The character " + objEvent.selected + " was clicked.");
   }
);

Parameters:
{function} actionPerformed: A function which receives an Biojs.Event object as argument.

Event object data:
{Object} source: The component which did triggered the event.
{string} type: The name of the event.
{int} selected: Selected character.

onHelloSelected(actionPerformed)

instance.onHelloSelected(
   function( objEvent ) {
      alert("The word " + objEvent.textSelected + " was selected.");
   }
);

Parameters:
{function} actionPerformed: A function which receives an Biojs.Event object as argument.

Event object data:
{Object} source: The component which did triggered the event.
{string} type: The name of the event.
{int} textSelected: Selected text, will be 'Hello' obviously.

Classes

Class Biojs.PDBprints