File: annotate.html

package info (click to toggle)
ploticus 2.0.3-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 3,696 kB
  • ctags: 2,035
  • sloc: ansic: 40,100; perl: 456; sh: 186; makefile: 129
file content (334 lines) | stat: -rw-r--r-- 7,299 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<html>
<head>
<!-- This file has been generated by unroff 1.0, 03/04/02 11:12:20. -->
<!-- Do not edit! -->
<STYLE TYPE="text/css">
<!--
        A:link{text-decoration:none}
        A:visited{text-decoration:none}
        A:active{text-decoration:none}
-->
</STYLE>
<title>ploticus: proc annotate</title>
<body bgcolor=D0D0EE vlink=0000FF>
<br>
<br>
<center>
<table cellpadding=2 bgcolor=FFFFFF width=550 ><tr>
<td>
  <table cellpadding=2 width=550><tr>
  <td><br><h2>proc annotate</h2></td>
  <td align=right>
  <small>
  <a href="../doc/Welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
  <a href="../doc/Welcome.html">Welcome</a> &nbsp; &nbsp;
  <a href="../gallery/index.html">Gallery</a> &nbsp; &nbsp;
  <a href="../doc/Contents.html">Handbook</a> 
  <td></tr></table>
</td></tr>
<td>
<br>
<br>

<title>Manual page for proc_annotate(PL)</title>
</head>
<body>

<h2>DESCRIPTION</h2>
<b>proc annotate</b> may be used to place arbitrary text at 
specific locations, in either absolute space or scaled space.<tt> </tt>
Annotation may include one or two arrows and a box if desired.<tt> </tt>

<br><br><br>
<h2>FEATURES</h2>
Text may be single line or multiple lines.<tt> </tt>
Optional backing box for text, that can be colored, outlined,
and have a bevel or drop shadow.<tt> </tt>
Semi-intelligent placement of one or two arrows.<tt> </tt>
Control over text and arrow color.<tt> </tt>
<a href="clickmap.html">
 HTML clickmap support
</a>
for annotations box.<tt> </tt>

<br><br><br>
<h2>EXAMPLES</h2>
See the Gallery Annotations examples
<a href="../gallery/gall.annot.html"><img src="../gallery/btn/here.gif"></a>

<br><br><br>
<h2>PREREQUISITES</h2>
None.<tt> </tt>

<br><br><br>
<h2>MANDATORY ATTRIBUTES</h2>
The <tt>text</tt> and <tt>location</tt> attributes MUST be specified.<tt> </tt>
If an arrow is desired, the <tt>arrowhead</tt> attribute must be specified.<tt> </tt>

<br><br><br>
<h2>ATTRIBUTES</h2>
<p>
<b>text</b> 
<a href="attributetypes.html#text">
 multiline text
</a>
<dl>
<dt><dd><p>
The text to be displayed.  Terminates with a blank line.<tt> </tt>
Text may also come from a file or command (see below).<tt> </tt>
<br>
Example:
<pre>
text:	Value
	as of 1/15/99

</pre>
</dl>
<p>
<b>location</b> 
<a href="attributetypes.html#xy">
 x y
</a>
<dl>
<dt><dd><p>
The text will be placed at this location.<tt> </tt>
By default the text will be centered around X, and
the bottom of the first line will be at Y.<tt> </tt>
Absolute units are assumed;
append <tt>(s)</tt> to one or both values to indicate scaled units.  
<br>
Example: <tt>location: 2.2(s) 3.0</tt>


</dl>
<p>
<b>arrowhead</b> 
<a href="attributetypes.html#xy">
 x y
</a>
<dl>
<dt><dd><p>
If specified, an arrow will be drawn pointing at this location.<tt> </tt>
The tail of the arrow will be placed automatically if <tt>arrowtail</tt>
is not specified.<tt> </tt>
Absolute units are assumed;
append <tt>(s)</tt> to one or both values to indicate scaled units.  
<br>
Example: <tt>arrowhead: 2012(s) 85(s)</tt>

</dl>
<p>
<b>arrowhead2</b> 
<a href="attributetypes.html#xy">
 x y
</a>
<dl>
<dt><dd><p>
Same as <tt>arrowhead</tt> above, for a second arrow.<tt> </tt>

<br><br><br>
</dl>
<h2>DETAIL ATTRIBUTES</h2>
<p>
<b>fromfile</b> <i>filename</i>
<dl>
<dt><dd><p>
If specified, the text will be read from this file.<tt> </tt>
This filename is expanded by a shell.<tt> </tt>

</dl>
<p>
<b>fromcommand</b> <i>shell command</i>
<dl>
<dt><dd><p>
If specified, this shell command will be executed to yield 
text on its standard output.<tt> </tt>

</dl>
<p>
<b>textdetails</b> 
<a href="attributetypes.html#textdetails">
 textdetails
</a>
<dl>
<dt><dd><p>
Allows control of details pertaining to the text, such as alignment, color, size, and font.<tt> </tt>
Example: <tt>textdetails: align=C size=9</tt>

</dl>
<p>
<b>box</b> 
<a href="attributetypes.html#linedetails">
 linedetails
</a>
<dl>
<dt><dd><p>
If specified, a box will be drawn around the text.<tt> </tt>
May be used with or without <tt>backcolor</tt>.<tt> </tt>
<br>
Example: <tt>box: yes</tt>  (do a default box)
<br>
Example: <tt>box: color=yellow width=1.0</tt>

</dl>
<p>
<b>boxmargin</b> <i>n</i>
<dl>
<dt><dd><p>
If specified, increase the size of any backing box by
<i>n</i> absolute units on all four sides. 
<br>
Example: boxmargin: 0.15

</dl>
<p>
<b>backcolor</b> 
<a href="color.html">
 color
</a>
<dl>
<dt><dd><p>
Supply a colored rectangle backing box, to be filled with <i>color</i>.<tt> </tt>
No box outline is drawn, use <tt>box</tt> to get one.<tt> </tt>
May be used with or without <tt>box</tt>.<tt> </tt>

</dl>
<p>
<b>arrowdetails</b> 
<a href="linedetails.html">
 linedetails
</a>
<dl>
<dt><dd><p>
Allows control of details pertaining to the arrows, such as line thickness and color.<tt> </tt>

</dl>
<p>
<b>arrowheadsize</b> <i>n</i>
<dl>
<dt><dd><p>
Controls the size of the arrowhead.  
<i>n</i> is the length of the arrowhead in absolute units (default 0.1 inches).<tt> </tt>
This attribute may be set to 0 to suppress arrowhead and just draw line.<tt> </tt>

</dl>
<p>
<b>arrowtail</b> 
<a href="attributetypes.html#xy">
 x y
</a>
<dl>
<dt><dd><p>
If specified, tail of 1st arrow will be at this point.  

</dl>
<p>
<b>arrowtail2</b> 
<a href="attributetypes.html#xy">
 x y
</a>
<dl>
<dt><dd><p>
If specified, tail of 2nd arrow will be at this point.  

</dl>
<p>
<b>verttext</b>  <tt>yes</tt> | <tt>no</tt>
<dl>
<dt><dd><p>
If <tt>yes</tt>, text will be rendered vertically, from low to high.<tt> </tt>
This is a limited implementation;
backing box does not work with vertical text, nor does
automatic arrow tail placement (arrow tail must be specified).<tt> </tt>

</dl>
<p>
<b>clickmapurl</b> <i>url</i>
<dl>
<dt><dd><p>
If generating an
<a href="clickmap.html">
 HTML clickmap
</a>
on the attribute box,
this specifies a url.<tt> </tt>
See
<a href="clickmap.html">
 HTML clickmap
</a>
for more details and examples.<tt> </tt>
<br>
Example: <tt>clickmapurl: http://abc.com/docs/explanation.html</tt>

<br><br><br>

</dl>
<h2>Pertaining to optional bevel &amp; drop shadow</h2>
<p>
<b>bevelsize</b> <i>n</i>
<dl>
<dt><dd><p>
Width of optional bevel area, in
<a href="attributetypes.html#positionunits">
 absolute units.<tt> </tt>
</a>
Default is <tt>0.0</tt> (no bevel).<tt> </tt>

</dl>
<p>
<b>shadowsize</b> <i>n</i>
<dl>
<dt><dd><p>
Width of visible portion of optional drop shadow in absolute units.<tt> </tt>
Default is <tt>0.0</tt> (no drop shadow).<tt> </tt>

</dl>
<p>
<b>hibevelcolor</b>
<a href="color.html">
 color
</a>
<dl>
<dt><dd><p>
Color of upper and lefttmost bevels.  Default is <tt>gray(0.6)</tt>

</dl>
<p>
<b>lowbevelcolor</b>
<a href="color.html">
 color
</a>
<dl>
<dt><dd><p>
Color of lower and rightmost bevels.  Default is <tt>gray(0.8)</tt>

</dl>
<p>
<b>shadowcolor</b>
<a href="color.html">
 color
</a>
<dl>
<dt><dd><p>
Color of drop shadow.  Default is <tt>black</tt>.<tt> </tt>


<br>
<br>
</td></tr>
<td align=right>
<a href="../doc/Welcome.html">
<img src="../doc/ploticus.gif" border=0></a><br><small>data display engine &nbsp; <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif">
</center>
</td></tr>
</table>
</dl>
<p><hr>
Markup created by <em>unroff</em> 1.0,&#160;<tt> </tt>&#160;<tt> </tt>March 04, 2002.
</body>
</html>