<html>
<head>
<!-- This file has been generated by unroff 1.0, 03/11/09 12:56:17. -->
<!-- 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 pie</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 pie</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_pie(PL)</title>
</head>
<body>
<center>
<img src="../gallery/pie0.gif">
</center>
Display a pie graph using the
<a href="dataformat.html#currentds">
current data set.<tt> </tt>
</a>
Values will be displayed as a proportion of the sum, unless
the <tt>total</tt> attribute is specified. Proc pie does not require a
<a href="areadef.html">
current plotting area
</a>
to be in effect.<tt> </tt>
See also the
<a href="../gallery/gall.pie.html">
gallery pie examples.<tt> </tt>
</a>
<br><br><br>
<h2>Attributes</h2>
The <tt>datafield</tt>, <tt>center</tt>, and <tt>radius</tt> attributes
<b>must</b> be specified.<tt> </tt>
<br><br>
<p>
<b>datafield</b>
<a href="attributetypes.html#datafield">
dfield
</a>
<dl>
<dt> <dd>
The data field containing the plottable values.<tt> </tt>
<br><br>
</dl>
<p>
<b>center</b>
<a href="attributetypes.html#xy">
x y
</a>
<dl>
<dt> <dd>
Location of the center of the pie.<tt> </tt>
Example: <tt>center: 3 5.6</tt>
<br><br>
</dl>
<p>
<b>radius</b>
<a href="attributetypes.html#lenvalue">
lenvalue
</a>
<dl>
<dt> <dd>
Radius of the pie.<tt> </tt>
Example: <tt>radius: 1.5</tt>
<br><br><br>
</dl>
<h2>Slice labeling</h2>
<p>
<b>labelmode</b>
<tt>legend</tt> | <tt>labelonly</tt> | <tt>line+label</tt>
<dl>
<dt> <dd>
Selects the style for labeling pie slices. Legal values include:
</dl>
<dl><dt><dd>
<dl>
<dt><dd><p>
<tt>legend</tt> - legend entries will be accumulated so that a legend
can be rendered later using <b>proc legend</b>. This is the default.<tt> </tt>
<dt><dd><p>
<tt>labelonly</tt> - pie slice labels will be superimposed onto or
outside the pie slices with no connecting lines.<tt> </tt>
<dt><dd><p>
<tt>line+label</tt> - pie slice labels will be rendered outside of
the pie with connecting lines.<tt> </tt>
</dl>
</dl>
<dl>
<dt> <dd>
The <tt>labelfarout</tt> attribute may be helpful in positioning
the labels. If labels collide, the <tt>firstslice</tt> attribute
may be used to rotate the pie which may alleviate the problem.<tt> </tt>
Labels text may be taken from data field (<tt>labelfield</tt>) or be specified
directly (<tt>labels</tt>).
<dt><dd><p>
Example: <tt>labelmode: labelonly</tt>
<br>
Example: <tt>labelmode: line+label</tt>
<br><br>
</dl>
<p>
<b>wraplen</b>
nchars
<dl>
<dt> <dd>
If specified, label text will be wordwrapped to a maximum line length of nchars characters.<tt> </tt>
New in 2.32
<br><br>
</dl>
<p>
<b>labelfmtstring</b>
string
<dl>
<dt> <dd>
A format string that allows pie slice label content to come from one or more data fields.<tt> </tt>
Text may also contain the characters <tt>\n</tt> to symbolize line breaks, and
the special symbol <b>@@PCT</b> which will evaluate to the percentage of the current slice
(use <tt>pctfmt</tt> attribute to control displayed decimal format of the percents).<tt> </tt>
This attribute is incompatible with <tt>labelfield</tt> ... you can use one or the other, but not both.<tt> </tt>
<br>
Example: <tt>labelfmtstring: @@3 (@@PCT)</tt>
<br>
Example: <tt>labelfmtstring: @@1 \n @@2</tt>
<br><br>
</dl>
<p>
<b>labelfield</b>
<a href="attributetypes.html#datafield">
dfield
</a>
<dl>
<dt> <dd>
If specified, label text or legend text will be taken from this data field
(but see newer attribute <tt>labelfmtstring</tt> above which is more flexible and recommended instead).<tt> </tt>
The label data field may contain the characters <tt>\n</tt> to symbolize line breaks,
as well as the special symbol
<b>@PCT</b> which will evaluate to the percentage of the current slice
(use <tt>pctfmt</tt> attribute to control displayed decimal format of the percents).<tt> </tt>
This attribute is incompatible with <tt>labelfmtstring</tt> ... you can use one or the other, but not both.<tt> </tt>
<br>
Example: <tt>labelfield: 2</tt>
<br><br>
</dl>
<p>
<b>labels</b>
<a href="attributetypes.html#text">
multi-line text
</a>
<dl>
<dt> <dd>
If specified, label text will be taken from this attribute, one line
per pie slice.<tt> </tt>
The label text may contain the characters <tt>\n</tt> to symbolize line breaks.<tt> </tt>
Remember to terminate the multi-line text with a blank line.<tt> </tt>
Label text may contain the special symbol
<b>@PCT</b> which will evaluate to the percentage of the current slice
(use <tt>pctfmt</tt> attribute to control decimal format of @PCT).<tt> </tt>
<br>
Example:
<br>
<tt></tt><pre>
labels: Canada
Mexico
United\nStates
</pre>
<tt></tt>
<br><br>
</dl>
<h2>Slice colors and outline</h2>
There are several ways to specify slice colors. Colors may be driven by
data or given explicitly. Slices may be outlined or not.<tt> </tt>
<p>
<b>exactcolorfield</b>
<a href="attributetypes.html#dfield">
dfield
</a>
<dl>
<dt><dd><p>
If specified, the color of each individual bar is controlled by this data field directly.<tt> </tt>
The data field should hold recognized
<a href="color.html">
color names.<tt> </tt>
</a>
<br><br>
</dl>
<p>
<b>colorfield</b>
<a href="attributetypes.html#dfield">
dfield
</a>
<dl>
<dt> <dd>
If specified, the color of each individual bar is controlled by this data field,
using
<a href="legendentry.html#legenddriven">
legend-driven technique
</a>
(the legend serves as a mapping table to map data values to colors).<tt> </tt>
<br><br>
</dl>
<p>
<b>colors</b>
<a href="color.html">
color list
</a>
<dl>
<dt> <dd>
A space-separated list of colors, one per slice.<tt> </tt>
If all slices are to be the same color, just specify one color.<tt> </tt>
If the number of slices is more than the number of colors, the
last color is used for the remaining slices.<tt> </tt>
You can also just say <tt>auto</tt> which will use a pre-selected
color sequence.<tt> </tt>
<br>
Example: <tt>color: red green orange blue</tt>
<br><br>
</dl>
<p>
<b>outlinedetails</b>
<a href="linedetails.html">
linedetails
</a>
<dl>
<dt> <dd>
Details pertaining to the slice outlines.<tt> </tt>
To turn off slice outlines, use <tt>none</tt>.<tt> </tt>
<br>
Example: <tt>linedetails: width=1.0 color=yellow</tt>
<br><br><br>
</dl>
<h2>Slice positioning, etc.</h2>
<p>
<b>firstslice</b>
<i>n</i>
<dl>
<dt> <dd>
Controls where, in degrees, that the first slice will be displayed.<tt> </tt>
Default is 0 (the top). 90 corresponds to the three o'clock position.<tt> </tt>
Slices are displayed in clockwise order.<tt> </tt>
This may be useful to control where to slices fall, or to work around
a label collision problem.<tt> </tt>
<br>
Example: <tt>firstslice: 45</tt>
<br><br>
</dl>
<p>
<b>explode</b>
<i>w1</i>.. <i>wN</i>
<dl>
<dt> <dd>
A space separated list of values, one per slice.<tt> </tt>
If all slices are to be exploded by the same amount, just specify
one value.
If the number of slices is more than the number of values, the
last value is used for the remaining slices.<tt> </tt>
<dt> <dd>
Each value is a proportion of the radius.<tt> </tt>
A value of <tt>0.2</tt> will explode a slice by 20% of the amount of the radius.<tt> </tt>
A value of <tt>0.3</tt> will explode a slice by 30%.<tt> </tt>
A value of <tt>0.0</tt> will not do any exploding.<tt> </tt>
Thus, one slice, selected slices, or all slices may be exploded.<tt> </tt>
<br>
Example: <tt>explode: 0 0 0.2 0 0 0</tt>
<br><br>
</dl>
<p>
<b>total</b>
<i>n</i>
<dl>
<dt> <dd>
Normally, the sum of all data is assumed to be the denominator
for determining pie slice proportions.
However, if <tt>total</tt> is specified, it is taken to be the denominator.<tt> </tt>
This may be useful if the sum of the values do not represent the whole.<tt> </tt>
<br>
Example: <tt>total: 285</tt>
<br><br><br>
</dl>
<h2>Slice labelling details</h2>
<p>
<b>textdetails</b>
<a href="textdetails.html">
textdetails
</a>
<dl>
<dt> <dd>
Details pertaining to rendering of the label text.<tt> </tt>
<br>
Example: <tt>textdetails: color=blue size=10</tt>
<br><br>
</dl>
<p>
<b>labelfarout</b>
<i>z</i>
<dl>
<dt> <dd>
This attribute may be specified in order to control the placement of
labels. It is a proportion of the radius. A value less than 1.0 will
place labels inside the pie circle; a value greater than 1.0 will
place labels outside the pie circle. If <tt>labelmode</tt> is <tt>line+label</tt>
then <i>z</i> should be <tt>1.2</tt> or greater.<tt> </tt>
<br><br>
</dl>
<p>
<b>labelback</b>
<a href="color.html">
color
</a>
<dl>
<dt> <dd>
If specified, labels will have a backing box shaded this color.<tt> </tt>
<br>
Example: <tt>labelback: dullyellow</tt>
<br><br>
</dl>
<p>
<b>labelbackoutline</b>
<tt> yes | no </tt>
<dl>
<dt> <dd>
If specified as yes, labels will have an outlined backing box.<tt> </tt>
<br><br>
</dl>
<p>
<b>lablinedetails</b>
<a href="linedetails.html">
linedetails
</a>
<dl>
<dt> <dd>
Details pertaining to the lines that may be rendered with the labels.<tt> </tt>
<br><br>
</dl>
<p>
<b>pctformat</b>
<a href="attributetypes.html#printfspec">
printf-spec
</a>
<dl>
<dt> <dd>
Controls the format of percentages shown in the labels
when @PCT is used.<tt> </tt>
<br>
Example: <tt>pctformat: %g</tt>
<br><br><br>
</dl>
<h2>Clickmaps and mouseover</h2>
<p>
<b>clickmapurl</b>
<i>url-template</i>
<dl>
<dt> <dd>
If generating an
<a href="clickmap.html">
HTML clickmap
</a>
, this specifies a url template, and causes the
pie graph labels <b>(but not the slice regions themselves)</b> to be mapped.<tt> </tt>
This attribute usually contains one or more embedded
<a href="attributetypes.html#dfield">
data field references
</a>
preceded by double at-sign (@@).<tt> </tt>
See
<a href="clickmap.html">
HTML clickmap
</a>
for more details and examples.<tt> </tt>
<br>
Example: <tt>clickmapurl: http://abc.com/mycgi?category=@@3</tt>
<br><br>
</dl>
<p>
<b>clickmaplabel</b>
<i>label-template</i>
<dl>
<dt> <dd>
If generating a
<a href="clickmap.html">
client-side clickmap,
</a>
this specifies a template for building mouseover text labels.<tt> </tt>
These are associated with the pie graph labels, but not the entire slice regions.<tt> </tt>
<br>
Example: <tt>clickmaplabel: @@3 (@@4)</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>
</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
>
63
