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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
|
.ig >>
<STYLE TYPE="text/css">
<!--
A:link{text-decoration:none}
A:visited{text-decoration:none}
A:active{text-decoration:none}
OL,UL,P,BODY,TD,TR,TH,FORM { font-family: arial,helvetica,sans-serif;; font-size:small; color: #333333; }
H1 { font-size: x-large; font-family: arial,helvetica,sans-serif; }
H2 { font-size: large; font-family: arial,helvetica,sans-serif; }
H3 { font-size: medium; font-family: arial,helvetica,sans-serif; }
H4 { font-size: small; font-family: arial,helvetica,sans-serif; }
-->
</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>
Version 2.33 Jun'06
</small><br><a href="../doc/scripthome.html">Scripts</a>
<td></tr></table>
</td></tr>
<td>
<br>
<br>
.>>
.TH proc_annotate PL "02-JUN-2006 PL ploticus.sourceforge.net"
.ig >>
<center><a href="../gallery/gall.annot.html"><img src="../gallery/annot0.gif" border=0></a></center>
.>>
.LP
\fBproc annotate\fR may be used to place arbitrary text, arrows, circles, or ellipses at
specific locations, in either absolute space or scaled space.
Annotation may include one or two arrows.
See also the
.ig >>
<a href="../gallery/gall.annot.html">
.>>
\0gallery annotations examples.
.ig >>
</a>
.>>
.ig >>
<br><br><br>
.>>
.SH Hints
Specify positions in scaled units if possible.. this protects you from underlying position
shift.
You can get absolute locations by previewing a graph in X11 mode and clicking with the mouse...
coordinates will be written to standard error for each click... Then cut/paste these
into your script file for annotations.
To place multiple pieces of text (from field(s) in a data file for example),
.ig >>
<a href="scatterplot.html">
.>>
\0proc scatterplot
.ig >>
</a>
.>>
may be a better way to go than proc annotate.
.ig >>
<br><br><br>
.>>
.SH Attributes
.LP
\fBtext\fR
.ig >>
.>>
.ig >>
<a href="attributetypes.html#text">
.>>
\0multiline text
.ig >>
</a>
.>>
.IP \0
The text to be displayed. Terminates with a blank line.
Text may also come from a file or command (see below).
.br
Example:
.nf
.ft C
text: Value
as of 1/15/99
.fi
.LP
\fBtextdetails\fR
.ig >>
<a href="attributetypes.html#textdetails">
.>>
\0textdetails
.ig >>
</a>
.>>
.IP \0
Allows control of details pertaining to the text, such as alignment, color, size, and font.
Example: \fCtextdetails: align=C size=9\fR
.ig >>
<br><br>
.>>
.LP
\fBlocation\fR
.ig >>
.>>
.ig >>
<a href="attributetypes.html#xy">
.>>
\0x y
.ig >>
</a>
.>>
.IP \0
The text will be placed at this location.
By default the text will be centered around X, and
the bottom of the first line will be at Y.
Absolute units are assumed;
append \fC(s)\fR to one or both values to indicate scaled units.
.br
Example: \fClocation: 2.2(s) 3.0\fR
.ig >>
<br><br>
.>>
.LP
\fBclip\fR
.ig >>
.>>
\fCyes | no\fR
.IP \0
Default is \fCno\fR. If \fCyes\fR, the annotation may be cut off at the edge of the cropped graphic.
Useful in cases where an annotation may be out of bounds, and you'd rather omit it than increase the
cropped size to include it. (2.30+)
.ig >>
<br><br><br>
.>>
.SH Backing box or ellipse
Annotation may have a backing box (the default) or an ellipse.
It may be shaded and/or outlined.
.LP
\fBellipse\fR
.ig >>
.>>
\fCyes | no\fR
.IP \0
Default is \fCno\fR.
If \fCyes\fR, an elliptical backing region will be drawn instead of a box.
.ig >>
<br><br>
.>>
.LP
\fBbackcolor\fR
.ig >>
.>>
.ig >>
<a href="color.html">
.>>
\0color
.ig >>
</a>
.>>
.IP \0
If specified, a shaded box or ellipse will be rendered in the specified \fIcolor\fR.
Any annotation text will be rendered on top of the shaded region.
Specify \fCoutline\fR to encompass the backing region with a line.
.ig >>
<br><br>
.>>
.LP
\fBoutline\fR
.ig >>
.>>
.ig >>
<a href="attributetypes.html#linedetails">
.>>
\0linedetails
.ig >>
</a>
.>>
.IP \0
If specified, the backing box or ellipse will be outlined with a line of this type.
May be used with or without \fCbackcolor\fR.
.br
Example: \fCoutline: yes\fR (do a default box)
.br
Example: \fCoutline: color=yellow width=1.0\fR
.ig >>
<br><br>
.>>
.LP
\fBbox\fR
.ig >>
.>>
Same as \fBoutline\fR above. (Deprecated)
.ig >>
<br><br>
.>>
.LP
\fBboxmargin\fR
.ig >>
.>>
\fIn\fR
.IP \0
If specified, increase the size of any backing box or ellipse by
\fIn\fR absolute units on all four sides. A negative value decreases the size.
.br
Example: boxmargin: 0.15
.ig >>
<br><br>
.>>
.LP
\fBbackdim\fR
.ig >>
.>>
\fIa b c d\fR
.IP \0
This allows size and location of background box (or ellipse) to be explicitly
given, for situations where the automatic methods don't give satisfactory
results. For backing box, \fIa b\fR defines the upper left location of the box,
\fIc\fR determines the width, and \fId\fR the height.
For ellipse, \fIa b\fR defines the center, \fIc\fR the width, and \fId\fR the height.
\fIa\fR and \fIb\fR are
.ig >>
<a href="attributetypes.html#locvalue">
.>>
\0locvalues.
.ig >>
</a>
.>>
.ig >>
<br><br><br>
.>>
.SH Arrows
.LP
\fBarrowhead\fR
.ig >>
.>>
.ig >>
<a href="attributetypes.html#xy">
.>>
\0x y
.ig >>
</a>
.>>
.IP \0
If specified, an arrow will be drawn pointing at this location.
The tail of the arrow will be placed automatically if \fCarrowtail\fR
is not specified.
Absolute units are assumed;
append \fC(s)\fR to one or both values to indicate scaled units.
.br
Example: \fCarrowhead: 2012(s) 85(s)\fR
.ig >>
<br><br>
.>>
.LP
\fBarrowhead2\fR
.ig >>
.>>
.ig >>
<a href="attributetypes.html#xy">
.>>
\0x y
.ig >>
</a>
.>>
.IP \0
Same as \fCarrowhead\fR above, for a second arrow.
.ig >>
<br><br>
.>>
.LP
\fBarrowdetails\fR
.ig >>
.>>
.ig >>
<a href="linedetails.html">
.>>
\0linedetails
.ig >>
</a>
.>>
.IP \0
Allows control of details pertaining to the arrows, such as line thickness and color.
.ig >>
<br><br>
.>>
.LP
\fBarrowheadsize\fR
.ig >>
.>>
\fIn\fR
.IP \0
Controls the size of the arrowhead.
\fIn\fR is the length of the arrowhead in absolute units (default 0.1 inches).
This attribute may be set to 0 to suppress arrowhead and just draw line.
.ig >>
<br><br>
.>>
.LP
\fBarrowtail\fR
.ig >>
.>>
.ig >>
<a href="attributetypes.html#xy">
.>>
\0x y
.ig >>
</a>
.>>
.IP \0
If specified, tail of 1st arrow will be at this point.
Useful if automatic placement does not give acceptable results.
.ig >>
<br><br>
.>>
.LP
\fBarrowtail2\fR
.ig >>
.>>
.ig >>
<a href="attributetypes.html#xy">
.>>
\0x y
.ig >>
</a>
.>>
.IP \0
If specified, tail of 2nd arrow will be at this point.
Useful if automatic placement does not give acceptable results.
.ig >>
<br><br><br>
.>>
.SH Clickmap and mouseover
.LP
\fBclickmapurl\fR
.ig >>
.>>
\fIurl\fR
.IP \0
If generating an
.ig >>
<a href="clickmap.html">
.>>
\0HTML clickmap
.ig >>
</a>
.>>
on the attribute box,
this specifies a url.
See
.ig >>
<a href="clickmap.html">
.>>
\0HTML clickmap
.ig >>
</a>
.>>
for more details and examples.
.br
Example: \fCclickmapurl: http://abc.com/docs/explanation.html\fR
.ig >>
<br><br>
.>>
.LP
\fBclickmaplabel\fR
.ig >>
.>>
\fIlabel\fR
.IP
If generating a
.ig >>
<a href="clickmap.html">
.>>
\0client-side clickmap,
.ig >>
</a>
.>>
this specifies a mouseover text label.
.LP
\fBclickmaplabeltext\fR
.ig >>
.>>
.ig >>
<a href="attributetypes.html#text">
.>>
\0multiline text
.ig >>
</a>
.>>
.IP \0
Same as \fCclickmaplabel\fR but multiline text. Must be terminated with a blank line.
.ig >>
<br><br><br>
.>>
.SH Optional bevel / drop shadow
A bevel or drop shadow can be rendered along with a backing box
(but not a backing ellipse).
.LP
\fBbevelsize\fR
.ig >>
.>>
\fIn\fR
.IP \0
Width of optional bevel area, in
.ig >>
<a href="attributetypes.html#positionunits">
.>>
\0absolute units.
.ig >>
</a>
.>>
Default is \fC0.0\fR (no bevel).
.ig >>
<br><br>
.>>
.LP
\fBshadowsize\fR
.ig >>
.>>
\fIn\fR
.IP \0
Width of visible portion of optional drop shadow in absolute units.
Default is \fC0.0\fR (no drop shadow).
.ig >>
<br><br>
.>>
.LP
\fBhibevelcolor\fR
.ig >>
.>>
.ig >>
<a href="color.html">
.>>
\0color
.ig >>
</a>
.>>
.IP \0
Color of upper and lefttmost bevels. Default is \fCgray(0.6)\fR
.ig >>
<br><br>
.>>
.LP
\fBlowbevelcolor\fR
.ig >>
.>>
.ig >>
<a href="color.html">
.>>
\0color
.ig >>
</a>
.>>
.IP \0
Color of lower and rightmost bevels. Default is \fCgray(0.8)\fR
.ig >>
<br><br>
.>>
.LP
\fBshadowcolor\fR
.ig >>
.>>
.ig >>
<a href="color.html">
.>>
\0color
.ig >>
</a>
.>>
.IP \0
Color of drop shadow. Default is \fCblack\fR.
.ig >>
<br><br><br>
.>>
.SH Misc.
.LP
\fBverttext\fR
.ig >>
.>>
\fCyes\fR | \fCno\fR
.IP \0
If \fCyes\fR, text will be rendered vertically, from low to high.
This is a limited implementation;
backing box does not work with vertical text, nor does
automatic arrow tail placement (arrow tail must be specified).
.ig >>
<br><br>
.>>
.LP
\fBfromfile\fR
.ig >>
.>>
\fIfilename\fR
.IP \0
If specified, the text will be read from this file.
This filename is expanded by a shell.
.br
Security concern: user-supplied values (such as CGI user variables) should not be used to build this filename.
.ig >>
<br><br>
.>>
.LP
\fBfromcommand\fR
.ig >>
.>>
\fIshell command\fR
.IP \0
If specified, this shell command will be executed to yield
text on its standard output.
.br
Security concern: user-supplied values (such as CGI user variables) should not be used to build the shell command.
.ig >>
<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 <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif">
</center>
</td></tr>
</table>
<br>
<center>
Ploticus is hosted at http://ploticus.sourceforge.net <br>
<img src="http://sourceforge.net/sflogo.php?group_id=38453" width="88" height="31" border="0" alt="SourceForge Logo">
</center>
.>>
|
