help/html/menus/alwannotationpanel.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   5  *
   6  * This file is part of Jalview.
   7  *
   8  * Jalview is free software: you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation, either version 3
  11  * of the License, or (at your option) any later version.
  12  *
  13  * Jalview is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty
  15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  16  * PURPOSE.  See the GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  20  * The Jalview Authors are detailed in the 'AUTHORS' file.
  21  -->
  22 <head>
  23 <title>Annotation Panel Menus</title>
  24 </head>
  25 <body>
  26   <p>
  27     <strong>Annotation Panel Menus</strong>
  28   </p>
  29   <ul>
  30     <li><strong>Annotation Label Popup Menu</strong><br> <em>This
  31         menu is opened by clicking anywhere on the annotation row labels
  32         area (below the sequence ID area).</em>
  33       <ul>
  34         <li><strong>Add New Row</strong><br> <em>Adds a
  35             new, named annotation row (a dialog box will pop up for you
  36             to enter the label for the new row). </em></li>
  37         <li><strong>Edit Label/Description</strong><br> <em>This
  38             opens a dialog where you can change the name (displayed
  39             label), or the description (as shown on the label tooltip)
  40             of the clicked annotation. </em></li>
  41         <li><strong>Hide This Row</strong><br> <em>Hides
  42             the annotation row whose label was clicked in order to bring
  43             up the menu.</em></li>
  44         <li><strong>Hide All <em>&lt;label&gt;</em></strong><br>
  45           <em>Hides all annotation rows whose label matches the one
  46             clicked. (This option is only shown for annotations that
  47             relate to individual sequences, not for whole alignment
  48             annotations. Since Jalview 2.8.2.)</em></li>
  49         <li><strong>Delete Row</strong><br> <em>Deletes
  50             the annotation row whose label was clicked in order to bring
  51             up the menu.</em></li>
  52         <li><strong>Show All Hidden Rows</strong><br> <em>Shows
  53             all hidden annotation rows.</em></li>
  54         <li><strong>Export Annotation</strong> <em>(Application
  55             only)</em><br> <em>Annotations can be saved to file or
  56             output to a text window in either the Jalview annotations
  57             format or as a spreadsheet style set of comma separated
  58             values (CSV). </em></li>
  59         <li><strong>Show Values in Text Box</strong> <em>(applet
  60             only)</em><br> <em>Opens a text box with a list of
  61             comma-separated values corresponding to the annotation
  62             (numerical or otherwise) at each position in the row. This
  63             is useful to export alignment quality measurements for
  64             further analysis.</em></li>
  65       </ul> <em>The following additional entries are available when the
  66         popup menu is opened on a consensus sequence annotation row:</em>
  67       <ul>
  68
  69         <li><strong>Ignore Gaps in Consensus</strong><br> If
  70           this checkbox is selected, all consensus calculations
  71           performed in the current Alignment window will be done without
  72           counting gaps as a consensus character.</li>
  73         <li><strong>Show Consensus Histogram<br></strong>
  74           Enable or disable the display of the histogram above the
  75           consensus sequence.</li>
  76         <li><strong>Show Consensus Logo<br></strong> Enable or
  77           disable the display of the sequence logo above the consensus
  78           sequence.</li>
  79         <li><strong>Normalise Consensus Logo<br>
  80         </strong><em>When enabled, scales all logo stacks to the same
  81             height, making it easier to compare symbol diversity in
  82             highly variable regions.</em></li>
  83
  84         <li>
  85         <li><strong>Copy Consensus Sequence</strong><br>
  86           Copies the consensus sequence to the clipboard in Fasta
  87           format, to allow the consensus sequence to be added to an
  88           alignment. Note the copied sequence is not accessible to other
  89           programs if Jalview is running as an applet in a web page.</li>
  90       </ul></li>
  91     <li><strong>Annotation Popup Menu<br>
  92     </strong><em>This menu is opened when right-clicking on the selected
  93         positions of an annotation.</em>
  94       <ul>
  95         <li><strong>Helix</strong><br> <em>Mark selected
  96             positions with a helix glyph (a red oval), and optional text
  97             label (see below). Consecutive ovals will be rendered as an
  98             unbroken red line.</em></li>
  99         <li><strong>Sheet</strong><br> <em>Mark selected
 100             positions with a sheet glyph (a green arrow oriented from
 101             left to right), and optional text label (see below).
 102             Consecutive arrows will be joined together to form a single
 103             green arrow.</em></li>
 104         <li><strong>Label</strong><br> <em>Sets the text
 105             label at the selected positions. If more that one
 106             consecutive position is marked with the same label, only the
 107             first position's label will be rendered.</em></li>
 108         <li><strong>Colour</strong><br> <em>Changes the
 109             colour of the annotation text label.</em></li>
 110         <li><strong>Remove Annotation</strong><br> <em>Blanks
 111             any annotation at the selected positions on the row. Note: <strong>This
 112               cannot be undone</strong>
 113         </em></li>
 114       </ul></li>
 115   </ul>
 116 </body>
 117 </html>