<html>
<head>
<!-- This file has been generated by unroff 1.0, 03/11/09 12:56:11. -->
<!-- Do not edit! -->
<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.41 Mar2009
</small><br><a href="../doc/scripthome.html">Scripts</a>
<td></tr></table>
</td></tr>
<td>
<br>
<br>
<title>Manual page for proc_annotate(PL)</title>
</head>
<body>
<center><a href="../gallery/gall.annot.html"><img src="../gallery/annot0.gif" border=0></a></center>
<p>
<b>proc annotate</b> may be used to place arbitrary text, arrows, circles, or ellipses at
specific locations, in either absolute space or scaled space.<tt> </tt>
Annotation may include one or two arrows.<tt> </tt>
See also the
<a href="../gallery/gall.annot.html">
gallery annotations examples.<tt> </tt>
</a>
<br><br><br>
<h2>Hints</h2>
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...<tt> </tt>
coordinates will be written to standard error for each click... Then cut/paste these
into your script file for annotations.<tt> </tt>
To place multiple pieces of text (from field(s) in a data file for example),
<a href="scatterplot.html">
proc scatterplot
</a>
may be a better way to go than proc annotate.<tt> </tt>
<br><br><br>
<h2>Attributes</h2>
<p>
<b>text</b>
<a href="attributetypes.html#text">
multiline text
</a>
<dl>
<dt> <dd>
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>
<tt>
</tt></dl>
<p>
<b>textdetails</b>
<a href="attributetypes.html#textdetails">
textdetails
</a>
<dl>
<dt> <dd>
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>
<br><br>
</dl>
<p>
<b>location</b>
<a href="attributetypes.html#xy">
x y
</a>
<dl>
<dt> <dd>
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>
<br><br>
</dl>
<p>
<b>clip</b>
<tt>yes | no</tt>
<dl>
<dt> <dd>
Default is <tt>no</tt>. If <tt>yes</tt>, the annotation may be cut off at the edge of the cropped graphic.<tt> </tt>
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+)
<br><br><br>
</dl>
<h2>Backing box or ellipse</h2>
Annotation may have a backing box (the default) or an ellipse.<tt> </tt>
It may be shaded and/or outlined.
<p>
<b>ellipse</b>
<tt>yes | no</tt>
<dl>
<dt> <dd>
Default is <tt>no</tt>.<tt> </tt>
If <tt>yes</tt>, an elliptical backing region will be drawn instead of a box.<tt> </tt>
<br><br>
</dl>
<p>
<b>backcolor</b>
<a href="color.html">
color
</a>
<dl>
<dt> <dd>
If specified, a shaded box or ellipse will be rendered in the specified <i>color</i>.<tt> </tt>
Any annotation text will be rendered on top of the shaded region.<tt> </tt>
Specify <tt>outline</tt> to encompass the backing region with a line.<tt> </tt>
<br><br>
</dl>
<p>
<b>outline</b>
<a href="attributetypes.html#linedetails">
linedetails
</a>
<dl>
<dt> <dd>
If specified, the backing box or ellipse will be outlined with a line of this type.<tt> </tt>
May be used with or without <tt>backcolor</tt>.<tt> </tt>
<br>
Example: <tt>outline: yes</tt> (do a default box)
<br>
Example: <tt>outline: color=yellow width=1.0</tt>
<br><br>
</dl>
<p>
<b>box</b>
Same as <b>outline</b> above. (Deprecated)
<br><br>
<p>
<b>boxmargin</b>
<i>n</i>
<dl>
<dt> <dd>
If specified, increase the size of any backing box or ellipse by
<i>n</i> absolute units on all four sides. A negative value decreases the size.<tt> </tt>
<br>
Example: boxmargin: 0.15
<br><br>
</dl>
<p>
<b>backadjust</b>
<i>a b c d</i>
<dl>
<dt> <dd>
Allows adjustments to be made to the default backing box or backing ellipse.<tt> </tt>
To adjust a backing box, <i>a</i> will be added to the left side, <i>b</i> will be
added to the bottom side, <i>c</i> will be added to the right side, and <i>d</i>
will be added to the top. To adjust a backing ellipse, <i>a</i> will be added to the
ellipse width and <i>b</i> will be added to the ellipse height; <i>c</i> and <i>d</i> should be given as 0.<tt> </tt>
<i>a b c d</i> are in inches (or cm).<tt> </tt>
New in version 2.40
<dt> <dd>
For example, to stretch the default backing box to make it wider but no taller
use: <tt>backadjust: -0.2 0 0.2 0</tt>
<br><br>
</dl>
<p>
<b>backdim</b>
<i>a b c d</i>
<dl>
<dt> <dd>
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, <i>a b</i> defines the upper left location of the box,
<i>c</i> determines the width, and <i>d</i> the height.<tt> </tt>
For ellipse, <i>a b</i> defines the center, <i>c</i> the width, and <i>d</i> the height
<i>a</i> and <i>b</i> are
<a href="attributetypes.html#locvalue">
locvalues,
</a>
while <i>c</i> and <i>d</i> are always inches (or cm).<tt> </tt>
<br><br><br>
</dl>
<h2>Arrows</h2>
<p>
<b>arrowhead</b>
<a href="attributetypes.html#xy">
x y
</a>
<dl>
<dt> <dd>
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>
<br><br>
</dl>
<p>
<b>arrowhead2</b>
<a href="attributetypes.html#xy">
x y
</a>
<dl>
<dt> <dd>
Same as <tt>arrowhead</tt> above, for a second arrow.<tt> </tt>
<br><br>
</dl>
<p>
<b>arrowdetails</b>
<a href="linedetails.html">
linedetails
</a>
<dl>
<dt> <dd>
Allows control of details pertaining to the arrows, such as line thickness and color.<tt> </tt>
<br><br>
</dl>
<p>
<b>arrowheadsize</b>
<i>n</i>
<dl>
<dt> <dd>
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>
<br><br>
</dl>
<p>
<b>arrowtail</b>
<a href="attributetypes.html#xy">
x y
</a>
<dl>
<dt> <dd>
If specified, tail of 1st arrow will be at this point.
Useful if automatic placement does not give acceptable results.<tt> </tt>
<br><br>
</dl>
<p>
<b>arrowtail2</b>
<a href="attributetypes.html#xy">
x y
</a>
<dl>
<dt> <dd>
If specified, tail of 2nd arrow will be at this point.
Useful if automatic placement does not give acceptable results.<tt> </tt>
<br><br><br>
</dl>
<h2>Clickmap and mouseover</h2>
<p>
<b>clickmapurl</b>
<i>url</i>
<dl>
<dt> <dd>
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>
</dl>
<p>
<b>clickmaplabel</b>
<i>label</i>
<dl>
<dt><dd><p>
If generating a
<a href="clickmap.html">
client-side clickmap,
</a>
this specifies a mouseover text label.<tt> </tt>
</dl>
<p>
<b>clickmaplabeltext</b>
<a href="attributetypes.html#text">
multiline text
</a>
<dl>
<dt> <dd>
Same as <tt>clickmaplabel</tt> but multiline text. Must be terminated with a blank line.<tt> </tt>
<br><br><br>
</dl>
<h2>Optional bevel / drop shadow</h2>
A bevel or drop shadow can be rendered along with a backing box
(but not a backing ellipse).<tt> </tt>
<p>
<b>bevelsize</b>
<i>n</i>
<dl>
<dt> <dd>
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>
<br><br>
</dl>
<p>
<b>shadowsize</b>
<i>n</i>
<dl>
<dt> <dd>
Width of visible portion of optional drop shadow in absolute units.<tt> </tt>
Default is <tt>0.0</tt> (no drop shadow).<tt> </tt>
<br><br>
</dl>
<p>
<b>hibevelcolor</b>
<a href="color.html">
color
</a>
<dl>
<dt> <dd>
Color of upper and lefttmost bevels. Default is <tt>gray(0.6)</tt>
<br><br>
</dl>
<p>
<b>lowbevelcolor</b>
<a href="color.html">
color
</a>
<dl>
<dt> <dd>
Color of lower and rightmost bevels. Default is <tt>gray(0.8)</tt>
<br><br>
</dl>
<p>
<b>shadowcolor</b>
<a href="color.html">
color
</a>
<dl>
<dt> <dd>
Color of drop shadow. Default is <tt>black</tt>.<tt> </tt>
<br><br><br>
</dl>
<h2>Misc.</h2>
<p>
<b>verttext</b>
<tt>yes</tt> | <tt>no</tt>
<dl>
<dt> <dd>
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>
<br><br>
</dl>
<p>
<b>fromfile</b>
<i>filename</i>
<dl>
<dt> <dd>
If specified, the text will be read from this file.<tt> </tt>
This filename is expanded by a shell.<tt> </tt>
<br>
Security concern: user-supplied values (such as CGI user variables) should not be used to build this filename.<tt> </tt>
<br><br>
</dl>
<p>
<b>fromcommand</b>
<i>shell command</i>
<dl>
<dt> <dd>
If specified, this shell command will be executed to yield
text on its standard output.<tt> </tt>
<br>
Security concern: user-supplied values (such as CGI user variables) should not be used to build the shell command.<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 <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif">
</center>
</td></tr>
</table>
<br>
<center>
<table><tr><td>
Ploticus is hosted at http://ploticus.sourceforge.net</td><td> </td><td>
<a href="http://sourceforge.net/projects/ploticus"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=38453&type=12"
width="120" height="30" border="0"
alt="Get ploticus data display engine at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a>
</td></tr></table>
</center>
</dl>
<p><hr>
Markup created by <em>unroff</em> 1.0, <tt> </tt> <tt> </tt>March 11, 2009.
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
ed05dc5f357c49fdded780f52b150dce
>
files
>
12
