JAL-1355 JAL-1503 update i18n note
[jalview.git] / help / html / features / featureschemes.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
4  * Copyright (C) 2014 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 of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18  * The Jalview Authors are detailed in the 'AUTHORS' file.
19 -->
20 <head>
21 <title>Sequence feature colour schemes</title>
22 </head>
23
24 <body>
25 <p><strong>Sequence feature colour schemes</strong></p>
26 <p>Jalview can visualize annotation present on parts of a sequence by
27 overlaying colours according to the annotation present at each position.
28 It allows features to be colored either according to type, or for a
29 particular type, according to an individual feature's associated label
30 or score. The <a href="featuresettings.html">Feature Settings dialog
31 box</a> controls the order and display of each sequence annotation type, and
32 also allows the colour scheme used for the the feature to be changed <em>via</em>
33 the 'Graduated Colour' option in the sequence feature pop-up menu
34 (obtained by right-clicking on a sequence feature).</p>
35
36 <center><img src="featurecoloursettings.gif"><br/>Graduated
37 feature colour scheme settings dialog box</img></center>
38 <p>The Graduated Feature Colour dialog box has the following
39 controls:
40 <ul>
41         <li><em>Colour by Label</em> - when checked this derives a colour
42         for each feature based on the label text.</li>
43         <li><em>Min and Max Color boxes</em> - Click on these boxes to set
44         the minimum and maximum colours used to shade features by their
45         associated score.</li>
46         <li><em>Threshold type combo box</em> - Allows features to be
47         hidden features if their score is below or above a given threshold.<br />
48         <em>Set the threshold using the slider or type it in to the text
49         box. The threshold cannot be set outside the available range of feature
50         scores.</em>
51         </li>
52         <li><em>Threshold is Min/Max</em> - When checked, the threshold
53         will be used as the upper or lower limit when shading the features
54         according to their score using the Min and Max colour.</li>
55 </ul>
56 </p>
57 <p><strong>Icon styles for graduated feature styles</strong><br/>
58 <p>When a graduated colourscheme is applied to a feature, it is indicated in the feature settings or amend feature dialog box by the following types of icon:<br/>
59 <center><table width="50%" border="1">
60 <tr><td><strong>Type of Colouring</strong></td><td><strong>Icon</strong></td></tr>
61 <tr><td><em>Graduated colour by Feature Score</em></td><td><img src="fcsminmax.gif"/></td></tr>
62 <tr><td><em>Graduated colour thresholded (less than) by feature Score</em></td><td><img src="fcsltthan.gif"/></td></tr>
63 <tr><td><em>Graduated colour thresholded (greater than) by feature Score</em></td><td><img src="fcsgtthan.gif"/></td></tr>
64 <tr><td><em>Colour by Feature Label (may also be thresholded)</em></td><td><img src="fcsntlabel.gif"/></td></tr>
65 <tr>
66         <td align="center" colspan="2">
67                 <em>
68                         <strong>The current threshold is given in the
69         icon's tooltip.</strong>
70                 </em>
71         </td></tr></table></center></p>
72 <em>Graduated feature colours were introduced in Jalview 2.5</em>
73 </body>
74 </html>