File: module-axis.html

package info (click to toggle)
python-pychart 1.39-7.1
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 1,840 kB
  • ctags: 1,836
  • sloc: python: 6,899; makefile: 81; sh: 30
file content (325 lines) | stat: -rw-r--r-- 12,307 bytes parent folder | download | duplicates (4)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head><style type="text/css">
pre {background-color: #e0e0e0}
</style>

<link rel="STYLESHEET" href="pychart.css" type='text/css' />
<link rel="first" href="pychart.html" title='PyChart' />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-legend.html" />
<link rel="prev" href="module-coord.html" />
<link rel="parent" href="module-area.html" />
<link rel="next" href="module-legend.html" />
<meta name='aesop' content='information' />
<title>6.2 Axes</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.1 Specifying the coordinate"
  href="module-coord.html"><img src='previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="6 Area"
  href="module-area.html"><img src='up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="6.3 Legends"
  href="module-legend.html"><img src='next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">PyChart</td>
<td class='online-navigation'><img src='blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-coord.html">6.1 Specifying the coordinate</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-area.html">6 Area</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-legend.html">6.3 Legends</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION000620000000000000000"></A><a id='l2h-63' xml:id='l2h-63'></a>
<BR>
6.2 Axes
</H2>
<A NAME="module-axis"></A>

<P>
Module <code>axis</code> defines the look of an axis as well as grid
lines. Two classes, <code>axis.X</code> and <code>axis.Y</code>, are provided by
this module.

<P>
<dl><dt><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-65' xml:id='l2h-65' class="class">axis.X</tt></b>
<dd>
This class is draws an X (horizontal) axis.

<P>
<dl><dt><b><tt id='l2h-66' xml:id='l2h-66' class="member">draw_tics_above</tt></b></dt>
<dd>
<b>Type:</b> int
<b>Default:</b> 0. 

<P>
If true, tick lines and labels are drawn above the axis line.
</dl>
<dl><dt><b><tt id='l2h-67' xml:id='l2h-67' class="member">format</tt></b></dt>
<dd>
<b>Type:</b> printf format string
<b>Default:</b> "%s". 

<P>
The format string for tick labels.
                  It can be a `printf' style format string, or 
                  a single-parameter function that takes an X (or Y) value
                  and returns a string. The appearance of the string produced here can be
controlled using escape sequences.  See Section&nbsp;<A href="module-font.html#module-font">17</A>
</dl>
<dl><dt><b><tt id='l2h-68' xml:id='l2h-68' class="member">label</tt></b></dt>
<dd>
<b>Type:</b> str
<b>Default:</b> "axis label". 

<P>
The descriptive string displayed below (or to the left of) the axis.  See Section&nbsp;<A href="module-font.html#module-font">17</A>.
</dl>
<dl><dt><b><tt id='l2h-69' xml:id='l2h-69' class="member">label_offset</tt></b></dt>
<dd>
<b>Type:</b> (x,y) or None
<b>Default:</b> (None, None). 

<P>
The location for drawing the axis label, 
                        relative to the middle point of the axis.
                        If the value is None, the label is displayed
                        below (or to the left of) of axis at the middle.
</dl>
<dl><dt><b><tt id='l2h-70' xml:id='l2h-70' class="member">line_style</tt></b></dt>
<dd>
<b>Type:</b> line_style.T
( see Section&nbsp;<A href="module-line-style.html#module-line-style">14</A>)
<b>Default:</b> line_style.black. 

<P>
Specifies the style of axis and tick lines.
</dl>
<dl><dt><b><tt id='l2h-71' xml:id='l2h-71' class="member">minor_tic_interval</tt></b></dt>
<dd>
<b>Type:</b> number or function
<b>Default:</b> None. 

<P>
When the value is a number, it specifies the interval at which minor tick marks are drawn. Otherwise, the value must be a function that takes two arguments, min and max X (or Y) values. It must return a list of numbers that specify the X or Y points at which minor tick marks are drawn.
</dl>
<dl><dt><b><tt id='l2h-72' xml:id='l2h-72' class="member">minor_tic_len</tt></b></dt>
<dd>
<b>Type:</b> length in points ( See Section&nbsp;<A href="unit.html#unit">4</A>)
<b>Default:</b> 3. 

<P>
The length of minor tick marks.  The value can be negative, in which case the tick lines are drawn right of (or above) the axis.
</dl>
<dl><dt><b><tt id='l2h-73' xml:id='l2h-73' class="member">offset</tt></b></dt>
<dd>
<b>Type:</b> length in points ( See Section&nbsp;<A href="unit.html#unit">4</A>)
<b>Default:</b> 0. 

<P>
The location of the axis. 
                  The value of 0 draws the
                  axis at the left (for the Y axis) or bottom (for the X axis)
                  edge of the drawing area.

<P>
</dl>
<dl><dt><b><tt id='l2h-74' xml:id='l2h-74' class="member">tic_interval</tt></b></dt>
<dd>
<b>Type:</b> number or function
<b>Default:</b> None. 

<P>
When the value is a number, it specifies the interval at which tick marks are drawn. Otherwise, the value must be a function that takes two arguments, min and max X (or Y) values. It must return a list of numbers that specify the X or Y points at which tick marks are drawn.
</dl>
<dl><dt><b><tt id='l2h-75' xml:id='l2h-75' class="member">tic_label_offset</tt></b></dt>
<dd>
<b>Type:</b> (x,y) or None
<b>Default:</b> (0, 0). 

<P>
The location for drawing tick labels, 
                            relative to the tip of the tick line.
</dl>
<dl><dt><b><tt id='l2h-76' xml:id='l2h-76' class="member">tic_len</tt></b></dt>
<dd>
<b>Type:</b> length in points ( See Section&nbsp;<A href="unit.html#unit">4</A>)
<b>Default:</b> 6. 

<P>
The length of tick lines. The value can be negative, in which case the tick lines are drawn right of (or above) the axis.
</dl>
</dl>

<P>
<dl><dt><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-77' xml:id='l2h-77' class="class">axis.Y</tt></b>
<dd>
This class is draws a Y (vertical) axis.

<P>
<dl><dt><b><tt id='l2h-78' xml:id='l2h-78' class="member">draw_tics_right</tt></b></dt>
<dd>
<b>Type:</b> int
<b>Default:</b> 0. 

<P>
If true, tick lines and labels are drawn right of the axis line.
</dl>
<dl><dt><b><tt id='l2h-79' xml:id='l2h-79' class="member">format</tt></b></dt>
<dd>
<b>Type:</b> printf format string
<b>Default:</b> "%s". 

<P>
The format string for tick labels.
                  It can be a `printf' style format string, or 
                  a single-parameter function that takes an X (or Y) value
                  and returns a string. The appearance of the string produced here can be
controlled using escape sequences.  See Section&nbsp;<A href="module-font.html#module-font">17</A>
</dl>
<dl><dt><b><tt id='l2h-80' xml:id='l2h-80' class="member">label</tt></b></dt>
<dd>
<b>Type:</b> str
<b>Default:</b> "axis label". 

<P>
The descriptive string displayed below (or to the left of) the axis.  See Section&nbsp;<A href="module-font.html#module-font">17</A>.
</dl>
<dl><dt><b><tt id='l2h-81' xml:id='l2h-81' class="member">label_offset</tt></b></dt>
<dd>
<b>Type:</b> (x,y) or None
<b>Default:</b> (None, None). 

<P>
The location for drawing the axis label, 
                        relative to the middle point of the axis.
                        If the value is None, the label is displayed
                        below (or to the left of) of axis at the middle.
</dl>
<dl><dt><b><tt id='l2h-82' xml:id='l2h-82' class="member">line_style</tt></b></dt>
<dd>
<b>Type:</b> line_style.T
( see Section&nbsp;<A href="module-line-style.html#module-line-style">14</A>)
<b>Default:</b> line_style.black. 

<P>
Specifies the style of axis and tick lines.
</dl>
<dl><dt><b><tt id='l2h-83' xml:id='l2h-83' class="member">minor_tic_interval</tt></b></dt>
<dd>
<b>Type:</b> number or function
<b>Default:</b> None. 

<P>
When the value is a number, it specifies the interval at which minor tick marks are drawn. Otherwise, the value must be a function that takes two arguments, min and max X (or Y) values. It must return a list of numbers that specify the X or Y points at which minor tick marks are drawn.
</dl>
<dl><dt><b><tt id='l2h-84' xml:id='l2h-84' class="member">minor_tic_len</tt></b></dt>
<dd>
<b>Type:</b> length in points ( See Section&nbsp;<A href="unit.html#unit">4</A>)
<b>Default:</b> 3. 

<P>
The length of minor tick marks.  The value can be negative, in which case the tick lines are drawn right of (or above) the axis.
</dl>
<dl><dt><b><tt id='l2h-85' xml:id='l2h-85' class="member">offset</tt></b></dt>
<dd>
<b>Type:</b> length in points ( See Section&nbsp;<A href="unit.html#unit">4</A>)
<b>Default:</b> 0. 

<P>
The location of the axis. 
                  The value of 0 draws the
                  axis at the left (for the Y axis) or bottom (for the X axis)
                  edge of the drawing area.

<P>
</dl>
<dl><dt><b><tt id='l2h-86' xml:id='l2h-86' class="member">tic_interval</tt></b></dt>
<dd>
<b>Type:</b> number or function
<b>Default:</b> None. 

<P>
When the value is a number, it specifies the interval at which tick marks are drawn. Otherwise, the value must be a function that takes two arguments, min and max X (or Y) values. It must return a list of numbers that specify the X or Y points at which tick marks are drawn.
</dl>
<dl><dt><b><tt id='l2h-87' xml:id='l2h-87' class="member">tic_label_offset</tt></b></dt>
<dd>
<b>Type:</b> (x,y) or None
<b>Default:</b> (0, 0). 

<P>
The location for drawing tick labels, 
                            relative to the tip of the tick line.
</dl>
<dl><dt><b><tt id='l2h-88' xml:id='l2h-88' class="member">tic_len</tt></b></dt>
<dd>
<b>Type:</b> length in points ( See Section&nbsp;<A href="unit.html#unit">4</A>)
<b>Default:</b> 6. 

<P>
The length of tick lines. The value can be negative, in which case the tick lines are drawn right of (or above) the axis.
</dl>
</dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.1 Specifying the coordinate"
  href="module-coord.html"><img src='previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="6 Area"
  href="module-area.html"><img src='up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="6.3 Legends"
  href="module-legend.html"><img src='next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">PyChart</td>
<td class='online-navigation'><img src='blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-coord.html">6.1 Specifying the coordinate</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-area.html">6 Area</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-legend.html">6.3 Legends</A>
</div>
</div>
<hr />
<span class="release-info">Documentation released on July 2, 2005.</span>
</DIV>
<!--End of Navigation Panel-->

</BODY>
</HTML>