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