JAL-2416 score matrix gap symbol (if any) dynamically determined
[jalview.git] / help / html / features / featureschemes.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>Sequence feature colour schemes</title>
24 </head>
25
26 <body>
27   <p>
28     <strong>Sequence feature colour schemes</strong>
29   </p>
30   <p>
31     Jalview can visualize annotation present on parts of a sequence by
32     overlaying colours according to the annotation present at each
33     position. It allows features to be colored either according to type,
34     or for a particular type, according to an individual feature's
35     associated label or score. The <a href="featuresettings.html">Feature
36       Settings dialog box</a> controls the order and display of each
37     sequence annotation type, and also allows the colour scheme used for
38     the the feature to be changed <em>via</em> the 'Graduated Colour'
39     option in the sequence feature pop-up menu (obtained by
40     right-clicking on a sequence feature).
41   </p>
42
43   <center>
44     <img src="featurecoloursettings.gif"><br />Graduated feature
45     colour scheme settings dialog box</img>
46   </center>
47   <p>The Graduated Feature Colour dialog box has the following
48     controls:
49   <ul>
50     <li><em>Colour by Label</em> - when checked this derives a
51       colour for each feature based on the label text.</li>
52     <li><em>Min and Max Color boxes</em> - Click on these boxes to
53       set the minimum and maximum colours used to shade features by
54       their associated score.</li>
55     <li><em>Threshold type combo box</em> - Allows features to be
56       hidden features if their score is below or above a given
57       threshold.<br /> <em>Set the threshold using the slider or
58         type it in to the text box. The threshold cannot be set outside
59         the available range of feature scores.</em></li>
60     <li><em>Threshold is Min/Max</em> - When checked, the threshold
61       will be used as the upper or lower limit when shading the features
62       according to their score using the Min and Max colour.</li>
63   </ul>
64   </p>
65   <p>
66     <strong>Icon styles for graduated feature styles</strong><br />
67   <p>
68     When a graduated colourscheme is applied to a feature, it is
69     indicated in the feature settings or amend feature dialog box by the
70     following types of icon:<br />
71   <center>
72     <table width="50%" border="1">
73       <tr>
74         <td><strong>Type of Colouring</strong></td>
75         <td><strong>Icon</strong></td>
76       </tr>
77       <tr>
78         <td><em>Graduated colour by Feature Score</em></td>
79         <td><img src="fcsminmax.gif" /></td>
80       </tr>
81       <tr>
82         <td><em>Graduated colour thresholded (less than) by
83             feature Score</em></td>
84         <td><img src="fcsltthan.gif" /></td>
85       </tr>
86       <tr>
87         <td><em>Graduated colour thresholded (greater than) by
88             feature Score</em></td>
89         <td><img src="fcsgtthan.gif" /></td>
90       </tr>
91       <tr>
92         <td><em>Colour by Feature Label (may also be
93             thresholded)</em></td>
94         <td><img src="fcsntlabel.gif" /></td>
95       </tr>
96       <tr>
97         <td align="center" colspan="2"><em> <strong>The
98               current threshold is given in the icon's tooltip.</strong>
99         </em></td>
100       </tr>
101     </table>
102   </center>
103   </p>
104   <em>Graduated feature colours were introduced in Jalview 2.5</em>
105 </body>
106 </html>