Class Biojs.Protein3DWS
Version
1.0.0.
Extends
Biojs.Protein3D.
Defined in: Biojs.Protein3DWS.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Biojs.Protein3DWS(options)
Extension of the pdb file viewer getting data from a web service
|
| Method Attributes | Method Name and Description |
|---|---|
|
constructor(options)
|
|
|
getPdbId(pdb)
|
|
|
requestPdb(pdbId)
Request and display a pdb file by means of its identifier.
|
- Methods borrowed from class Biojs.Protein3D:
- applyJmolCommand, changeBackgroundColor, changeControlsVisiblility, display, displayAntialias, displayColorScheme, displayNegative, displayPolar, displayPositive, displayStyle, displaySurface, displayUnPolar, getSelection, hideControls, hideNegative, hidePolar, hidePositive, hideSurface, hideUnPolar, removeSelection, reset, rotate, setHalosVisible, setPdb, setSelection, showControls, showLoadingImage, toString, undisplay
- Methods borrowed from class Biojs:
- addListener, extend, getId, listen, raiseEvent, setEventHandlers, setOptions
| Event Attributes | Event Name and Description |
|---|---|
|
onRequestError(actionPerformed)
|
- Events borrowed from class Biojs.Protein3D:
- onPdbLoaded, onSelection
Class Detail
Biojs.Protein3DWS(options)
Extension of the pdb file viewer getting data from a web service
Author: John Gomez.
Author: John Gomez.
var instance = new Biojs.Protein3DWS({
target: 'YourOwnDivId',
id: '3nuc'
});
- Parameters:
- {Object} options
- An object with the options for the component.
- Options detailed:
- {string} [pdbUrl="http://www.ebi.ac.uk/pdbe-srv/view/files"]
- Url of the web service in order to require the pdb file.
- {string} [id]
- Identifier of the pdb to be displayed (i.e. '3nuc' to require 3nuc.pdb file). You can load another pbd by using requestPdb method.
- {string} [proxyUrl="../biojs/dependencies/proxy/proxy.php"]
- Server side proxy server.
- Requires:
- Server side proxy
Method Detail
constructor(options)
- Parameters:
- options
getPdbId(pdb)
- Parameters:
- pdb
requestPdb(pdbId)
Request and display a pdb file by means of its identifier.
instance.requestPdb('3t6f');
- Parameters:
- {string} pdbId
- Pdb file identifier.
Event Detail
onRequestError(actionPerformed)
instance.onRequestError(
function( e ) {
alert( e.message );
}
);
- Parameters:
- {function} actionPerformed
- An function which receives an Biojs.Event object as argument.
- Event object data:
- {Object} source
- The component which did triggered the event.
- {string} file
- The name of the loaded file.
- {string} result
- A string with either value 'success' or 'failure'.
- {string} message
- Error message in case of result be 'failure'.