~ubuntu-branches/ubuntu/maverick/ploticus/maverick

« back to all changes in this revision

Viewing changes to doc/variables.html

  • Committer: Bazaar Package Importer
  • Author(s): James W. Penny
  • Date: 2002-04-10 23:02:04 UTC
  • Revision ID: james.westby@ubuntu.com-20020410230204-64em4ns2f57c5u3l
Tags: 2.0.3-1
* The "That Tears it, Now You Have to Update Docs Package" Release.
* New upstream release (well, not so new :-( )   closes: Bug#137578
* Correct missing libpng2-dev in build-depends.  closes: Bug#142205
* Use correct syntax to:
* close URL type.                                closes: Bug#137577
* fix Architecture                               closes: Bug#141657
* close ITP                                      closes: Bug#132878

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<head>
 
3
<!-- This file has been generated by unroff 1.0, 02/28/02 14:06:00. -->
 
4
<!-- Do not edit! -->
 
5
<STYLE TYPE="text/css">
 
6
<!--
 
7
        A:link{text-decoration:none}
 
8
        A:visited{text-decoration:none}
 
9
        A:active{text-decoration:none}
 
10
-->
 
11
</STYLE>
 
12
<title>ploticus: system variables</title>
 
13
<body bgcolor=D0D0EE vlink=0000FF>
 
14
<br>
 
15
<br>
 
16
<center>
 
17
<table cellpadding=2 bgcolor=FFFFFF width=550 ><tr>
 
18
<td>
 
19
  <table cellpadding=2 width=550><tr>
 
20
  <td><br><h2>System variables</h2></td>
 
21
  <td align=right>
 
22
  <small>
 
23
  <a href="../doc/Welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
 
24
  <a href="../doc/Welcome.html">Welcome</a> &nbsp; &nbsp;
 
25
  <a href="../gallery/index.html">Gallery</a> &nbsp; &nbsp;
 
26
  <a href="../doc/Contents.html">Handbook</a> 
 
27
  <td></tr></table>
 
28
</td></tr>
 
29
<td>
 
30
<br>
 
31
<br>
 
32
 
 
33
<title>Manual page for System_variables(PL)</title>
 
34
</head>
 
35
<body>
 
36
 
 
37
<h2>System Variables</h2>
 
38
Ploticus reserves the right to assign certain variables, described below.<tt> </tt>
 
39
These variables may be accessed by user scripts as needed.<tt> </tt>
 
40
<p>
 
41
In order to reference a variable immediately after the proc that set the variable, 
 
42
<a href="scripts.html">
 
43
 #endproc
 
44
</a>
 
45
must be used beforehand.<tt> </tt>
 
46
 
 
47
<br><br><br>
 
48
 
 
49
<p>
 
50
<b>AREALEFT  AREARIGHT  AREABOTTOM  AREATOP</b>
 
51
<dl>
 
52
<dt><dd><p>
 
53
Set by <b>proc areadef</b> to the locations of the current plot area edges in
 
54
<a href="attributetypes.html#positionunits">
 
55
absolute units.  
 
56
</a>
 
57
 .<tt> </tt>
 
58
</dl>
 
59
<p>
 
60
<b>XMIN  XMAX  YMIN  YMAX</b>
 
61
<dl>
 
62
<dt><dd><p>
 
63
Set by <b>proc areadef</b> to the limits in scaled units, of the plotting area.<tt> </tt>
 
64
 
 
65
</dl>
 
66
<p>
 
67
<b>DATAXMIN</b>, <b>DATAXMAX</b>
 
68
<dl>
 
69
<dt><dd><p>
 
70
The minima and maxima of the data field when xautorange is used.<tt> </tt>
 
71
Different from XMIN and XMAX in that these do not include any margin.<tt> </tt>
 
72
</dl>
 
73
<p>
 
74
<b>DATAYMIN</b>, <b>DATAYMAX</b>
 
75
<dl>
 
76
<dt><dd><p>
 
77
The minima and maxima of the data field when yautorange is used.<tt> </tt>
 
78
Different from YMIN and YMAX in that these do not include any margin.<tt> </tt>
 
79
 
 
80
 
 
81
</dl>
 
82
<p>
 
83
<b>CM_UNITS</b>
 
84
<dl>
 
85
<dt><dd><p>
 
86
if user has opted to use centimeters as absolute units, this will contain 1,
 
87
otherwise 0.<tt> </tt>
 
88
 
 
89
 
 
90
</dl>
 
91
<p>
 
92
<b>DEVICE</b>
 
93
<dl>
 
94
<dt><dd><p>
 
95
the output display format, one of: <tt>png gif eps ps bwps x11 jpeg wbmp</tt>
 
96
</dl>
 
97
<p>
 
98
 
 
99
<p>
 
100
<b>NFIELDS</b>
 
101
<dl>
 
102
<dt><dd><p>
 
103
the number of fields per record in the current data set.<tt> </tt>
 
104
 
 
105
</dl>
 
106
<p>
 
107
<b>NRECORDS</b>
 
108
<dl>
 
109
<dt><dd><p>
 
110
the number of records in the current data set.<tt> </tt>
 
111
 
 
112
</dl>
 
113
<p>
 
114
<b>NVALUES</b>
 
115
<dl>
 
116
<dt><dd><p>
 
117
the number of in-range plottable points rendered by the most recent
 
118
<b>proc scatterplot</b> or <b>proc rangebar</b>.  
 
119
May be used in the proc scatterplot legend label.<tt> </tt>
 
120
 
 
121
</dl>
 
122
<p>
 
123
<b>RANGEBARMEDIAN RANGEBARMIN RANGEBARMAX</b>
 
124
<dl>
 
125
<dt><dd><p>
 
126
the median, min, and max value of the most recently drawn rangebar,
 
127
in scaled units.<tt> </tt>
 
128
 
 
129
</dl>
 
130
<p>
 
131
<b>TOTALS</b>
 
132
<dl>
 
133
<dt><dd><p>
 
134
Set by <b>proc processdata</b> when action is <tt>totals</tt>, it holds
 
135
either a single total value, or a comma-delimited list of total values.<tt> </tt>
 
136
 
 
137
</dl>
 
138
<p>
 
139
<b>BREAKFIELD1 ..</b>
 
140
<dl>
 
141
<dt><dd><p>
 
142
Set by <b>proc processdata</b> when action is <tt>breaks</tt>, it holds
 
143
the contents of the break field(s), before reaching the breakpoint.<tt> </tt>
 
144
 
 
145
</dl>
 
146
<p>
 
147
<b>XSTART</b>, <b>YSTART</b>
 
148
<dl>
 
149
<dt><dd><p>
 
150
X and Y location where the most recent <b>proc lineplot</b> curve began, in scaled units.<tt> </tt>
 
151
 
 
152
</dl>
 
153
<p>
 
154
<b>XFINAL</b>, <b>YFINAL</b>
 
155
<dl>
 
156
<dt><dd><p>
 
157
X and Y location where the most recent <b>proc lineplot</b> curve ended, in scaled units.<tt> </tt>
 
158
 
 
159
 
 
160
<br>
 
161
<br>
 
162
</td></tr>
 
163
<td align=right>
 
164
<a href="Welcome.html">
 
165
<img src="../doc/ploticus.gif" border=0></a><br><small>data display engine &nbsp; <br>
 
166
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
 
167
<br>
 
168
<br>
 
169
<center>
 
170
<img src="../gallery/all.gif">
 
171
</center>
 
172
</td></tr>
 
173
</table>
 
174
</dl>
 
175
<p><hr>
 
176
Markup created by <em>unroff</em> 1.0,&#160;<tt> </tt>&#160;<tt> </tt>February 28, 2002.
 
177
</body>
 
178
</html>