<html>
<head>
<!-- This file has been generated by unroff 1.0, 03/11/09 12:56:23. -->
<!-- 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: ploticus variables</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>Ploticus variables</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 Ploticus_variables(PL)</title>
</head>
<body>
<h2>Variables</h2>
More advanced ploticus scripts can set and reference <b>variables</b>.<tt> </tt>
Variable names must begin with a letter and may contain letters, digits, underscore (_) and period (.).<tt> </tt>
Names are case-sensitive. Maximum length of a variable name is 38 characters.<tt> </tt>
Variables may hold numbers, alphanumerics, or
<a href="commalist.html">
lists,
</a>
but are always internally stored in alphanumeric form, with a maximum content length is 250 characters.<tt> </tt>
All variables are global in scope.<tt> </tt>
<p>
Variables may be assigned using the <tt>#set</tt> directive, like this:
<pre>
#set ymax = 200
</pre>
<p>
Variables may be referenced (used) anywhere in a script.<tt> </tt>
An at-sign (<tt>@</tt>) is used at the beginning of a variable name when its contents
are to be displayed or referenced, for example:
<pre>
yrange: 0 @ymax
</pre>
<p>
In some situations (<tt>select</tt> statements and getdata <tt>filter</tt>s) you may need to use
two at-signs (@@), so that one at-sign survives the script evaluation (if that's what you want).<tt> </tt>
<p>
An attempt to evaluate a variable that has never been assigned a value
will result in cancellation of the evaluation (the variable name will be
passed through transparently) and no error condition will be raised.<tt> </tt>
Several
<a href="variables.html#reserved">
reserved variables
</a>
exist.
<a name=system></a>
<br><br><br>
<h2>System Variables</h2>
Ploticus sets certain variables, described below.<tt> </tt>
These variables may be accessed by user scripts as needed.<tt> </tt>
<p>
In order to reference a variable immediately after the proc that set the variable,
<a href="scriptsyntax.html">
#endproc
</a>
must be used to mark the end of the proc that set the variable.<tt> </tt>
<p>
Nothing bad will happen if you happen to assign a value to one of these
variables, other than the chance that ploticus will update the variable's value
when you're not expecting it.<tt> </tt>
<br><br><br>
<p>
<b>PLVERSION</b>
<dl>
<dt> <dd>
The ploticus version number.<tt> </tt>
<br><br>
</dl>
<p>
<b>AREALEFT AREARIGHT AREABOTTOM AREATOP</b>
<dl>
<dt> <dd>
Set by <b>proc areadef</b> to the locations of the current plot area edges in
<a href="attributetypes.html#positionunits">
absolute units.
</a>
.<tt> </tt>
<br><br>
</dl>
<p>
<b>XMIN XMAX YMIN YMAX</b>
<dl>
<dt> <dd>
Set by <b>proc areadef</b> to the limits in scaled units, of the plotting area.<tt> </tt>
<br><br>
</dl>
<p>
<b>XINC YINC</b>
<dl>
<dt> <dd>
Set by <b>proc axis</b> to the scale increment in X or Y.<tt> </tt>
<br><br>
</dl>
<p>
<b>DATAXMIN</b>, <b>DATAXMAX</b>
<dl>
<dt> <dd>
The minima and maxima of the data field when xautorange is used.<tt> </tt>
Different from XMIN and XMAX in that these do not include any margin.<tt> </tt>
<br><br>
</dl>
<p>
<b>DATAYMIN</b>, <b>DATAYMAX</b>
<dl>
<dt> <dd>
The minima and maxima of the data field when yautorange is used.<tt> </tt>
Different from YMIN and YMAX in that these do not include any margin.<tt> </tt>
<br><br>
</dl>
<p>
<b>CM_UNITS</b>
<dl>
<dt> <dd>
if user has opted to use centimeters as absolute units, this will contain 1,
otherwise 0.<tt> </tt>
<br><br>
</dl>
<p>
<b>DEVICE</b>
<dl>
<dt> <dd>
the output display format, one of:
<br>
<tt>png gif eps ps bwps x11 jpeg svg svgz swf</tt>
<br><br>
</dl>
<p>
<b>NFIELDS</b>
<dl>
<dt> <dd>
the number of fields per record in the current data set.<tt> </tt>
<br><br>
</dl>
<p>
<b>NRECORDS</b>
<dl>
<dt> <dd>
the number of records in the current data set.<tt> </tt>
<br><br>
</dl>
<p>
<b>NVALUES</b>
<dl>
<dt> <dd>
the number of in-range plottable points rendered by the most recent
<b>proc scatterplot</b> or <b>proc rangebar</b>.
May be used in the proc scatterplot legend label.<tt> </tt>
<br><br>
</dl>
<p>
<b>RANGEBARMEDIAN RANGEBARMIN RANGEBARMAX</b>
<dl>
<dt> <dd>
the median, min, and max value of the most recently drawn rangebar,
in scaled units.<tt> </tt>
<br><br>
</dl>
<p>
<b>TOTALS</b>
<dl>
<dt> <dd>
Set by <b>proc processdata</b> when action is <tt>totals</tt>, it holds
either a single total value, or a comma-delimited list of total values.<tt> </tt>
<br><br>
</dl>
<p>
<b>BREAKFIELD1 ..</b>
<dl>
<dt> <dd>
Set by <b>proc processdata</b> when action is <tt>breaks</tt>, it holds
the contents of the break field(s), before reaching the breakpoint.<tt> </tt>
<br><br>
</dl>
<p>
<b>XSTART</b>, <b>YSTART</b>
<dl>
<dt> <dd>
X and Y location where the most recent <b>proc lineplot</b> curve began, in scaled units.<tt> </tt>
<br><br>
</dl>
<p>
<b>XFINAL</b>, <b>YFINAL</b>
<dl>
<dt> <dd>
X and Y location where the most recent <b>proc lineplot</b> curve ended, in scaled units.<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
>
130
