File: variables.html

package info (click to toggle)
ploticus-doc 2.40-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 9,604 kB
  • ctags: 159
  • sloc: pascal: 469; makefile: 63; sh: 11
file content (289 lines) | stat: -rw-r--r-- 6,580 bytes parent folder | download
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<html>
<head>
<!-- This file has been generated by unroff 1.0, 01/15/08 14:06:34. -->
<!-- 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.40 Jan'08
     </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 &nbsp; <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif"> 
</center>
</td></tr>
</table>
<br>
<center>
Ploticus is hosted at http://ploticus.sourceforge.net <br>
<img src="http://sourceforge.net/sflogo.php?group_id=38453" width="88" height="31" border="0" alt="SourceForge Logo">
</center>
</dl>
<p><hr>
Markup created by <em>unroff</em> 1.0,&#160;<tt> </tt>&#160;<tt> </tt>January 15, 2008.
</body>
</html>