examples/appletParameters.html

   1 <!--
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18 -->
  19
  20
  21 <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>
  22
  23 <!-- content start -->
  24 <h2>JalviewLite Applet Parameter Documentation</h2>
  25 <p>
  26 The JalviewLite applet is configured through a series of applet parameters,
  27 which are described <a href="#parameters"> below</a>. Once initialised,
  28 the applet can be interacted with <em>via</em> its
  29 <a href="javascript:doSubmit('jalviewLiteJs')">Javascript API</a>.
  30 </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>
  31     <p>For additional deployment notes, <a href="#appletdeploymentnotes">see below</a>.</p>
  32             <p><h2>Applet Parameters</h2><br/>The applet takes the following initialisation parameters.</p>
  33         <a name="parameters"></a>        <table width="97%" class="borderTable" align="center" >
  34           <tr>
  35             <td width="103" height="23"><strong>&lt;param name=&quot;&quot;</strong></td>
  36             <td width="80" ><strong>value=&quot;&quot;&gt;</strong></td>
  37             <td width="100%"><strong>Description</strong></td>
  38           </tr>
  39           <tr>
  40           <td>permissions</td>
  41           <td>sandbox</td>
  42           <td><strong>This parameter is necessary, and must have the value <em>sandbox</em> to allow the JalviewLite applet to run.</strong></td>
  43           </tr>
  44           <tr>
  45             <td>file</td>
  46             <td>fileName</td>
  47             <td>The file to open, must be on same server as the applet.</td>
  48           </tr>
  49               <tr>
  50                 <td>file2</td>
  51                 <td>fileName</td>
  52                 <td>A second file to open and show linked in a Split Frame
  53                   view. If one file is nucleotide and the other peptide, and at
  54                   least one peptide sequence matches the translation of one of the
  55                   nucleotide sequences, then gaps will be inserted into the
  56                   sequences in this file to match the aligned columns for
  57                   corresponding positions in the primary alignment file. This
  58                   parameter is ignored if enableSplitFrame is set to false (<em>since
  59                     2.9</em>).
  60                 </td>
  61               </tr>
  62             <tr>
  63             <td>enableSplitFrame</td>
  64             <td>true or false (default true)</td>
  65             <td>Enable or disable the display of linked cDNA and Protein alignments in a split frame (<em>since 2.9</em>).</td>
  66           </tr>
  67           <tr>
  68             <td>sequence1,<br>
  69               sequence2,<br>
  70               sequence3</td>
  71             <td>sequence in (preferably) PFAM or Fasta format</td>
  72             <td>The alignment can be added as a series of sequences instead of
  73               from a file.</td>
  74           </tr>
  75           <tr>
  76             <td>tree</td>
  77             <td>fileName</td>
  78             <td>Tree file in Newick format</td>
  79           </tr>
  80           <tr>
  81             <td>features</td>
  82             <td>fileName</td>
  83             <td>Jalview Features file to be applied to the alignment</td>
  84           </tr>
  85           <tr>
  86             <td>annotations</td>
  87             <td>fileName</td>
  88             <td>Jalview Annotation file will be added to the alignment</td>
  89           </tr>
  90           <tr>
  91             <td>jnetfile</td>
  92             <td>fileName</td>
  93             <td>Secondary structure predictions from a <a
  94             href="http://www.compbio.dundee.ac.uk/~www-jpred/">Jnet</a> Concise
  95               file will be added to the first sequence in the alignment.</td>
  96           </tr>
  97           <tr>
  98             <td>PDBfile(x)</td>
  99             <td><p>fileName seq1 seq2 seq3</p>
 100               <p>or</p>
 101               <p>fileName A=seq1 B=seq2 C=seq3</p></td>
 102             <td>PDB file which is to be associated with a sequence, followed by
 103               space separated list of alignment sequence ids. PDB chains can be
 104               specifed to map to particular sequence by using A=SeqA notation</td>
 105           </tr>
 106           <tr>
 107             <td><p>PDBSeq<br>
 108                 *Not needed post Jalview 2.3, use PDBFile instead</p></td>
 109             <td>SequenceId</td>
 110             <td>The sequence to associate a PDB file with. Note the value is case
 111               sensitive.</td>
 112           </tr>
 113           <tr>
 114             <td>defaultColour</td>
 115             <td> <em>One of: </em><br>
 116               Clustal, Blosum62, % Identity, Hydrophobic, Zappo, Taylor, Helix
 117               Propensity, Strand Propensity, Turn Propensity, Buried Index, Nucleotide, T-Coffee Scores, RNA Helices</td>
 118             <td>Default is no colour.</td>
 119           </tr>
 120           <tr>
 121             <td>defaultColourNuc</td>
 122             <td>A colour scheme (from the list above) to apply to Nucleotide alignments</td><td>This overrides defaultColour if it is specified.</td>
 123           </tr>
 124           <tr>
 125             <td>defaultColourProt</td>
 126             <td>A colour scheme (from the list above) to apply to Peptide alignments</td><td>This overrides defaultColour if it is specified.</td>
 127           </tr>
 128           <tr>
 129             <td>userDefinedColour</td>
 130             <td><p><em>Example:</em><br>
 131                 D,E=red; K,R,H=0022FF; c=yellow</p></td>
 132             <td>Define residue colours</td>
 133           </tr>
 134           <tr>
 135             <td height="35">showFullId</td>
 136             <td>true <em>or</em> false</td>
 137             <td>if true displays start and end residue at the end of sequence
 138               Id.</td>
 139           </tr>
 140           <tr>
 141             <td>showAnnotation</td>
 142             <td>true <em>or</em> false</td>
 143             <td>If true shows the annotation panel below the alignment.</td>
 144           </tr>
 145           <tr>
 146             <td>showConservation</td>
 147             <td>true <em>or</em> false</td>
 148             <td>Default is true.</td>
 149           </tr>
 150           <tr>
 151             <td>showQuality</td>
 152             <td>true <em>or</em> false</td>
 153             <td>Default is true.</td>
 154           </tr>
 155           <tr>
 156             <td>showConsensus</td>
 157             <td>true <em>or</em> false</td>
 158             <td>Default is true.</td>
 159           </tr>
 160           <tr>
 161             <td>sortBy</td>
 162             <td> Id <em>, </em> Pairwise Identity<em>, or</em> Length</td>
 163             <td> Sorts the alignment on startup</td>
 164           </tr>
 165           <tr>
 166             <td>RGB</td>
 167             <td>colour as hex string</td>
 168             <td>Background colour for applet button - purely cosmetic to blend
 169               in with your web page. For orange, enter the value FF6600</td>
 170           </tr>
 171           <tr>
 172             <td>embedded</td>
 173             <td>true <em>or</em> false</td>
 174             <td>The applet is embedded in the web page, the &quot;Start Jalview&quot;
 175               button is not displayed.</td>
 176           </tr>
 177           <tr>
 178             <td>windowWidth</td>
 179             <td>value</td>
 180             <td>frame width</td>
 181           </tr>
 182           <tr>
 183             <td>windowHeight</td>
 184             <td>value</td>
 185             <td>frame height</td>
 186           </tr>
 187           <tr>
 188             <td>label</td>
 189             <td>label text</td>
 190             <td>Change text for the Launch Jalview Button</td>
 191           </tr>
 192           <tr>
 193             <td>wrap</td>
 194             <td>true <em>or</em> false</td>
 195             <td>Opens new windows in wrapped mode</td>
 196           </tr>
 197           <tr>
 198             <td>linkLabel_1</td>
 199             <td>EMBL-EBI Search</td>
 200             <td rowspan="2"><p>Right click on sequence id to see list of available
 201                 links. Any new links MUST have $SEQUENCE_ID$ as part of the linkURL_n
 202                 value. For multiple links, increment the label and url name by
 203                 1. ie <br>
 204                 &lt;param name=&quot;linkLabel_2&quot; ..., <br>
 205                 &lt;param name=&quot;linkUrl_2&quot;....<br>
 206               </p>
 207               <p>Regular expressions may also be used (<em>since Jalview 2.4</em>) to process the ID string inserted into the URL:
 208               <br>$SEQUENCE_ID=/&lt;regex to extract ID&gt;/=$<br><em>Use the debug flag to check parsing and make sure that special symbols are properly escaped (particularly when generating applet tags from CGI scripts).
 209               <br>Regex URL links are also applied to the description line (since Jalview 2.4.+).</em></p></td>
 210           </tr>
 211           <tr>
 212             <td> <p>
 213             <br>
 214                 linkUrl_1<br>
 215               </p></td>
 216             <td><p><br>
 217                 http://www.ebi.ac.uk/ebisearch/<br/>search.ebi?db=allebi&query=$SEQUENCE_ID$</p>
 218                                                 </td>
 219           </tr>
 220           <tr>
 221             <td>showFeatureSettings</td>
 222             <td>true <em>or</em> false</td>
 223             <td>Shows the feature settings window when starting the applet</td>
 224           </tr>
 225           <tr>
 226             <td>showfeaturegroups</td>
 227             <td><em>separator</em> separated list of feature groups</td>
 228             <td>Display the features in the given groups on the alignment</td>
 229           </tr>
 230           <tr>
 231             <td>hidefeaturegroups</td>
 232             <td><em>separator</em> separated list of feature groups</td>
 233             <td>Hide the features in the given groups on the alignment
 234             (will be overridden by showfeaturegroups for group names
 235             found in both lists)</td>
 236           </tr>
 237           <tr>
 238             <td>application_url</td>
 239             <td><p><em>URL of dynamic JNLP servlet,</em></p>
 240               <p>http://www.jalview.org/services/launchApp</p></td>
 241             <td>Launches full application with original alignment, features and
 242               annotations files used in applet</td>
 243           </tr>
 244           <tr>
 245           <td>separator</td>
 246           <td><em>non-empty separator string</em><br>default: |</td>
 247           <td>string used to separate fields in list parameters (such as <em>showfeaturegroups</em>)</td>
 248           </tr>
 249           <tr><td>debug</td>
 250           <td>true</td>
 251           <td>Instruct the applet to output additional debug messages to the java console</td>
 252           </tr>
 253           <tr><td>nojmol</td>
 254           <td>false</td>
 255           <td>When set, do not try to find Jmol classes. Set this to supress URL not found errors appearing
 256           in server logs when Jmol is not available.
 257           </td>
 258           </tr>
 259           <tr><td>showbutton</td>
 260           <td>true</td>
 261           <td>Show the jalview button on the page. When false, JalviewLite will open immediately.</td>
 262           </tr>
 263           </tr>
 264                   <tr><td>sortByTree</td>
 265                   <td>true or false (default is false)</td>
 266                   <td>automatically sort the associated alignment view by the tree when a new tree is opened.</td>
 267                   </tr>
 268                   <tr>
 269                    <td>showTreeBootstraps</td><td>true or false (default is true)</td><td>show or hide branch bootstraps</td>
 270                         </tr>
 271         <tr><td>showTreeDistances</td><td>true or false (default is true)</td><td>show or hide branch lengths</td></tr>
 272         <tr><td>showUnlinkedTreeNodes</td><td>true or false (default is false)</td><td>indicate if unassociated nodes should be highlighted in the tree view</td>
 273         </tr>
 274           <tr><td>heightScale</td>
 275           <td>1.0 or greater</td>
 276           <td>Adjust the height of each cell in the alignment grid relative to the height of a character in the alignment font. (<em>since 2.5.1</em>)</td>
 277           </tr>
 278           <tr><td>widthScale</td>
 279           <td>1.0 or greater</td>
 280           <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>
 281           </tr>
 282           <tr><td>scaleProteinAsCdna</td><td>true or false (default is false)</td>
 283           <td>Set true to shown protein residues the same width as their encoding codons.
 284           For use with parameter file2 when showing a split frame of cDNA and protein. (<em>since 2.9</em>)</td></tr>
 285           <tr><td>centrecolumnlabels</td>
 286           <td>true or false (default is false)</td>
 287           <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>
 288           <tr><td>showUnconserved</td>
 289           <td>true or false (default is false)</td>
 290           <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>
 291           </tr>
 292           <tr><td>upperCase</td>
 293           <td><em>bold</em> or other value</td>
 294           <td>Indicate a text style to apply to uppercase sequence symbols. Currently, only <strong>bold</strong> is supported.</td>
 295           </tr>
 296           <tr><td>automaticScrolling</td>
 297           <td>true or false (default is true)</td>
 298           <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>
 299           </tr>
 300
 301           <tr><td>showGroupConsensus</td>
 302           <td>true or false (default is false)</td>
 303           <td>When true, shows consensus annotation row for any groups on the alignment. (<em>since 2.7</em>)</td>
 304           </tr>
 305
 306           <tr><td>showGroupConservation</td>
 307           <td>true or false (default is false)</td>
 308           <td>When true, shows amino-acid property conservation annotation row for any groups on the alignment. (<em>since 2.7</em>)</td>
 309           </tr>
 310           <tr><td>showConsensusHistogram</td>
 311           <td>true or false (default is true)</td>
 312           <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>
 313           </tr>
 314           <tr><td>showSequenceLogo</td>
 315           <td>true or false (default is false)</td>
 316           <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>
 317           </tr>
 318           <tr><td>normaliseSequenceLogo</td>
 319           <td>true or false (default is false)</td>
 320           <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>
 321           </tr>
 322           <tr><td>oninit</td>
 323           <td><em>after_init()</em></td>
 324           <td>name of javascript function that will be called after the jalviewLite instance has completed its initialisation. (<em>since 2.7</em>)</td>
 325           </tr>
 326           <tr><td>relaxedidmatch</td>
 327           <td><em>true or false (default is false)</em></td>
 328           <td>When true, use stem based matching to identify sequences that match features imported from a GFF or Jalview sequence features file, and for associating PDB data (passed on PDBfile parguments) with sequences (based on a given destination sequence ID). (<em>since 2.7</em>)</td>
 329           </tr>
 330           <tr><td>alignpdbfiles</td>
 331           <td><em>true or false (default is false)</em></td>
 332           <td>When true, and jalviewLite is able to use jmol as a structure viewer, attempt to show a superposition of all structures loaded onto the alignment, superimposed using the aligned regions of corresponding sequences. [experimental] (<em>since 2.7</em>)</td>
 333           </tr>
 334           <tr><td>externalstructureviewer</td>
 335           <td><em>true or false (default is false)</em></td>
 336           <td>re-route jmol colouring commands, selection and mouseover events to an external viewer using javascript callbacks. [experimental] (<em>since 2.7</em>)</td>
 337
 338           </tr>
 339           <tr><td>annotationcolour_max</td>
 340           <td>colour name or RGB hex triplet (default is red)</td>
 341           <td>Default colour used for maximum value when shading by annotation. (<em>since 2.7</em>)</td>
 342           </tr>
 343           <tr><td>annotationcolour_min</td>
 344           <td>colour name or RGB hex triplet (default is orange)</td>
 345           <td>Default colour used for minimum value when shading by annotation. (<em>since 2.7</em>)</td>
 346           </tr>
 347           <tr><td>jalviewhelpurl</td>
 348           <td>absolute or relative url or javascript function prefixed by <em>javascript:</em> (default is http://www.jalview.org/help.html)</td>
 349           <td>Optional parameter allowing modification of the default Jalview Help URL normally opened when JalviewLite's 'Help' menu item is selected. (<em>since 2.7</em>)</td>
 350           </tr>
 351           <tr><td>resolvetocodebase</td>
 352           <td>True or False (False)</td>
 353           <td>Set to true to re-instate pre-JalviewLite 2.7 behaviour where relative URLs were prepended with the applet 'codebase' rather than the current document base URL before resolution. (<em>since 2.7</em>)</td>
 354           </tr>
 355           <tr><td>scoreFile</td>
 356           <td>file</td>
 357           <td>Multiple sequences aligment scores file. Currently is supported only the T-Coffee score_ascii file format</td>
 358           </tr>
 359                   </table>
 360                   <!-- content end -->