-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!--
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
* This file is part of Jalview.
*
* PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
-->
-<html><!-- InstanceBegin template="/Templates/jtemplate.dwt" codeOutsideHTMLIsLocked="false" -->
-<head>
-<!-- InstanceBeginEditable name="doctitle" -->
-<TITLE>Applet Parameters</TITLE>
-<!-- InstanceEndEditable -->
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><meta http-equiv="keywords" content="jalview,multiple,sequence,alignment,editor,viewer,java,download,barton group,protein,dna,das,distributed annotation system">
-<!-- InstanceBeginEditable name="head" --><!-- InstanceEndEditable -->
-<style type="text/css">
-<!--
-td {
- font-family: Geneva, Arial, Helvetica, sans-serif;
- font-size: 12px;
-}
-.plain {
- font-family: Verdana, Arial, Helvetica, sans-serif;
- font-size: 14px;
- text-decoration: none;
-}
-.plain:hover{
- background-color:#000000; color: #F2F2FF;
-}
-
--->
-</style>
-<script language="JavaScript">
-function genHref()
-{
-var s1 = "ml:ljvwr", s2 = "athpai.g", s3 = "ioe@leo ", href="";
-for(i=0; i<8; i++)
-{href = href + s1.charAt(i) + s2.charAt(i) + s3.charAt(i); }
-window.location=href;
-}
-function getEventTarget(e)
-{
-if(!e)
-e = window.event;
-if(e.target)
-return e.target;
-return e.srcElement;
-}
-</script>
-</head>
+<div id="view_decorated" name="view_decorated" style="margin:8px; padding:10px; border: 2px solid red; text-align:center; display:none;"><b>Click <a href="index.html#appletParameters"> here</a> to view decorated page</b></div>
-<body alink="#000000" vlink="#000000" link="#000000">
-<script type="text/javascript">
-var gaJsHost = (("https:" == document.location.protocol) ?
-"https://ssl." : "http://www.");
-document.write(unescape("%3Cscript src='" + gaJsHost +
-"google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
-</script>
-<script type="text/javascript">
-try{
-var pageTracker = _gat._getTracker("UA-9060947-1");
-pageTracker._trackPageview();
-} catch(err) {}
-</script>
-<div align="left">
- <table width="805" height="100" cellpadding="5">
- <tr>
- <td background="../jalview.gif"> <a href="http://www.compbio.dundee.ac.uk" target="NEW"><img src="../uodc_r1_c1.gif" width="143" height="101" border="1"></a></td>
- </tr>
- </table>
- <table width="805" border="0" cellpadding="5" cellspacing="5">
- <tr>
- <td width="183" valign="top" bgcolor="#F2F2FF" border="5">
-
- <div align="center">
- <table width="182" height="386" border="0" cellpadding="0" cellspacing="0">
- <tr>
- <td align="left" valign="middle"><a href="../index.html" class="plain">Home</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a href="../overview.html" class="plain">Overview</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a href="../download.html" class="plain">Download</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a href="applets.html" class="plain">Applet
- Version</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a href="examples.html" class="plain">Screenshots</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a href="../faq.html" class="plain">FAQ</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a href="../documentList.html" class="plain">Documentation</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle" ><a href="../releaseHistory.html" class="plain">Release
- history</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a href="../source/source.html" class="plain">Source
- Code</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a href="../versions.html" class="plain">Development Version</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a href="../links.html" class="plain">Links</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a href="http://www.jalview.org/mailman/listinfo/jalview-announce" class="plain" target="NEW">News
- Mailing List</a></td>
- </tr>
- <tr>
- <td align="left" valign="middle"><a
- href="http://www.jalview.org/mailman/listinfo/jalview-discuss"
- class="plain" target="NEW">Discussion Mailing List</a><br><br><em>Please send problems<br>and
- bug reports to the discussion list.</em></td>
- </tr>
- <tr></tr>
- <tr>
- <!--<td align="left" valign="middle"><br>
- Please send problems<br>and
- bug reports to:<br><a href="#" onClick="javascript:genHref();"><img src="../help.gif" width="123" height="19" border="0"></a></td>-->
- </tr>
- </table>
-
- </div>
-
- <div align="center"> <a href="http://www.bbsrc.ac.uk/" target="NEW"><br>
- <img src="../bbsrc-new.gif" width="179" height="64" border="1"></a>
- </div>
- </td>
- <td valign="top" width="587" bgcolor="#F2F2FF"><!-- InstanceBeginEditable name="Contents" -->
- <p>
- <strong>Quick Links:<ul><li>Download the applet jar file from <a
- href="jalviewApplet.jar">here</a>
- </li>
- <li>Parameters are described <a href="#parameters">below</a></li>
- <li>The javascript API is described <a
- href="jalviewLiteJs.html">here</a></li>
- </ul></strong>
- </p>
-
- <h3 align="left">Useful to know!!</h3>
- <ul>
- <li>Package all your data files into a single (or multiple) zip / jar
- files. This is very useful to reduce download time of large data files.
- The applet archive tag can take multiple entries separated by commas,
- eg<br>
- <font face="Courier New, Courier, mono" align="left"><applet code="jalview.bin.JalviewLite"<em><strong>
- archive="jalviewApplet.jar, mydata.zip"</strong></em>><br>
- </font></li>
- <li> Use Jalview for input to a HTML form. For an example of how to
- code this using Javascript, click <a href="formComplete.html">here</a>.
- <br>
- </li>
- <li>Embed Jalview into the web page, without the "Start Jalview"
- button by setting the embed parameter to true;<br>
- <param name="embedded"
- value="true"> </li>
- </ul>
- <p><strong><font size="2">**NEW FEATURES** in Jalview 2.8</font></strong></p>
- <ul>
- <li><font size="2">Normalised sequence logo display
- </font></li>
- <li><font size="2">RNA secondary structure annotation row
- </font></li>
-<li><font size="2">Jmol compatibility updated to Jmol 12.2.x series - <a href="JmolApplet-12.2.4.jar">download the JmolApplet here</a></font></li>
-<li>To use Jmol as the structure viewer for Jalview, you must include
- the jar file in the applet archive argument thus:<br>
- <pre>archive="jalviewApplet.jar,Jmol-12.2.4.jar"</pre></font>
- </li>
- <li>Jmol 12.2.x requires at least Java 1.6 to run in the clients web browser. If the client does not have
- Java 1.6, or if the Jmol-12.2.jar is not added to the archive, the
- original Jalview structure viewer will still be available. <br>
- </li>
-
- </ul>
- <p><strong><font size="2">**NEW FEATURES** in Jalview 2.7</font></strong></p>
- <ul>
- <li><font size="2">Javascript callbacks capabilities<ul><li>oninit parameter and methods for registering javascript handlers for selections, mouseovers and linking to Jmol applets on the page.</li>
- <li>To use javascript callbacks, ensure the applet tag includes the '<a href="http://download.oracle.com/javase/6/docs/technotes/guides/plugin/developer_guide/java_js.html">mayscript</a>' attribute - either as a parameter (<param name="mayscript" value="true"/;gt;) or as a bare attribute in the applet html tag).</li></ul></font>
- </li>
- <li><font size="2">New <a href="jalviewLiteJs.html">jalviewLite java api</a> methods for selecting, highlighting, scrolling and reordering sequences in an alignment view.
- </font></li></ul>
- <p><strong><font size="2">**NEW FEATURES** in Jalview 2.6</font></strong></p>
- <ul>
- <li><font size="2">Jmol compatibility updated to Jmol 12.1.x series</font></li>
- <li>Jalview 2.6 works only with Jmol version 12.1.13 or later. You can use the JmolApplet.jar from
- the Jmol binary distribution available at the Jmol Sourceforge site,
- or <a href="JmolApplet-12.1.13.jar">download the Jmol applet from here</a></li>
- <li><font size="2">Minimum recommended version of Java runtime for the applet is now 1.5 (JalviewLite v2.6 without the Jmol viewer may work ok on earlier Java environments but compatibility can no-longer be guaranteed).</font></li>
- </ul>
- <br><strong><font size="2">**NEW FEATURES** in Jalview 2.5</font></strong></p>
- <ul>
- <li><font size="2">New parameters to control display of tree annotation, width of alignment columns, and to disable the jalview button and check for Jmol on startup.</font></li>
- </ul>
- <br><strong><font size="2">**NEW FEATURES** in Jalview 2.4</font></strong></p>
- <ul>
- <li><font size="2">New applet API methods for feature display control, views, and obtaining current selection via javascript.</font></li>
- <li><font size="2">Group show and hide parameters:
- "showfeaturegroups" and
- "hidefeaturegroups". Both take a list
- of feature group names (separarated by "|" by default) to hide or show on the displayed
- alignment.</font>
- </li>
- <li><font size="2">Regular expressions can be used in URL links for sequence IDs.</font></li>
- <li><font size="2">"debug" parameter to control verbosity of the applet's console output.</font></li>
- <li><font size="2">"showbutton" parameter to disable launch button and open JalviewLite immediatly.</font></li>
- <li><font size="2">"nojmol" parameter to disable check for Jmol classes.</font></li>
- </ul><br>
- <strong><font size="2">**NEW FEATURES** in Jalview 2.3</font></strong></p>
- <ul>
- <li><font size="2">Note that Parameter "PDBFile" now takes
- the PDB file followed by a space separated list of alignment sequence
- ids to associate the structure to. It is also possible to associate
- multiple PDB files by adding an incremental value to PDBFile (up to
- 10). It is also possible to map specific sequences to specific chains
- by using the following notation:<br>
- <br>
- <param name="PDBFile" value="First.pdb SeqA SeqB
- SeqC"> </font><br>
- <font size="2"><param name="PDBFile2" value="Second.pdb
- A=SeqA B=SeqB C=SeqC"> </font><br>
- <font size="2"><param name="PDBFile3" value="Third.pdb
- D=SeqX B=SeqY C=SeqZ"> </font> <br>
- </li>
- <li>Note parameter "PDBSeq" is no longer required.<br>
- </li>
- <li>Jalview 2.3 was updated to work with Jmol 11. See the <a href="../versions.html">versions archive if you want to download the old Jmol applet</a>.</li>
- <p> </p>
- </li>
- </ul>
- <strong><font size="2">**NEW FEATURES** in Jalview 2.1</font></strong>
- <ul>
- <li>Jalview Applet can read and display JNet secondary structure annotation
- directly via the <strong>jnetfile</strong> parameter. <br>
- </li>
- <li>Param <font face="Courier New, Courier, mono">UserDefinedColour</font><em>
- </em>- specify your own colours for each residue using a semi colon
- separated list. Multiple residues can be assigned the same colour
- using commas. eg:<br>
- <font face="Courier New, Courier, mono"><param name="userDefinedColour"
- value="D,E=red; K,R,H=0022FF; C=yellow"></font><br>
- </li>
- <li>Param <font face="Courier New, Courier, mono">showFeatureSettings</font>
- - this will display the feature settings window when the applet starts.<br>
- </li>
- <li>Param <font face="Courier New, Courier, mono">Application_URL value="http://www.jalview.org/services/launchApp"<br>
- </font>This calls a servlet which creates a JNLP file with the alignment
- file, annotations file and features file of the applet as arguments.
- If the user has Java installed, the returned JNLP file should start
- up the full Jalview Application. BUT this does not currently work
- for alignment files added to the applet in a zip file.<br>
- </li>
- <li>Alignment file can be a series of parameters using eg PFAM format
- <br>
- <font face="Courier New, Courier, mono"><param name="sequence1"
- value="Q93XJ9_SOLTU/11-26 TSFLPRKPVVTSLKAI"><br>
- <param name="sequence2" value="FER1_PEA/14-29 TSFLRTQPMPMSVTTT"><br>
- </font>(All the usual Jalview File formats are valid, however each
- new line in an alignment file must be entered as a parameter)<font face="Courier New, Courier, mono"><br>
- </font> </li>
- </ul>
- <a name="parameters"></a> <table width="97%" border="1" align="center" >
+<!-- content start -->
+<h2>JalviewLite Applet Parameter Documentation</h2>
+<p>
+The JalviewLite applet is configured through a series of applet parameters,
+which are described <a href="#parameters"> below</a>. Once initialised,
+the applet can be interacted with <em>via</em> its
+<a href="javascript:doSubmit('jalviewLiteJs')">Javascript API</a>.
+</p><p><strong>Issues arising from tightening of Java Security default settings</strong><br/>JalviewLite is provided as a signed applet with 'sandbox' permissions and wildcards that allow it to be run from any website. Unfortunately, earlier versions of Java may not be compatible with these settings. </p>
+ <p>For additional deployment notes, <a href="javascript:doSubmit('appletDeployment')">see Applet Deployment</a>.</p>
+ <p><h2>Applet Parameters</h2><br/>The applet takes the following initialisation parameters.</p>
+ <a name="parameters"></a> <table width="97%" class="borderTable" align="center" >
<tr>
<td width="103" height="23"><strong><param name=""</strong></td>
<td width="80" ><strong>value=""></strong></td>
<td width="100%"><strong>Description</strong></td>
</tr>
+ <tr>
+ <td>permissions</td>
+ <td>sandbox</td>
+ <td><strong>This parameter is necessary, and must have the value <em>sandbox</em> to allow the JalviewLite applet to run.</strong></td>
+ </tr>
<tr>
<td>file</td>
<td>fileName</td>
<td>The file to open, must be on same server as the applet.</td>
</tr>
+ <tr>
+ <td>file2</td>
+ <td>fileName</td>
+ <td>A second file to open and show linked in a Split Frame
+ view. If one file is nucleotide and the other peptide, and at
+ least one peptide sequence matches the translation of one of the
+ nucleotide sequences, then gaps will be inserted into the
+ sequences in this file to match the aligned columns for
+ corresponding positions in the primary alignment file. This
+ parameter is ignored if enableSplitFrame is set to false (<em>since
+ 2.9</em>).
+ </td>
+ </tr>
+ <tr>
+ <td>enableSplitFrame</td>
+ <td>true or false (default true)</td>
+ <td>Enable or disable the display of linked cDNA and Protein alignments in a split frame (<em>since 2.9</em>).</td>
+ </tr>
<tr>
<td>sequence1,<br>
sequence2,<br>
<td>jnetfile</td>
<td>fileName</td>
<td>Secondary structure predictions from a <a
- href="http://www.compbio.dundee.ac.uk/~www-jpred/">Jnet</a> Concise
- file will be added to the first sequence in the alignment.</td>
+ href="http://www.compbio.dundee.ac.uk/~www-jpred/">JPred</a> Concise
+ file will be added to the first sequence in the alignment.<br/>
+ <em>jpredfile</em> can be used interchangeably with this parameter.</td>
</tr>
<tr>
<td>PDBfile(x)</td>
<td>defaultColour</td>
<td> <em>One of: </em><br>
Clustal, Blosum62, % Identity, Hydrophobic, Zappo, Taylor, Helix
- Propensity, Strand Propensity, Turn Propensity, Buried Index, Nucleotide</td>
+ Propensity, Strand Propensity, Turn Propensity, Buried Index, Nucleotide, Purine/Pyrimidine, T-Coffee Scores, RNA Helices</td>
<td>Default is no colour.</td>
</tr>
<tr>
+ <td>defaultColourNuc</td>
+ <td>A colour scheme (from the list above) to apply to Nucleotide alignments</td><td>This overrides defaultColour if it is specified.</td>
+ </tr>
+ <tr>
+ <td>defaultColourProt</td>
+ <td>A colour scheme (from the list above) to apply to Peptide alignments</td><td>This overrides defaultColour if it is specified.</td>
+ </tr>
+ <tr>
<td>userDefinedColour</td>
<td><p><em>Example:</em><br>
D,E=red; K,R,H=0022FF; c=yellow</p></td>
<td>Default is true.</td>
</tr>
<tr>
+ <td>showOccupancy</td>
+ <td>true <em>or</em> false</td>
+ <td>Default is true.</td>
+ </tr>
+ <tr>
<td>sortBy</td>
<td> Id <em>, </em> Pairwise Identity<em>, or</em> Length</td>
<td> Sorts the alignment on startup</td>
</tr>
<tr>
<td>linkLabel_1</td>
- <td>Uniprot</td>
+ <td>EMBL-EBI Search</td>
<td rowspan="2"><p>Right click on sequence id to see list of available
links. Any new links MUST have $SEQUENCE_ID$ as part of the linkURL_n
value. For multiple links, increment the label and url name by
<br>Regex URL links are also applied to the description line (since Jalview 2.4.+).</em></p></td>
</tr>
<tr>
- <td> <p><br>
+ <td> <p>
+ <br>
linkUrl_1<br>
</p></td>
<td><p><br>
- http://us.expasy.org/cgi-bin/<br>
- niceprot.pl?$SEQUENCE_ID$</p>
+ http://www.ebi.ac.uk/ebisearch/<br/>search.ebi?db=allebi&query=$SEQUENCE_ID$</p>
</td>
</tr>
<tr>
<td>1.0 or greater</td>
<td>Adjust the width of each cell in the alignment grid relative to the width of a character in the alignment font. (<em>since 2.5.1</em>)</td>
</tr>
+ <tr><td>scaleProteinAsCdna</td><td>true or false (default is false)</td>
+ <td>Set true to shown protein residues the same width as their encoding codons.
+ For use with parameter file2 when showing a split frame of cDNA and protein. (<em>since 2.9</em>)</td></tr>
<tr><td>centrecolumnlabels</td>
- <td>true of false (default is false)</td>
+ <td>true or false (default is false)</td>
<td>When true, text labels associated with a column in the alignment will be shown centered with respect to the column. (<em>since 2.4</em>)</td>
<tr><td>showUnconserved</td>
- <td>true of false (default is false)</td>
+ <td>true or false (default is false)</td>
<td>When true, only gaps and symbols different to the consensus sequence for a column will be shown. Useful for visualizing alignments exhibiting low sequence variation, where it is important to highlight mutations. (<em>since 2.5</em>)</td>
</tr>
<tr><td>upperCase</td>
<td>Indicate a text style to apply to uppercase sequence symbols. Currently, only <strong>bold</strong> is supported.</td>
</tr>
<tr><td>automaticScrolling</td>
- <td>true of false (default is true)</td>
+ <td>true or false (default is true)</td>
<td>When true, alignment panels will automatically scroll to show any regions of the alignment highlighted due to javascript events or when mousing over a position in an associated structure. (<em>since 2.6</em>)</td>
</tr>
<tr><td>showGroupConsensus</td>
- <td>true of false (default is false)</td>
+ <td>true or false (default is false)</td>
<td>When true, shows consensus annotation row for any groups on the alignment. (<em>since 2.7</em>)</td>
</tr>
<tr><td>showGroupConservation</td>
- <td>true of false (default is false)</td>
+ <td>true or false (default is false)</td>
<td>When true, shows amino-acid property conservation annotation row for any groups on the alignment. (<em>since 2.7</em>)</td>
</tr>
<tr><td>showConsensusHistogram</td>
- <td>true of false (default is true)</td>
+ <td>true or false (default is true)</td>
<td>When true, shows the percentage occurence of the consensus symbol for each column as a histogram above the consensus sequence row. (<em>since 2.7</em>)</td>
</tr>
<tr><td>showSequenceLogo</td>
- <td>true of false (default is false)</td>
+ <td>true or false (default is false)</td>
<td>When true, shows a sequence logo above the consensus sequence (overlaid above the Consensus Histogram, if visible, with symbols coloured using the alignment's default colourscheme). (<em>since 2.7</em>)</td>
</tr>
<tr><td>normaliseSequenceLogo</td>
- <td>true of false (default is false)</td>
+ <td>true or false (default is false)</td>
<td>When true, all sequence logos will be normalised (all symbol stacks add up to full height of annotation row), rather than being scaled according to the fraction of symbols identical to the consensus. (<em>since 2.8</em>)</td>
</tr>
<tr><td>oninit</td>
<td>Multiple sequences aligment scores file. Currently is supported only the T-Coffee score_ascii file format</td>
</tr>
</table>
- <p align="center"> </p>
- <!-- InstanceEndEditable --></td>
- </tr>
- </table>
-</div>
-</body>
-<!-- InstanceEnd --></html>
+ <!-- content end -->
git://source.jalview.org / jalview.git / blobdiff