JAL-1445 updated documentation and added link in whatsNew
[jalview.git] / help / html / features / featuresettings.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
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 Settings Dialog Box</title>
22 </head>
23 <body>
24 <p><strong>Sequence Feature Settings Dialog Box</strong></p>
25 <p>Select <strong>View&#8594;Feature Settings...</strong> menu entry
26 in an alignment window to open the feature settings dialog box, which
27 allows you to precisely control the presence and appearance of sequence
28 features for the current alignment.</p>
29 <center><img src="featureSettings.gif" width="400" height="452">
30 <br>
31 Sequence Feature Settings for the Jalview Application</img></center>
32 <p>The top section of the dialog box lists all the sequence feature
33 groups, along with a tickbox for each that controls whether its features
34 are displayed. The table in the middle lists all the features in the
35 currently selected groups, along with their display style and whether
36 they are currently being displayed (only the ticked features and groups
37 are displayed). <strong><em>You can change the colour or
38 shading style used for a feature in the associated alignment by clicking
39 on its colour box.</em></strong></p>
40         <p>
41                 <a name="selectbyfeature"><strong><em>Selecting
42                                         alignment columns by feature</em></strong></a><br> <strong>Double-clicking
43                         a feature type</strong> allows you to select columns in the alignment that
44                 contain (or do not contain) features of that type. If a region of the
45                 alignment is currently selected, then only features in the current
46                 selection will be searched. The following keys affect the way in which
47                 selections are made:
48         
49         <ul>
50                 <li>Hold down <strong>Alt</strong> to select columns not
51                         containing features of a particular type.
52                 </li>
53                 <li>Hold down <strong>Shift</strong> to add columns to the
54                         current selection.
55                 </li>
56                 <li>Press <strong>Command/Windows key</strong> to toggle column
57                         selection state (XOR)
58                 </li>
59         </ul>
60         Options are also provided in the feature's pop-up menu (see below).
61         <br />
62         <em>Select columns by feature was added in Jalview 2.8.1</em>
63         </p>
64   <p><strong><em>Feature settings pop-up menu</em></strong><br>
65 <strong>Right-click</strong> on a feature to open a pop-up menu that
66 allows you to sort the alignment or current selection using that feature
67 type (see below), or toggle the type of colouring used for the feature.
68 Features may be highlighted with either a single colour or a <a
69         href="featureschemes.html">feature colourscheme</a> based on either the
70 scores associated with that feature or from the feature's description
71 (e.g. to distinguish different names associated with a DOMAIN feature).</p>
72 <p><strong>Ordering alignment by features</strong><br>
73 The 'Seq Sort by Score' and 'Seq Sort by Density' buttons will sort the
74 alignment based on the average score or total number of currently active
75 features and groups on each sequence. To order the alignment using a
76 specific feature type, use the <em>sort by ..</em> entries in the pop-up
77 menu for that type.<br>
78 <em>Feature sorting and graduated feature colouring was introduced
79 in jalview 2.5</em></p>
80
81 <p><strong>Transparency and Feature Ordering</strong></p>
82 <p>It is important to realise that sequence features are often not
83 distinct and often overlap (for example, a metal binding site feature
84 may be attached to one position along a stretch of sequence marked with
85 a secondary structure feature).</p>
86 <p>The ordering of the sequence features in the dialog box list is
87 the order used by jalview for rendering sequence features. A feature at
88 the bottom of the list is rendered <em>below</em> a feature higher up in
89 the list.<br>
90 <em><strong>You can change the order of a feature by
91 dragging it up and down the list with the mouse</strong></em>.</p>
92 <p>The <strong><em>Optimise order</em></strong> button (currently
93 only available in the application) will re-order the feature render
94 ordering based on the average length of each feature type.</p>
95 <p>The <strong><em>transparency slider setting</em></strong>
96 (currently only available in the application version) controls the
97 visibility of features rendered below other features. Reducing the
98 transparency will mean that features at the top of the list can obscure
99 features lower down, and increasing it allows the user to 'see through'
100 the upper layers of a set of features.</p>
101 <p><strong><em>You can save all features, with their
102 current colours and visibility in a Jalview format file. </em></strong></p>
103 </body>
104 </html>