JAL-1551 spotlessApply
[jalview.git] / help / 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> in an alignment
31                 window to open the feature settings dialog box, which allows
32                 precise control of the visibility and appearance of sequence features for
33                 an alignment view.
34         </p>
35         <div align="center">
36     <img src="featureSettings.png" width="400"> <br/>
37     Sequence Feature Settings for the Jalview Application (version 2.11)
38   </div>
39         <p>The top section of the dialog box lists all the sequence feature
40                 groups, along with a tickbox for each that controls whether its
41                 features are displayed. When many groups are present, their names may
42                 be truncated, but the full name is shown in a tooltip when the mouse
43                 hovers over their checkbox.</p>
44                 <p><em>Feature colour schemes and filters</em>
45         <p>
46                 The table in the middle lists all the feature types in the currently
47                 selected groups, along with their display style, any configured
48                 filters, and a tickbox indicating whether the type is enabled for
49                 display.</p><p>Features may be highlighted with either a single colour or a <a
50       href="featureschemes.html">feature colourscheme</a> based on
51     either the scores associated with that feature or from the feature's
52     description (e.g. to distinguish different names associated with a
53     DOMAIN feature).The colour used for a feature can
54                                 be changed by clicking on its <strong><em>colour box</em></strong>. To configure the shading
55                                 style or filter for a feature, click its <strong><em>configuration</em></strong> box.
56         </p>
57           <p>
58     <em>Feature settings pop-up menu</em><br> <strong>Right-click</strong>
59     on a feature to open a pop-up menu that allows you to
60   <ul>
61     <li>Hide, show and select columns containing that feature</li>
62     <li>Sort the alignment or current selection according to count or score for that feature
63       type (see below)</li>
64   </ul>
65
66         <p>
67                 <strong>Transparency and Feature Ordering</strong>
68         </p>
69         <p>Sequence features represent a variety of different types of
70                 positional annotation, and often overlap. For example, a metal binding
71                 site feature may be attached to one position along a stretch of
72                 sequence marked with a secondary structure feature.</p>
73         <p>
74     The ordering of the sequence features in the dialog box list is the
75     order used by Jalview for rendering sequence features. A feature at
76     the bottom of the list is rendered <em>below</em> a feature higher
77     up in the list.<br> <em><strong>You can change
78         the order of a feature by dragging it up and down the list with
79         the mouse.</strong></em>
80   </p>
81         <p>
82                 Use the <strong><em>Optimise order</em></strong> button to adjust the
83                 feature render ordering to place features that on average cover shorter regions
84                 of sequence above features annotating longer regions.
85         </p>
86         <p><a name="transparency"></a>
87     The <strong><em>transparency slider</em></strong> controls
88     the visibility of features rendered below other features. Reducing
89     the transparency will mean that features at the top of the list can
90     obscure features lower down, and increasing it allows the user to
91     'see through' the upper layers of a set of features.
92   </p>
93   <p>
94     <strong><em>You can save all features, with their
95         current colours and visibility in a Jalview format file.  </em></strong>
96   </p>
97   <p>
98     <a name="selectbyfeature"><strong>Selecting alignment
99         columns by feature</strong></a>
100   </p>
101   <p>
102                 Double-clicking a <strong>feature type</strong> in the <strong>Feature
103                         Settings</strong> dialog allows you to select columns in the
104                 alignment that contain (or do not contain) features of that type that
105                 are currently visible (e.g. not filtered out or otherwise excluded due
106                 to an applied colour scheme threshold). If a region of the alignment
107                 is currently selected, then only features in the current selection
108                 will be searched. The following keys affect the way in which
109                 selections are made:<ul>
110     <li>Hold down <strong>Alt</strong> to select columns not
111       containing features of a particular type.
112     </li>
113     <li>Hold down <strong>Shift</strong> to add columns to the
114       current selection.
115     </li>
116     <li>Press <strong>Command/Windows key</strong> to toggle column
117       selection state (XOR)
118     </li>
119   </ul>
120   Options are also provided in the feature's pop-up menu (see below).
121   <br />
122   <em>Select columns by feature was added in Jalview 2.8.1</em>
123   </p>
124   <p>
125     <strong><a name="sortbyfeature">Ordering alignment by
126         features</a></strong>
127   </p>
128   <p>
129     The 'Seq Sort by Score' and 'Seq Sort by Density' buttons will sort
130     the alignment based on the average score or total number of
131     currently active features and groups on each sequence. A dialog box
132     is shown if there are no features to use for sorting sequences. To
133     order the alignment using a specific feature type, use the
134     <em>sort by ..</em> entries in the pop-up menu for that type.<br> <br>When
135     a selected region exists, only features lying within the columns
136     containing the selected region will be considered, but all sequences
137     (including those not selected) will be reordered.
138     <em>Feature sorting and graduated feature colouring were
139       introduced in Jalview 2.5</em>
140   </p>
141
142 </body>
143 </html>