Debian Codegraph @

docs/manual/chapters/legend.xml

raw
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 (C) Copyright 1996-2016 ECMWF.
4
5 This software is licensed under the terms of the Apache Licence Version 2.0
6 which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
7 In applying this licence, ECMWF does not waive the privileges and immunities
8 granted to it by virtue of its status as an intergovernmental organisation nor
9 does it submit to any jurisdiction.
10 -->
11
12 <chapter id="Legend_Plotting" label="13">
13 <title>Legend Plotting</title>
14
15 <xi:include href="../phrases/chapterinfo_mod.xml"
16 xmlns:xi="http://www.w3.org/2001/XInclude" />
17
18 <section id="Legend_Introduction">
19 <title>Introduction</title>
20
21 <para>Legends are an important part of any scientific plot. If enabled, <productname>Magics</productname>
22 tries to build a legend automatically from the data provided. In most cases this is
23 sufficient. Where not <productname>Magics</productname> offers further parameters to customise the legend.</para>
24
25
26 <important> <title>Magics++</title>
27 In previous versions of <productname>Magics</productname>, the legend parameter
28 <parameter>LEGEND_ENTRY_PLOT_DIRECTION</parameter> was automatically adjusted
29 to <code>COLUMN</code> or <code>ROW</code> depending on the aspect ratio of the
30 legend box.
31 After user feedback, it was decided to take this automatic adjustment out to give more control to users
32 in case of more complex legends. The default is now <code>ROW</code>.
33 If the legend box has a vertical layout, the user can set the
34 <parameter>LEGEND_ENTRY_PLOT_DIRECTION</parameter> parameter to <code>COLUMN</code>.
35 The parameter <parameter>LEGEND_COLUMN_COUNT</parameter> ( default=<code>1</code>)
36 will then define the numbers of columns to generate for the legend.
37 </important>
38
39 </section>
40
41
42 <xi:include href="../paramtables/legend_tables.xml"
43 xmlns:xi="http://www.w3.org/2001/XInclude" />
44
45 <xi:include href="../paramtables/LegendVisitor_legend_magml_tables.xml"
46 xmlns:xi="http://www.w3.org/2001/XInclude" />
47
48 <xi:include href="../paramtables/LegendVisitor_legend_magml_flat_tables.xml"
49 xmlns:xi="http://www.w3.org/2001/XInclude" />
50
51 </chapter>