Class Biojs.DasProteinFeatureViewer
Version
1.0.0.
Extends
Biojs.FeatureViewer.
Defined in: Biojs.DasProteinFeatureViewer.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Biojs.DasProteinFeatureViewer(options)
This component uses a DASProtein web service that builds the JSON data object used by FatureViewer component.
|
| Field Attributes | Field Name and Description |
|---|---|
| <inner> |
Default values for the options
|
| <inner> |
Array containing the supported event names
|
| <inner> |
Default values for the options:
target: "",
showSlider: true,
showPrintButton: true,
showFeatureTooltipOnMouseOver: true,
highlightFeatureOnMouseOver: true,
selectFeatureOnMouseClick: true,
dragSites: true //beware that dragging implies a click on so the click event will be raised!
selectionColor: "#ff8c00"
dasSources: "http://www.ebi.ac.uk/das-srv/uniprot/das/uniprot",
featureTypes: "",
featureNames: "",
imageWidth: 700,
imageStyle: "nonOverlapping",
optionResponse: "raphael",
hgrid: false,
vgrid: false,
allFeatures: true,
allRectangles:false,
allSameSize: false,
proxyUrl: ".
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
Biojs.DasProteinFeatureViewer.applyStyle(show)
Applies a style, either "centered", "nonOverlapping", or "rows".
|
| <static> |
Biojs.DasProteinFeatureViewer.constructor(options)
|
| <static> |
Biojs.DasProteinFeatureViewer.exportFeaturesToImage()
Opens a new window/tab in the browser with the graphical representation as a plain image.
|
| <static> |
Biojs.DasProteinFeatureViewer.showGeneralLegend()
Opens a new window/tab in the browser with the graphical representation for all feature types.
|
| <static> |
Biojs.DasProteinFeatureViewer.showHideHorizontalGrid(show)
Shows/hide the horizontal guide lines.
|
| <static> |
Biojs.DasProteinFeatureViewer.showHideVerticalGrid(show)
Shows/hide the horizontal guide lines.
|
- Methods borrowed from class Biojs:
- addListener, extend, getId, listen, raiseEvent, setEventHandlers, setOptions
- Events borrowed from class Biojs.FeatureViewer:
- onFeatureClick, onFeatureOff, onFeatureOn, onFeatureSelected, onFeatureUnselected
Class Detail
Biojs.DasProteinFeatureViewer(options)
This component uses a DASProtein web service that builds the JSON data object used by FatureViewer component.
Author: Leyla Jael Garcia Castro.
Author: Leyla Jael Garcia Castro.
var myPainter = new Biojs.DasProteinFeatureViewer({
target: "YourOwnDivId",
segment: "a4_human"
});
- Parameters:
- {Object} options
- An object with the options for DASProteinFeatureViewer component.
- Options detailed:
- {string} target
- Identifier of the DIV tag where the component should be displayed.
- {boolean} [showSlider=true]
- Should the slider for zooming be displayed?
- {boolean} [showPrintButton=true]
- Should the button for printing/exporting to image be displayed?
- {boolean} [showFeatureTooltipOnMouseOver=true]
- Should the tooltip for features be displayed?
- {boolean} [highlightFeatureOnMouseOver=true]
- Should the features be highlighted when mouse over?
- {boolean} [selectFeatureOnMouseClick=true]
- Should the features remain highlighted, i.e. being selected, after a mouse click, and deselected after a second click or whenever other feature is selected?
- {boolean} [dragSites=true]
- Should the sites be draggable?
- {string} segment
- Protein identifier or protein accession
- {string} [dasSources="http://www.ebi.ac.uk/das-srv/uniprot/das/uniprot"]
- DAS protein sources used to retrieved the features, if another one is needed, just add something like ",URL"
- {string} featureTypes
- In case of more than one source, it is possible to specify only one of them to retrieve a particular feature type. For instance "feature.DOMAIN=http://www.ebi.ac.uk/das-srv/interpro/das/InterPro-matches-overview", for more types just add something like "&feature.XXX=URL" Feature type should be capitalized and can be any of these: DOMAIN, CA_BIND, DNA_BIND, NP_BIND, INTRAMEM, TOPO_DOM, TRANSMEM, ZN_FING, PEPTIDE, PROPEP, SIGNAL, TRANSIT, ACT_SITE, METAL, CARBOHYD, LIPID, MOD_RES, COILED, COMPBIAS, CONSERVED_MOTIF, REGION, REPEAT, CHAIN, INIT_MET, BINDING, SITE, NON_STD, DISULFID, CROSSLINK, VAR_SEQ, VARIANT, MUTAGEN, UNSURE, CONFLICT, NON_CONS, NON_TER, HELIX, TURN, STRAND
- {string} featureNames
- Feature names are displayed as part of the legend. In case you want to modify the text associated to a feature type, you can use this option. For instance name.DOMAIN=Family domains, for more names just add something like "&name.XXX=any text" Feature type should be capitalized and can be any of these: DOMAIN, CA_BIND, DNA_BIND, NP_BIND, INTRAMEM, TOPO_DOM, TRANSMEM, ZN_FING, PEPTIDE, PROPEP, SIGNAL, TRANSIT, ACT_SITE, METAL, CARBOHYD, LIPID, MOD_RES, COILED, COMPBIAS, CONSERVED_MOTIF, REGION, REPEAT, CHAIN, INIT_MET, BINDING, SITE, NON_STD, DISULFID, CROSSLINK, VAR_SEQ, VARIANT, MUTAGEN, UNSURE, CONFLICT, NON_CONS, NON_TER, HELIX, TURN, STRAND
- {int} [imageWidth=700]
- Image width
- {string} [imageStyle="nonOverlapping"]
- Image style, a value from {nonOverlapping, centered, rows}
- {boolean} [hgrid=false]
- Should horizontal lines be shown?
- {boolean} [vgrid=false]
- Should vertical lines be shown?
- {boolean} [allFeatures=true]
- Should all feature types be displayed? or only those defined by default? Default feature types: DOMAIN, CA_BIND, DNA_BIND, NP_BIND, INTRAMEM, TOPO_DOM, TRANSMEM, ZN_FING, PEPTIDE, PROPEP, SIGNAL, TRANSIT, ACT_SITE, METAL, CARBOHYD, LIPID, MOD_RES Other features that will be displayed if allFeatures is true: COILED, COMPBIAS, CONSERVED_MOTIF, REGION, REPEAT, CHAIN, INIT_MET, BINDING, SITE, NON_STD, DISULFID, CROSSLINK, VAR_SEQ, VARIANT, MUTAGEN, UNSURE, CONFLICT, NON_CONS, NON_TER, HELIX, TURN, STRAND
- {boolean} [allRectangles=false]
- Should all features, including those involving just one amino acid be displayed as rectangles? If not, some predefined features will be use for ACT_SITE, METAL, CARBOHYD, LIPID, MOD_RES
- {boolean} [allSameSize=false]
- If "centered" is the image style option, should all rectangles have the same size?
- {string} [proxyUrl="../biojs/dependencies/proxy/proxy.php"]
- Server side proxy server.
Field Detail
<inner>
constructor
Default values for the options
<inner>
eventTypes
Array containing the supported event names
<inner>
opt
Default values for the options:
target: "",
showSlider: true,
showPrintButton: true,
showFeatureTooltipOnMouseOver: true,
highlightFeatureOnMouseOver: true,
selectFeatureOnMouseClick: true,
dragSites: true //beware that dragging implies a click on so the click event will be raised!
selectionColor: "#ff8c00"
dasSources: "http://www.ebi.ac.uk/das-srv/uniprot/das/uniprot",
featureTypes: "",
featureNames: "",
imageWidth: 700,
imageStyle: "nonOverlapping",
optionResponse: "raphael",
hgrid: false,
vgrid: false,
allFeatures: true,
allRectangles:false,
allSameSize: false,
proxyUrl: "../biojs/dependencies/proxy/proxy.php"
Method Detail
<static>
Biojs.DasProteinFeatureViewer.applyStyle(show)
Applies a style, either "centered", "nonOverlapping", or "rows".
myPainter.applyStyle("centered");
- Parameters:
- show
<static>
Biojs.DasProteinFeatureViewer.constructor(options)
- Parameters:
- options
<static>
Biojs.DasProteinFeatureViewer.exportFeaturesToImage()
Opens a new window/tab in the browser with the graphical representation as a plain image.
Note: For IE it does not reflect the drags/drops on sites
myPainter.exportFeaturesToImage();
<static>
Biojs.DasProteinFeatureViewer.showGeneralLegend()
Opens a new window/tab in the browser with the graphical representation for all feature types.
myPainter.showGeneralLegend();
<static>
Biojs.DasProteinFeatureViewer.showHideHorizontalGrid(show)
Shows/hide the horizontal guide lines.
myPainter.showHideHorizontalGrid(true);
- Parameters:
- show
<static>
Biojs.DasProteinFeatureViewer.showHideVerticalGrid(show)
Shows/hide the horizontal guide lines.
myPainter.showHideVerticalGrid(true);
- Parameters:
- show