.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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
 Same as \fBoutline\fR above. (Deprecated)

.ig >>
<br><br>
.>>

.LP
\fBboxmargin\fR 
.ig >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
.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 >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
\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 >>
&nbsp; &nbsp;
.>>
\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 &nbsp; <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>
.>>
