File: variables.html

package info (click to toggle)
ploticus 2.0.3-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 3,696 kB
  • ctags: 2,035
  • sloc: ansic: 40,100; perl: 456; sh: 186; makefile: 129
file content (178 lines) | stat: -rw-r--r-- 4,040 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<html>
<head>
<!-- This file has been generated by unroff 1.0, 02/28/02 14:06:00. -->
<!-- Do not edit! -->
<STYLE TYPE="text/css">
<!--
        A:link{text-decoration:none}
        A:visited{text-decoration:none}
        A:active{text-decoration:none}
-->
</STYLE>
<title>ploticus: system 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>System 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>

<title>Manual page for System_variables(PL)</title>
</head>
<body>

<h2>System Variables</h2>
Ploticus reserves the right to assign 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="scripts.html">
 #endproc
</a>
must be used beforehand.<tt> </tt>

<br><br><br>

<p>
<b>AREALEFT  AREARIGHT  AREABOTTOM  AREATOP</b>
<dl>
<dt><dd><p>
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>
</dl>
<p>
<b>XMIN  XMAX  YMIN  YMAX</b>
<dl>
<dt><dd><p>
Set by <b>proc areadef</b> to the limits in scaled units, of the plotting area.<tt> </tt>

</dl>
<p>
<b>DATAXMIN</b>, <b>DATAXMAX</b>
<dl>
<dt><dd><p>
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>
</dl>
<p>
<b>DATAYMIN</b>, <b>DATAYMAX</b>
<dl>
<dt><dd><p>
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>


</dl>
<p>
<b>CM_UNITS</b>
<dl>
<dt><dd><p>
if user has opted to use centimeters as absolute units, this will contain 1,
otherwise 0.<tt> </tt>


</dl>
<p>
<b>DEVICE</b>
<dl>
<dt><dd><p>
the output display format, one of: <tt>png gif eps ps bwps x11 jpeg wbmp</tt>
</dl>
<p>

<p>
<b>NFIELDS</b>
<dl>
<dt><dd><p>
the number of fields per record in the current data set.<tt> </tt>

</dl>
<p>
<b>NRECORDS</b>
<dl>
<dt><dd><p>
the number of records in the current data set.<tt> </tt>

</dl>
<p>
<b>NVALUES</b>
<dl>
<dt><dd><p>
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>

</dl>
<p>
<b>RANGEBARMEDIAN RANGEBARMIN RANGEBARMAX</b>
<dl>
<dt><dd><p>
the median, min, and max value of the most recently drawn rangebar,
in scaled units.<tt> </tt>

</dl>
<p>
<b>TOTALS</b>
<dl>
<dt><dd><p>
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>

</dl>
<p>
<b>BREAKFIELD1 ..</b>
<dl>
<dt><dd><p>
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>

</dl>
<p>
<b>XSTART</b>, <b>YSTART</b>
<dl>
<dt><dd><p>
X and Y location where the most recent <b>proc lineplot</b> curve began, in scaled units.<tt> </tt>

</dl>
<p>
<b>XFINAL</b>, <b>YFINAL</b>
<dl>
<dt><dd><p>
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="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>
</dl>
<p><hr>
Markup created by <em>unroff</em> 1.0,&#160;<tt> </tt>&#160;<tt> </tt>February 28, 2002.
</body>
</html>