File: options.html

package info (click to toggle)
pygdchart2 0.beta1-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 508 kB
  • ctags: 308
  • sloc: python: 1,268; ansic: 1,029; makefile: 6; sh: 1
file content (514 lines) | stat: -rw-r--r-- 10,374 bytes parent folder | download | duplicates (5)
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514


<html>
	<head>
		<LINK REL=StyleSheet HREF="../style/style.css" TYPE="text/css">
	</head>
		<a href="scatter.html">&lt;--previous</a> |
	<a href="../index.html">contents</a> |
	<a href="../pies.html">next--&gt;</a> 

	<hr>
	<body>
        <h1>Graph Options</h1>
		

<p> Below is a complete list of all options that can be set on Graph objects.
Not all options are explained, but the names are fairly self-explanatory. In
time, the descriptions in this table will become more complete.</p>

<p> See the Type Legend table at the bottom of this page for an explanation of
the various data types. </p>

<table border="1" cellpadding="10", cellspacing="0"> 
    <tr>
        <td> <b>Option</b> </td>
        <td> <b>Type </b> </td>
        <td> <b>Description</b> </td>
    </tr>
    <tr>
        <td>annotation_font</td>
        <td>STRING</td>
        <td></td>
    </tr>
    <tr>
        <td>annotation_font_size</td>
        <td>FONTSIZE</td>
        <td></td>
    </tr>
    <tr>
        <td>annotation_ptsize</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>bar_width</td>
        <td>PERCENT</td>
        <td></td>
    </tr>
    <tr>
        <td>bg_color</td>
        <td>COLOR</td>
        <td> Background colour. </td>
    </tr>
    <tr>
        <td>bg_image</td>
        <td>STRING</td>
        <td>Set a background image.</td>
    </tr>
    <tr>
        <td>bg_transparent</td>
        <td>BOOL</td>
        <td></td>
    </tr>
    <tr>
        <td>border</td>
        <td>CUSTOM</td>
        <td>A list of one or more of the following: "NONE", "ALL", "X", "Y", "Y2", "TOP".</td>
    </tr>
    <tr>
        <td>ext_color</td>
        <td>COLOR_A</td>
        <td> The colour of the primary graph. </td>
    </tr>
    <tr>
        <td>ext_vol_color</td>
        <td>COLOR_A</td>
        <td> The colour of the secondary graph. </td>
    </tr>
    <tr>
        <td>generate_img</td>
        <td>BOOL</td>
        <td></td>
    </tr>
    <tr>
        <td>grid</td>
        <td>CUSTOM</td>
        <td>One of "LABELS", "POINTS", "NONE".</td>
    </tr>
    <tr>
        <td>grid_color</td>
        <td>COLOR</td>
        <td></td>
    </tr>
    <tr>
        <td>hard_graphheight</td>
        <td>INT</td>
        <td></td>
    </tr>
    <tr>
        <td>hard_graphwidth</td>
        <td>INT</td>
        <td></td>
    </tr>
    <tr>
        <td>hard_size</td>
        <td>BOOL</td>
        <td></td>
    </tr>
    <tr>
        <td>hard_xorig</td>
        <td>INT</td>
        <td></td>
    </tr>
    <tr>
        <td>hard_yorig</td>
        <td>INT</td>
        <td></td>
    </tr>
    <tr>
        <td>hlc_cap_width</td>
        <td>PERCENT</td>
        <td> The width of the HLC cap. See <a
        href="../graphs/hlc.html">HLC Graph</a> for more detail.</td>
    </tr>
    <tr>
        <td>hlc_style</td>
        <td>INT</td>

        <td> The HLC style. This is option is a list, consisting of one or more
        of the following: "DIAMOND", "CLOSE_CONNECTED", "CONNECTING" and
        "I_CAP".  See <a href="../graphs/hlc.html">HLC Graph</a> for more
        detail.</td>

    </tr>
    <tr>
        <td>hold_img</td>
        <td>INT</td>
        <td></td>
    </tr>
    <tr>
        <td>interpolations</td>
        <td>BOOL</td>
        <td></td>
    </tr>
    <tr>
        <td>image_type</td>
        <td>INT</td>

        <td> One of the following: "GIF", "JPEG", "PNG", "WBMP".</td>

    </tr>
    <tr>
        <td>jpeg_quality</td>
        <td>INT</td>
        <td></td>
    </tr>
    <tr>
        <td>line_color</td>
        <td>COLOR</td>
        <td></td>
    </tr>
    <tr>
        <td>plot_color</td>
        <td>COLOR</td>

        <td> The colour of the primary plot. </td>

    </tr>
    <tr>
        <td>requested_yinterval</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>requested_ymax</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>requested_ymin</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>set_color</td>
        <td>COLOR_A</td>
        <td></td>
    </tr>
    <tr>
        <td>stack_type</td>
        <td>CUSTOM</td>
        <td> One of "DEPTH", "SUM", "BESIDE", "LAYER". </td>
    </tr>
    <tr>
        <td>thumblabel</td>
        <td>STRING</td>
        <td></td>
    </tr>
    <tr> 
        <td>threeD_angle</td>              
        <td>UCHAR</td>     
        <td></td>
    </tr>
    <tr> 
        <td>threeD_depth</td>
        <td>FLOAT</td>     
        <td></td>
    </tr>
    <tr>
        <td>thumbnail</td>
        <td>BOOL</td>
        <td></td>
    </tr>
    <tr>
        <td>thumbval</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>ticks</td>
        <td>CUSTOM</td>
        <td>One of "LABELS", "POINTS", "NONE"</td>
    </tr>
    <tr>
        <td>title</td>
        <td>STRING</td>

        <td> Title at the top of the graph. </td>

    </tr>
    <tr>
        <td>title_color</td>
        <td>COLOR</td>
        <td></td>
    </tr>
    <tr>
        <td>title_font</td>
        <td>STRING</td>
        <td></td>
    </tr>
    <tr>
        <td>title_font_size</td>
        <td>FONTSIZE</td>
        <td></td>
    </tr>
    <tr>
        <td>title_ptsize</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>vol_color</td>
        <td>COLOR</td>
        <td></td>
    </tr>
    <tr>
        <td>xaxis</td>
        <td>BOOL</td>
        <td></td>

    </tr>
    <tr>
        <td>xaxis_angle</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>xaxis_font</td>
        <td>STRING</td>
        <td></td>
    </tr>
    <tr>
        <td>xaxis_font_size</td>
        <td>FONTSIZE</td>
        <td></td>
    </tr>
    <tr>
        <td>xaxis_ptsize</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>xlabel_color</td>
        <td>COLOR</td>
        <td></td>
    </tr>
    <tr>
        <td>xlabel_spacing</td>
        <td>SHORT</td>
        <td></td>
    </tr>
    <tr>
        <td>xlabel_ctl</td>
        <td>BOOL_A</td>
        <td></td>
    </tr>
    <tr>
        <td>xtitle</td>
        <td>STRING</td>

        <td> Label on the X axis. </td>

    </tr>
    <tr>
        <td>xtitle_color</td>
        <td>COLOR</td>
        <td> Colour of the label on the X axis. </td>
    </tr>
    <tr>
        <td>xtitle_font</td>
        <td>STRING</td>
        <td></td>
    </tr>
    <tr>
        <td>xtitle_font_size</td>
        <td>FONTSIZE</td>
        <td></td>
    </tr>
    <tr>
        <td>xtitle_ptsize</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>yaxis</td>
        <td>BOOL</td>
        <td></td>
    </tr>
    <tr>
        <td>yaxis2</td>
        <td>BOOL</td>
        <td></td>
    </tr>
    <tr>
        <td>yaxis_font</td>
        <td>STRING</td>
        <td></td>
    </tr>
    <tr>
        <td>yaxis_font_size</td>
        <td>FONTSIZE</td>
        <td></td>
    </tr>
    <tr>
        <td>yaxis_ptsize</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>ylabel_color</td>
        <td>COLOR</td>
        <td></td>
    </tr>
    <tr>
        <td>ylabel_density</td>
        <td>PERCENT</td>
        <td></td>
    </tr>
    <tr>
        <td>ylabel_fmt</td>
        <td>STRING</td>
        <td></td>
    </tr>
    <tr>
        <td>ylabel2_color</td>
        <td>COLOR</td>
        <td></td>
    </tr>
    <tr>
        <td>ylabel2_fmt</td>
        <td>STRING</td>
        <td></td>
    </tr>
    <tr>
        <td>ytitle</td>
        <td>STRING</td>
        <td> Title on the Y axis. </td>
    </tr>
    <tr>
        <td>ytitle_color</td>
        <td>COLOR</td>
        <td> Colour of the title on the Y axis. </td>
    </tr>
    <tr>
        <td>ytitle_font</td>
        <td>STRING</td>
        <td></td>
    </tr>
    <tr>
        <td>ytitle_font_size</td>
        <td>FONTSIZE</td>
        <td></td>
    </tr>
    <tr>
        <td>ytitle_ptsize</td>
        <td>FLOAT</td>
        <td></td>
    </tr>
    <tr>
        <td>ytitle2</td>
        <td>STRING</td>
        <td></td>
    </tr>
    <tr>
        <td>ytitle2_color</td>
        <td>COLOR</td>
        <td></td>
    </tr>
    <tr>
        <td>yval_style</td>
        <td>BOOL</td>
        <td></td>
    </tr>
    <tr>
        <td>zeroshelf</td>
        <td>BOOL</td>
        <td></td>
    </tr>
</table>


<h2> Type Legend </h2>

<table border=1, cellpadding="10", cellspacing="0">
    
    <tr>
        <td> <b> Type* </b> </td>
        <td> <b> Description </b> </td>
    </tr>


    <tr> 
        <td> BOOL </td>

        <td> True if the value passed evaluates to true (ie. "if a: print 1"
        prints 1). </td>

    </tr>

    <tr> 
        <td> BOOL_A </td>

        <td> An array of BOOL values. </td>

    </tr>

    <tr> 
        <td> COLOR </td>

        <td> Values can be specified as a descriptive name (i.e. "blue"), as an
        integer (i.e. 0xFF0000), or as an RGB object (i.e. RGB(0xFF, 0x00,
        0x00)). </td>

    </tr>

    <tr> 
        <td> COLOR_A </td>
        <td> An array of COLOR values. </td>
    </tr>

    <tr> 
        <td> FLOAT </td>
        <td> A floating point value. </td>
    </tr>

    <tr> 
        <td> FONTSIZE </td>
        <td> One of "TINY", "SMALL", "MEDBOLD", "LARGE", "GIANT". </td>
    </tr>

    <tr> 
        <td> INT </td>
        <td> An integer. </td>
    </tr>

    <tr> 
        <td> PERCENT </td>
        <td> An integer x, such that 0 &lt;= x &lt;= 100.</td>
    </tr>

    <tr> 
        <td> STRING </td>
        <td> A string. </td>
    </tr>

    <tr> 
        <td> UCHAR </td>
        <td> An unsigned char. That is, a small positive integer.</td>
    </tr>

</table>

<p> <b>*</b> Note that types are NOT enforced by type check - that means that
you don't have to pass a Python integer to an integer option: an object with an
__int__ method will do. Same goes for string options and objects with a __str__
or __repr__ method, etc.</p>

	</body>
	<hr>
    <table width="100%">
        <tr>
            <td>
                	<a href="scatter.html">&lt;--previous</a> |
	<a href="../index.html">contents</a> |
	<a href="../pies.html">next--&gt;</a> 

            </td>
            <td align="right">
                (12/31/03)
            </td>
        </tr>
    </table>
	<center> PyGDChart User's Manual </center>
</html>