3
<!-- This file has been generated by unroff 1.0, 03/01/02 09:13:43. -->
5
<STYLE TYPE="text/css">
7
A:link{text-decoration:none}
8
A:visited{text-decoration:none}
9
A:active{text-decoration:none}
12
<title>ploticus: proc legend</title>
13
<body bgcolor=D0D0EE vlink=0000FF>
17
<table cellpadding=2 bgcolor=FFFFFF width=550 ><tr>
19
<table cellpadding=2 width=550><tr>
20
<td><br><h2>proc legend</h2></td>
23
<a href="../doc/Welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
24
<a href="../doc/Welcome.html">Welcome</a>
25
<a href="../gallery/index.html">Gallery</a>
26
<a href="../doc/Contents.html">Handbook</a>
33
<title>Manual page for proc_legend(PL)</title>
38
<img src="../gallery/legend0.gif">
42
Renders a legend.<tt> </tt>
43
<b>proc legend</b> uses entries that you must have already supplied in
44
previous plotting procs (usually in an attribute called <tt>legendlabel</tt>).<tt> </tt>
45
You can also explicitly define legend entries using
46
<a href="legendentry.html">
49
one or more times. If this is not clear, check the example.<tt> </tt>
51
For bars, each legend entry is shown with a small square sample of color.<tt> </tt>
52
For lineplot and curvefit, a small segment of the line is shown.<tt> </tt>
53
For scatterplot, a symbol is shown.<tt> </tt>
54
By default, legend entries are presented in the order that the plotting procs (or
55
<a href="legendentry.html">
58
invocations) were executed.<tt> </tt>
59
The order can be reversed (<tt>reverseorder</tt>) or controlled explicitly
60
(<tt>specifyorder</tt>) if desired.<tt> </tt>
62
Legend entries may be displayed one per line, or all on the same line (<tt>format</tt>).<tt> </tt>
65
<a href="clickmap.html">
68
is being generated, legend entries may be mapped to URLs. See
69
<a href="clickmap.html">
72
for details.<tt> </tt>
74
After the legend is rendered, the internal list of legend entries is normally
75
cleared (this can be suppressed using the <tt>noclear</tt> attribute).<tt> </tt>
76
It is also possible to clear the internal list without rendering any
77
legend using the <tt>reset</tt> attribute.<tt> </tt>
81
See the Gallery Legends examples
82
<a href="../gallery/gall.legend.html"><img src="../gallery/btn/here.gif"></a>
84
<h2>PREREQUISITES</h2>
85
Plotting proc(s) containing a <tt>legendlabel</tt> specification,
86
and/or <b>proc legendentry</b> must have already been executed.<tt> </tt>
89
<h2>MANDATORY ATTRIBUTES</h2>
96
<b>format</b> <tt>multiline</tt> | <tt>singleline</tt>
99
Controls the overall format of the legend.<tt> </tt>
100
<tt>multiline</tt> gives entries that are placed downward on multiple lines.<tt> </tt>
101
<tt>singleline</tt> gives entries that are placed across all on the same line.<tt> </tt>
103
Example: <tt>format: singleline</tt>
108
<a href="attributetypes.html#xy">
113
Location for the legend.
114
<i>x</i> will correspond to the beginning of the label (line segments,
115
color squares, etc. will appear to the left of this).<tt> </tt>
116
<i>y</i> will correspond to the top of the legend.<tt> </tt>
118
Example: <tt>location: min+1.0 max</tt>
123
<a href="textdetails.html">
128
Details regarding the rendering of the legend text entries.<tt> </tt>
135
Amount of separation between entries.
136
<a href="attributetypes.html#positionunits">
137
Absolute units.<tt> </tt>
142
<b>seglen</b> <i>n</i>
145
If specified, controls the length of line segments.<tt> </tt>
146
<a href="attributetypes.html#positionunits">
147
Absolute units.<tt> </tt>
152
<b>swatchsize</b> <i>n</i>
155
If specified, controls the size of color sample square.<tt> </tt>
156
<i>n</i> is the length of one side in
157
<a href="attributetypes.html#positionunits">
158
absolute units.<tt> </tt>
163
<b>outlinecolors</b> <tt>yes</tt> | <tt>no</tt>
166
If <tt>yes</tt>, color samples will be outlined.<tt> </tt>
167
Normally they are not, except for white.<tt> </tt>
172
<a href="attributetypes.html#text">
173
<i> multiline-text </i>
177
If specified, allows the order of legend entries to be controlled
178
explicitly. Also allows entries to selected/omitted.<tt> </tt>
179
(Normally, entries are rendered in the order that they were added
180
and all entries are rendered.)
181
<i>multilinetext</i> should have one line for each entry to appear in the legend.<tt> </tt>
182
Each line will be compared against all defined legend labels.
183
Upon a match, that entry will be rendered.<tt> </tt>
184
The comparison is case-insensitive.<tt> </tt>
185
Only the first few characters (enough to uniquely match) need be given
186
in the <tt>specifyorder</tt> attribute.<tt> </tt>
198
<tt></tt>Other Gallery examples:
199
<a href="../gallery/timeline2.htm">
203
<a href="../gallery/km2.htm">
209
<b>reverseorder</b> <tt>yes</tt> | <tt>no</tt>
212
If <tt>yes</tt>, entries are rendered from last to first.<tt> </tt>
216
<b>colortext</b> <tt>yes</tt> | <tt>no</tt>
219
If <tt>yes</tt>, entry text inherits the color of the
220
sample. Normally it does not.<tt> </tt>
221
<a href="../gallery/colorfld.htm">
227
<b>noclear</b> <tt>yes</tt> | <tt>no</tt>
230
If <tt>yes</tt>, the defined legend entries list is not cleared.<tt> </tt>
231
Normally they are cleared out after the legend has been rendered.<tt> </tt>
232
This is useful in rendering multi-column legends.<tt> </tt>
234
Example: this is used in Gallery example
235
<a href="../gallery/propbars1.htm">
244
If specified, no legend will be rendered and the internal list
245
of legend entries will be cleared. This might be useful in situations
246
where a number of cloned plots (and cloned legendentries) are being
247
done, but only one actual legend is desired.
253
<a href="../doc/Welcome.html">
254
<img src="../doc/ploticus.gif" border=0></a><br><small>data display engine <br>
255
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
259
<img src="../gallery/all.gif">
265
Markup created by <em>unroff</em> 1.0, <tt> </tt> <tt> </tt>March 01, 2002.
added
removed
doc/legend.html
