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