Class Biojs.PDBLogos

Version 1.0.0.

Extends Biojs.

Defined in: Biojs.PDBLogos.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Biojs.PDBLogos(options) PDBLogos shows a set of icons to give a quick summary of salient features of a PDB entry.

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)
	setIdentifier(value) Sets the pdb identifier generating a new request of logos.

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

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

Class Detail

Biojs.PDBLogos(options)

PDBLogos shows a set of icons to give a quick summary of salient features of a PDB entry. See more info on PDBLogos at http://pdbe.org/prints
Author: John Gomez-Carvajal.

var instance = new Biojs.PDBLogos({
   target: "YourOwnDivId",
   identifier: "1cbs"
});

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

Options detailed:
{string} target: Identifier/HTMLElement of the div container where the component should be rendered.
{string} identifier: PDB entry id for which prints will be rendered.
{Object} raphael: A Raphael object instead of div to render PDBprints into.
{int} startX: X-coordinate of point where rendering the array of PDBprints will start in the Raphael canvas
{int} startY: Y-coordinate of point point where rendering the array of PDBprints will start in the Raphael canvas
{int} interval: Gap size between successive PDBprints in a vertical or horizontal array
{int} size: Length of an icon logo
{string} [color="#588FE5"]: Color for background as HTML color code.
{char} orient: Rendering orientation either vertical or horizontal
{string} [pdb3DIcon='biojs/css/images/3d.png']: Image URL to be used as 3D structure's icon

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

setIdentifier(value)

Sets the pdb identifier generating a new request of logos.

instance.setIdentifier("1j3s");

Parameters:
{string} value: PDB entry.

Event Detail

onClick(actionPerformed)

instance.onClick(
   function( e ) {
      alert("Logo " + e.category + " of PDB " + e.identifier + " 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.
{string} identifier: PDB actual entry.
{string} category: Name of the PDBLogo category clicked.
{string} printsUrl: Url of the PDB general information.

Classes

Class Biojs.PDBLogos