.ig >>
<STYLE TYPE="text/css">
<!--
        A:link{text-decoration:none}
        A:visited{text-decoration:none}
        A:active{text-decoration:none}
-->
</STYLE>
<title>ploticus: available 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>available variables</h2></td>
  <td align=right>
  <small>
  <a href="../doc/Welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
  <a href="../doc/Welcome.html">Welcome</a> &nbsp; &nbsp;
  <a href="../gallery/index.html">Gallery</a> &nbsp; &nbsp;
  <a href="../doc/Contents.html">Handbook</a> 
  <td></tr></table>
</td></tr>
<td>
<br>
<br>
.>>

.TH available_variables PL "31-AUG-2001   PL www.sgpr.net"

.SH DESCRIPTION
Ploticus scripts may contain variables.
These variables may be set within the script or by the user on
the command line.  See
.ig >>
<a href="scripts.html#variables">
.>>
variables
.ig >>
</a>
.>>
.LP
This page describes many of the variables that
are automatically declared and set by ploticus at run time.  
These may be accessed by your scripts if necessary.
These variables may be referenced beginning with the proc 
\fBfollowing\fR the setting proc. 
Ploticus is not affected if you #declare or #set them
or use these names for other purposes.
.LP
Note that in order to reference a variable immediately after the
proc which set it, \fB#proc endproc\fR must be used.
.LP
It is possible that there are recently added variables
that are not summarized here; please check the proc man page
for complete information.


.SH VARIABLES

.LP
\fBAREALEFT  AREARIGHT  AREABOTTOM  AREATOP\fR
.IP
Set by \fBproc areadef\fR to the locations of the current plot area edges in
.ig >>
<a href="attributetypes.html#positionunits">
.>>
absolute units.  
.ig >>
</a>
.>>
 .
.LP
\fBXMIN  XMAX  YMIN  YMAX\fR
.IP
Set by \fBproc areadef\fR to the limits in scaled units, of the plotting area.

.LP
\fBDATAXMIN\fR, \fBDATAXMAX\fR
.IP
The minima and maxima of the data field when xautorange is used.
Different from XMIN and XMAX in that these do not include any margin.
.LP
\fBDATAYMIN\fR, \fBDATAYMAX\fR
.IP
The minima and maxima of the data field when yautorange is used.
Different from YMIN and YMAX in that these do not include any margin.



.LP
\fBDEVICE\fR
.IP
the output display format, one of: \fCpng gif eps ps bwps x11 jpeg wbmp\fR
.LP

.LP
\fBNFIELDS\fR
.IP
the number of fields per record in the current data set.

.LP
\fBNRECORDS\fR
.IP
the number of records in the current data set.

.LP
\fBNVALUES\fR
.IP
the number of in-range plottable points rendered by the most recent
\fBproc scatterplot\fR or \fBproc rangebar\fR.  
May be used in the proc scatterplot legend label.

.LP
\fBRANGEBARMEDIAN RANGEBARMIN RANGEBARMAX\fR
.IP
the median, min, and max value of the most recently drawn rangebar,
in scaled units.

.LP
\fBTOTALS\fR
.IP
Set by \fBproc processdata\fR when action is \fCtotals\fR, it holds
either a single total value, or a comma-delimited list of total values.

.LP
\fBBREAKFIELD1 ..\fR
.IP
Set by \fBproc processdata\fR when action is \fCbreaks\fR, it holds
the contents of the break field(s), before reaching the breakpoint.

.LP
\fBXFINAL\fR 
.IP
X location where the most recent \fBproc lineplot\fR curve ended, in scaled units.

.LP
\fBYFINAL\fR 
.IP
Y location where the most recent \fBproc lineplot\fR curve ended, in scaled units.

.ig >>
<br>
<br>
</td></tr>
<td align=right>
<a href="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>
.>>
