1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
4 |
<head> |
5 |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<title>Docs For Class SVGXYGraph</title> |
7 |
<link rel="stylesheet" href="../../media/stylesheet.css" /> |
8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
9 |
</head> |
10 |
<body> |
11 |
<div class="page-body"> |
12 |
|
13 |
<h2 class="class-name">Class SVGXYGraph</h2> |
14 |
|
15 |
<a name="sec-description"></a> |
16 |
<div class="info-box"> |
17 |
<div class="info-box-title">Description</div> |
18 |
<div class="nav-bar"> |
19 |
<span class="disabled">Description</span> | |
20 |
<a href="#sec-descendents">Descendents</a> |
21 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
22 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
23 |
|
24 |
</div> |
25 |
<div class="info-box-body"> |
26 |
<!-- ========== Info from phpDoc block ========= --> |
27 |
<p class="short-description">This is the base Graph class for doing XY coordinate system based graphs in SVG.</p> |
28 |
<p class="description"><p>$Id: SVGXYGraph.html,v 1.17 2004/04/01 17:35:47 hemna Exp $</p></p> |
29 |
<ul class="tags"> |
30 |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
31 |
</ul> |
32 |
<p class="notes"> |
33 |
Located in <a class="field" href="_widgets_svg_SVGXYGraph_inc.html">/widgets/svg/SVGXYGraph.inc</a> (line <span class="field">28</span>) |
34 |
</p> |
35 |
|
36 |
|
37 |
<pre><a href="../../phpHtmlLib/Container.html">Container</a> |
38 |
| |
39 |
--<a href="../../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
40 |
| |
41 |
--<a href="../../phpHtmlLib/SVG/SVGGraph.html">SVGGraph</a> |
42 |
| |
43 |
--SVGXYGraph</pre> |
44 |
|
45 |
</div> |
46 |
</div> |
47 |
|
48 |
<a name="sec-descendents"></a> |
49 |
<div class="info-box"> |
50 |
<div class="info-box-title">Direct descendents</div> |
51 |
<div class="nav-bar"> |
52 |
<a href="#sec-description">Description</a> | |
53 |
<span class="disabled">Descendents</span> |
54 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
55 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
56 |
|
57 |
</div> |
58 |
<div class="info-box-body"> |
59 |
<table cellpadding="2" cellspacing="0" class="class-table"> |
60 |
<tr> |
61 |
<th class="class-table-header">Class</th> |
62 |
<th class="class-table-header">Description</th> |
63 |
</tr> |
64 |
<tr> |
65 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/SVG/SVGXYPlotGraph.html">SVGXYPlotGraph</a></td> |
66 |
<td> |
67 |
This is the base Graph class for doing XY coordinate system based graphs in SVG. |
68 |
</td> |
69 |
</tr> |
70 |
</table> |
71 |
</div> |
72 |
</div> |
73 |
|
74 |
|
75 |
<a name="sec-var-summary"></a> |
76 |
<div class="info-box"> |
77 |
<div class="info-box-title">Variable Summary</span></div> |
78 |
<div class="nav-bar"> |
79 |
<a href="#sec-description">Description</a> | |
80 |
<a href="#sec-descendents">Descendents</a> | |
81 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
82 |
| |
83 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
84 |
|
85 |
</div> |
86 |
<div class="info-box-body"> |
87 |
<div class="var-summary"> |
88 |
<div class="var-title"> |
89 |
<span class="var-type">mixed</span> |
90 |
<a href="#$_colors" title="details" class="var-name">$_colors</a> |
91 |
</div> |
92 |
<div class="var-title"> |
93 |
<span class="var-type">mixed</span> |
94 |
<a href="#$_max_x" title="details" class="var-name">$_max_x</a> |
95 |
</div> |
96 |
<div class="var-title"> |
97 |
<span class="var-type">mixed</span> |
98 |
<a href="#$_max_y" title="details" class="var-name">$_max_y</a> |
99 |
</div> |
100 |
<div class="var-title"> |
101 |
<span class="var-type">mixed</span> |
102 |
<a href="#$_min_x" title="details" class="var-name">$_min_x</a> |
103 |
</div> |
104 |
<div class="var-title"> |
105 |
<span class="var-type">mixed</span> |
106 |
<a href="#$_min_y" title="details" class="var-name">$_min_y</a> |
107 |
</div> |
108 |
<div class="var-title"> |
109 |
<span class="var-type">mixed</span> |
110 |
<a href="#$_x_data" title="details" class="var-name">$_x_data</a> |
111 |
</div> |
112 |
<div class="var-title"> |
113 |
<span class="var-type">mixed</span> |
114 |
<a href="#$_y_data" title="details" class="var-name">$_y_data</a> |
115 |
</div> |
116 |
</div> |
117 |
</div> |
118 |
</div> |
119 |
|
120 |
<a name="sec-method-summary"></a> |
121 |
<div class="info-box"> |
122 |
<div class="info-box-title">Method Summary</span></div> |
123 |
<div class="nav-bar"> |
124 |
<a href="#sec-description">Description</a> | |
125 |
<a href="#sec-descendents">Descendents</a> | |
126 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
127 |
|
128 |
| |
129 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
130 |
</div> |
131 |
<div class="info-box-body"> |
132 |
<div class="method-summary"> |
133 |
|
134 |
<div class="method-definition"> |
135 |
<span class="method-result">SVGXYGraph</span> |
136 |
<a href="#SVGXYGraph" title="details" class="method-name">SVGXYGraph</a> |
137 |
(<span class="var-type">mixed</span> <span class="var-name">$title</span>, <span class="var-type">mixed</span> <span class="var-name">$width</span>, <span class="var-type">mixed</span> <span class="var-name">$height</span>) |
138 |
</div> |
139 |
|
140 |
<div class="method-definition"> |
141 |
<span class="method-result">void</span> |
142 |
<a href="#add_x_values" title="details" class="method-name">add_x_values</a> |
143 |
(<span class="var-type">string</span> <span class="var-name">$x_values</span>) |
144 |
</div> |
145 |
|
146 |
<div class="method-definition"> |
147 |
<span class="method-result">void</span> |
148 |
<a href="#add_y_values" title="details" class="method-name">add_y_values</a> |
149 |
(<span class="var-type">string</span> <span class="var-name">$y_values</span>) |
150 |
</div> |
151 |
|
152 |
<div class="method-definition"> |
153 |
<span class="method-result">int</span> |
154 |
<a href="#get_x_position" title="details" class="method-name">get_x_position</a> |
155 |
(<span class="var-type">float</span> <span class="var-name">$x</span>) |
156 |
</div> |
157 |
|
158 |
<div class="method-definition"> |
159 |
<span class="method-result">int</span> |
160 |
<a href="#get_y_position" title="details" class="method-name">get_y_position</a> |
161 |
(<span class="var-type">float</span> <span class="var-name">$y</span>) |
162 |
</div> |
163 |
|
164 |
<div class="method-definition"> |
165 |
<span class="method-result">void</span> |
166 |
<a href="#set_axis_grid_points" title="details" class="method-name">set_axis_grid_points</a> |
167 |
(<span class="var-type">string</span> <span class="var-name">$axis</span>, <span class="var-type">int</span> <span class="var-name">$points</span>) |
168 |
</div> |
169 |
|
170 |
<div class="method-definition"> |
171 |
<span class="method-result">void</span> |
172 |
<a href="#set_grid_line_color" title="details" class="method-name">set_grid_line_color</a> |
173 |
(<span class="var-type">string</span> <span class="var-name">$color</span>) |
174 |
</div> |
175 |
|
176 |
<div class="method-definition"> |
177 |
<span class="method-result">void</span> |
178 |
<a href="#set_grid_line_flag" title="details" class="method-name">set_grid_line_flag</a> |
179 |
(<span class="var-type">string</span> <span class="var-name">$axis</span>, [<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
180 |
</div> |
181 |
|
182 |
<div class="method-definition"> |
183 |
<span class="method-result">void</span> |
184 |
<a href="#set_x_title" title="details" class="method-name">set_x_title</a> |
185 |
(<span class="var-type">string</span> <span class="var-name">$title</span>) |
186 |
</div> |
187 |
|
188 |
<div class="method-definition"> |
189 |
<span class="method-result">void</span> |
190 |
<a href="#set_y_title" title="details" class="method-name">set_y_title</a> |
191 |
(<span class="var-type">string</span> <span class="var-name">$title</span>) |
192 |
</div> |
193 |
|
194 |
<div class="method-definition"> |
195 |
<span class="method-result">void</span> |
196 |
<a href="#_add_options" title="details" class="method-name">_add_options</a> |
197 |
() |
198 |
</div> |
199 |
|
200 |
<div class="method-definition"> |
201 |
<span class="method-result">void</span> |
202 |
<a href="#_background" title="details" class="method-name">_background</a> |
203 |
() |
204 |
</div> |
205 |
|
206 |
<div class="method-definition"> |
207 |
<span class="method-result">Container</span> |
208 |
<a href="#_build_graph" title="details" class="method-name">_build_graph</a> |
209 |
() |
210 |
</div> |
211 |
|
212 |
<div class="method-definition"> |
213 |
<span class="method-result">Container</span> |
214 |
<a href="#_build_titles" title="details" class="method-name">_build_titles</a> |
215 |
() |
216 |
</div> |
217 |
|
218 |
<div class="method-definition"> |
219 |
<span class="method-result">Container</span> |
220 |
<a href="#_build_x_axis" title="details" class="method-name">_build_x_axis</a> |
221 |
() |
222 |
</div> |
223 |
|
224 |
<div class="method-definition"> |
225 |
<span class="method-result">Container</span> |
226 |
<a href="#_build_y_axis" title="details" class="method-name">_build_y_axis</a> |
227 |
() |
228 |
</div> |
229 |
|
230 |
<div class="method-definition"> |
231 |
<span class="method-result">void</span> |
232 |
<a href="#_prepare_data" title="details" class="method-name">_prepare_data</a> |
233 |
() |
234 |
</div> |
235 |
|
236 |
<div class="method-definition"> |
237 |
<span class="method-result"><a href="../../phpHtmlLib/TEXTsvgtag.html">TEXTsvgtag</a></span> |
238 |
<a href="#_x_axis_title" title="details" class="method-name">_x_axis_title</a> |
239 |
() |
240 |
</div> |
241 |
|
242 |
<div class="method-definition"> |
243 |
<span class="method-result"><a href="../../phpHtmlLib/TEXTsvgtag.html">TEXTsvgtag</a></span> |
244 |
<a href="#_y_axis_title" title="details" class="method-name">_y_axis_title</a> |
245 |
() |
246 |
</div> |
247 |
</div> |
248 |
</div> |
249 |
</div> |
250 |
|
251 |
<a name="sec-vars"></a> |
252 |
<div class="info-box"> |
253 |
<div class="info-box-title">Variables</div> |
254 |
<div class="nav-bar"> |
255 |
<a href="#sec-description">Description</a> | |
256 |
<a href="#sec-descendents">Descendents</a> | |
257 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
258 |
|
259 |
|
260 |
| |
261 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
262 |
|
263 |
</div> |
264 |
<div class="info-box-body"> |
265 |
<a name="var$_colors" id="$_colors"><!-- --></A> |
266 |
<div class="oddrow"> |
267 |
|
268 |
<div class="var-header"> |
269 |
<span class="var-title"> |
270 |
<span class="var-type">mixed</span> |
271 |
<span class="var-name">$_colors</span> |
272 |
= <span class="var-default">array()</span> (line <span class="line-number">48</span>) |
273 |
</span> |
274 |
</div> |
275 |
|
276 |
<!-- ========== Info from phpDoc block ========= --> |
277 |
<p class="short-description">holds the colors for each of</p> |
278 |
<p class="description"><p>the lines</p></p> |
279 |
|
280 |
|
281 |
|
282 |
|
283 |
|
284 |
</div> |
285 |
<a name="var$_max_x" id="$_max_x"><!-- --></A> |
286 |
<div class="evenrow"> |
287 |
|
288 |
<div class="var-header"> |
289 |
<span class="var-title"> |
290 |
<span class="var-type">mixed</span> |
291 |
<span class="var-name">$_max_x</span> |
292 |
= <span class="var-default"> 0</span> (line <span class="line-number">35</span>) |
293 |
</span> |
294 |
</div> |
295 |
|
296 |
<!-- ========== Info from phpDoc block ========= --> |
297 |
|
298 |
|
299 |
|
300 |
|
301 |
|
302 |
</div> |
303 |
<a name="var$_max_y" id="$_max_y"><!-- --></A> |
304 |
<div class="oddrow"> |
305 |
|
306 |
<div class="var-header"> |
307 |
<span class="var-title"> |
308 |
<span class="var-type">mixed</span> |
309 |
<span class="var-name">$_max_y</span> |
310 |
= <span class="var-default"> 0</span> (line <span class="line-number">42</span>) |
311 |
</span> |
312 |
</div> |
313 |
|
314 |
<!-- ========== Info from phpDoc block ========= --> |
315 |
|
316 |
|
317 |
|
318 |
|
319 |
|
320 |
</div> |
321 |
<a name="var$_min_x" id="$_min_x"><!-- --></A> |
322 |
<div class="evenrow"> |
323 |
|
324 |
<div class="var-header"> |
325 |
<span class="var-title"> |
326 |
<span class="var-type">mixed</span> |
327 |
<span class="var-name">$_min_x</span> |
328 |
= <span class="var-default"> 0</span> (line <span class="line-number">34</span>) |
329 |
</span> |
330 |
</div> |
331 |
|
332 |
<!-- ========== Info from phpDoc block ========= --> |
333 |
|
334 |
|
335 |
|
336 |
|
337 |
|
338 |
</div> |
339 |
<a name="var$_min_y" id="$_min_y"><!-- --></A> |
340 |
<div class="oddrow"> |
341 |
|
342 |
<div class="var-header"> |
343 |
<span class="var-title"> |
344 |
<span class="var-type">mixed</span> |
345 |
<span class="var-name">$_min_y</span> |
346 |
= <span class="var-default"> 0</span> (line <span class="line-number">41</span>) |
347 |
</span> |
348 |
</div> |
349 |
|
350 |
<!-- ========== Info from phpDoc block ========= --> |
351 |
|
352 |
|
353 |
|
354 |
|
355 |
|
356 |
</div> |
357 |
<a name="var$_x_data" id="$_x_data"><!-- --></A> |
358 |
<div class="evenrow"> |
359 |
|
360 |
<div class="var-header"> |
361 |
<span class="var-title"> |
362 |
<span class="var-type">mixed</span> |
363 |
<span class="var-name">$_x_data</span> |
364 |
= <span class="var-default">array()</span> (line <span class="line-number">33</span>) |
365 |
</span> |
366 |
</div> |
367 |
|
368 |
<!-- ========== Info from phpDoc block ========= --> |
369 |
<p class="short-description">this holds the X axis data</p> |
370 |
|
371 |
|
372 |
|
373 |
|
374 |
|
375 |
</div> |
376 |
<a name="var$_y_data" id="$_y_data"><!-- --></A> |
377 |
<div class="oddrow"> |
378 |
|
379 |
<div class="var-header"> |
380 |
<span class="var-title"> |
381 |
<span class="var-type">mixed</span> |
382 |
<span class="var-name">$_y_data</span> |
383 |
= <span class="var-default">array()</span> (line <span class="line-number">40</span>) |
384 |
</span> |
385 |
</div> |
386 |
|
387 |
<!-- ========== Info from phpDoc block ========= --> |
388 |
<p class="short-description">this holds the Y axis data</p> |
389 |
|
390 |
|
391 |
|
392 |
|
393 |
|
394 |
</div> |
395 |
|
396 |
<h4>Inherited Variables</h4> |
397 |
<A NAME='inherited_vars'><!-- --></A> |
398 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/SVG/SVGGraph.html">SVGGraph</a></span></p> |
399 |
<blockquote> |
400 |
<span class="var-title"> |
401 |
<span class="var-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#var$_draw">SVGGraph::$_draw</a></span><br> |
402 |
</span> |
403 |
<span class="var-title"> |
404 |
<span class="var-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#var$_options">SVGGraph::$_options</a></span><br> |
405 |
</span> |
406 |
</blockquote> |
407 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
408 |
<blockquote> |
409 |
<span class="var-title"> |
410 |
<span class="var-name"><a href="../../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
411 |
</span> |
412 |
<span class="var-title"> |
413 |
<span class="var-name"><a href="../../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
414 |
</span> |
415 |
</blockquote> |
416 |
|
417 |
</div> |
418 |
</div> |
419 |
|
420 |
<a name="sec-methods"></a> |
421 |
<div class="info-box"> |
422 |
<div class="info-box-title">Methods</div> |
423 |
<div class="nav-bar"> |
424 |
<a href="#sec-description">Description</a> | |
425 |
<a href="#sec-descendents">Descendents</a> | |
426 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
427 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
428 |
|
429 |
</div> |
430 |
<div class="info-box-body"> |
431 |
<A NAME='method_detail'></A> |
432 |
<a name="methodSVGXYGraph" id="SVGXYGraph"><!-- --></a> |
433 |
<div class="evenrow"> |
434 |
|
435 |
<div class="method-header"> |
436 |
<span class="method-title">Constructor SVGXYGraph</span> (line <span class="line-number">51</span>) |
437 |
</div> |
438 |
|
439 |
<!-- ========== Info from phpDoc block ========= --> |
440 |
|
441 |
<div class="method-signature"> |
442 |
<span class="method-result">SVGXYGraph</span> |
443 |
<span class="method-name"> |
444 |
SVGXYGraph |
445 |
</span> |
446 |
(<span class="var-type">mixed</span> <span class="var-name">$title</span>, <span class="var-type">mixed</span> <span class="var-name">$width</span>, <span class="var-type">mixed</span> <span class="var-name">$height</span>) |
447 |
</div> |
448 |
|
449 |
|
450 |
|
451 |
</div> |
452 |
<a name="methodadd_x_values" id="add_x_values"><!-- --></a> |
453 |
<div class="oddrow"> |
454 |
|
455 |
<div class="method-header"> |
456 |
<span class="method-title">add_x_values</span> (line <span class="line-number">164</span>) |
457 |
</div> |
458 |
|
459 |
<!-- ========== Info from phpDoc block ========= --> |
460 |
<p class="short-description">This function is used to add a new set of x values for the graph.</p> |
461 |
<p class="description"><p>NOTE: this must be a comma delimited list of values.</p></p> |
462 |
|
463 |
<div class="method-signature"> |
464 |
<span class="method-result">void</span> |
465 |
<span class="method-name"> |
466 |
add_x_values |
467 |
</span> |
468 |
(<span class="var-type">string</span> <span class="var-name">$x_values</span>) |
469 |
</div> |
470 |
|
471 |
<ul class="parameters"> |
472 |
<li> |
473 |
<span class="var-type">string</span> |
474 |
<span class="var-name">$x_values</span><span class="var-description">: - the values</span> </li> |
475 |
</ul> |
476 |
|
477 |
|
478 |
</div> |
479 |
<a name="methodadd_y_values" id="add_y_values"><!-- --></a> |
480 |
<div class="evenrow"> |
481 |
|
482 |
<div class="method-header"> |
483 |
<span class="method-title">add_y_values</span> (line <span class="line-number">177</span>) |
484 |
</div> |
485 |
|
486 |
<!-- ========== Info from phpDoc block ========= --> |
487 |
<p class="short-description">This function is used to add a new set of y values for the graph.</p> |
488 |
<p class="description"><p>NOTE: this must be a comma delimited list of values.</p></p> |
489 |
|
490 |
<div class="method-signature"> |
491 |
<span class="method-result">void</span> |
492 |
<span class="method-name"> |
493 |
add_y_values |
494 |
</span> |
495 |
(<span class="var-type">string</span> <span class="var-name">$y_values</span>) |
496 |
</div> |
497 |
|
498 |
<ul class="parameters"> |
499 |
<li> |
500 |
<span class="var-type">string</span> |
501 |
<span class="var-name">$y_values</span><span class="var-description">: - the values</span> </li> |
502 |
</ul> |
503 |
|
504 |
|
505 |
</div> |
506 |
<a name="methodget_x_position" id="get_x_position"><!-- --></a> |
507 |
<div class="oddrow"> |
508 |
|
509 |
<div class="method-header"> |
510 |
<span class="method-title">get_x_position</span> (line <span class="line-number">360</span>) |
511 |
</div> |
512 |
|
513 |
<!-- ========== Info from phpDoc block ========= --> |
514 |
<p class="short-description">This function returns the pixel positions of a data point</p> |
515 |
<ul class="tags"> |
516 |
<li><span class="field">return:</span> position in pixels</li> |
517 |
</ul> |
518 |
|
519 |
<div class="method-signature"> |
520 |
<span class="method-result">int</span> |
521 |
<span class="method-name"> |
522 |
get_x_position |
523 |
</span> |
524 |
(<span class="var-type">float</span> <span class="var-name">$x</span>) |
525 |
</div> |
526 |
|
527 |
<ul class="parameters"> |
528 |
<li> |
529 |
<span class="var-type">float</span> |
530 |
<span class="var-name">$x</span><span class="var-description">: data point</span> </li> |
531 |
</ul> |
532 |
|
533 |
|
534 |
</div> |
535 |
<a name="methodget_y_position" id="get_y_position"><!-- --></a> |
536 |
<div class="evenrow"> |
537 |
|
538 |
<div class="method-header"> |
539 |
<span class="method-title">get_y_position</span> (line <span class="line-number">344</span>) |
540 |
</div> |
541 |
|
542 |
<!-- ========== Info from phpDoc block ========= --> |
543 |
<p class="short-description">This function returns the pixel positions of a data point</p> |
544 |
<ul class="tags"> |
545 |
<li><span class="field">return:</span> position in pixels</li> |
546 |
</ul> |
547 |
|
548 |
<div class="method-signature"> |
549 |
<span class="method-result">int</span> |
550 |
<span class="method-name"> |
551 |
get_y_position |
552 |
</span> |
553 |
(<span class="var-type">float</span> <span class="var-name">$y</span>) |
554 |
</div> |
555 |
|
556 |
<ul class="parameters"> |
557 |
<li> |
558 |
<span class="var-type">float</span> |
559 |
<span class="var-name">$y</span><span class="var-description">: data point</span> </li> |
560 |
</ul> |
561 |
|
562 |
|
563 |
</div> |
564 |
<a name="methodset_axis_grid_points" id="set_axis_grid_points"><!-- --></a> |
565 |
<div class="oddrow"> |
566 |
|
567 |
<div class="method-header"> |
568 |
<span class="method-title">set_axis_grid_points</span> (line <span class="line-number">208</span>) |
569 |
</div> |
570 |
|
571 |
<!-- ========== Info from phpDoc block ========= --> |
572 |
<p class="short-description">This is used to set how many grid lines to draw for an axis</p> |
573 |
|
574 |
<div class="method-signature"> |
575 |
<span class="method-result">void</span> |
576 |
<span class="method-name"> |
577 |
set_axis_grid_points |
578 |
</span> |
579 |
(<span class="var-type">string</span> <span class="var-name">$axis</span>, <span class="var-type">int</span> <span class="var-name">$points</span>) |
580 |
</div> |
581 |
|
582 |
<ul class="parameters"> |
583 |
<li> |
584 |
<span class="var-type">string</span> |
585 |
<span class="var-name">$axis</span><span class="var-description">: - the axis, x/y only</span> </li> |
586 |
<li> |
587 |
<span class="var-type">int</span> |
588 |
<span class="var-name">$points</span><span class="var-description">: - how many lines</span> </li> |
589 |
</ul> |
590 |
|
591 |
|
592 |
</div> |
593 |
<a name="methodset_grid_line_color" id="set_grid_line_color"><!-- --></a> |
594 |
<div class="evenrow"> |
595 |
|
596 |
<div class="method-header"> |
597 |
<span class="method-title">set_grid_line_color</span> (line <span class="line-number">226</span>) |
598 |
</div> |
599 |
|
600 |
<!-- ========== Info from phpDoc block ========= --> |
601 |
<p class="short-description">This allows you to set the color of the axis grid lines</p> |
602 |
|
603 |
<div class="method-signature"> |
604 |
<span class="method-result">void</span> |
605 |
<span class="method-name"> |
606 |
set_grid_line_color |
607 |
</span> |
608 |
(<span class="var-type">string</span> <span class="var-name">$color</span>) |
609 |
</div> |
610 |
|
611 |
<ul class="parameters"> |
612 |
<li> |
613 |
<span class="var-type">string</span> |
614 |
<span class="var-name">$color</span><span class="var-description">: - the color name</span> </li> |
615 |
</ul> |
616 |
|
617 |
|
618 |
</div> |
619 |
<a name="methodset_grid_line_flag" id="set_grid_line_flag"><!-- --></a> |
620 |
<div class="oddrow"> |
621 |
|
622 |
<div class="method-header"> |
623 |
<span class="method-title">set_grid_line_flag</span> (line <span class="line-number">189</span>) |
624 |
</div> |
625 |
|
626 |
<!-- ========== Info from phpDoc block ========= --> |
627 |
<p class="short-description">This enables/disables the rendering of the grid lines for an axis</p> |
628 |
|
629 |
<div class="method-signature"> |
630 |
<span class="method-result">void</span> |
631 |
<span class="method-name"> |
632 |
set_grid_line_flag |
633 |
</span> |
634 |
(<span class="var-type">string</span> <span class="var-name">$axis</span>, [<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
635 |
</div> |
636 |
|
637 |
<ul class="parameters"> |
638 |
<li> |
639 |
<span class="var-type">string</span> |
640 |
<span class="var-name">$axis</span><span class="var-description">: - the axis, x/y only</span> </li> |
641 |
<li> |
642 |
<span class="var-type">boolean</span> |
643 |
<span class="var-name">$flag</span><span class="var-description">: - TRUE = Enabled</span> </li> |
644 |
</ul> |
645 |
|
646 |
|
647 |
</div> |
648 |
<a name="methodset_x_title" id="set_x_title"><!-- --></a> |
649 |
<div class="evenrow"> |
650 |
|
651 |
<div class="method-header"> |
652 |
<span class="method-title">set_x_title</span> (line <span class="line-number">141</span>) |
653 |
</div> |
654 |
|
655 |
<!-- ========== Info from phpDoc block ========= --> |
656 |
<p class="short-description">This function is used to set the title for the X Axis</p> |
657 |
|
658 |
<div class="method-signature"> |
659 |
<span class="method-result">void</span> |
660 |
<span class="method-name"> |
661 |
set_x_title |
662 |
</span> |
663 |
(<span class="var-type">string</span> <span class="var-name">$title</span>) |
664 |
</div> |
665 |
|
666 |
<ul class="parameters"> |
667 |
<li> |
668 |
<span class="var-type">string</span> |
669 |
<span class="var-name">$title</span><span class="var-description">: - the title</span> </li> |
670 |
</ul> |
671 |
|
672 |
|
673 |
</div> |
674 |
<a name="methodset_y_title" id="set_y_title"><!-- --></a> |
675 |
<div class="oddrow"> |
676 |
|
677 |
<div class="method-header"> |
678 |
<span class="method-title">set_y_title</span> (line <span class="line-number">151</span>) |
679 |
</div> |
680 |
|
681 |
<!-- ========== Info from phpDoc block ========= --> |
682 |
<p class="short-description">This function is used to set the title for the Y Axis</p> |
683 |
|
684 |
<div class="method-signature"> |
685 |
<span class="method-result">void</span> |
686 |
<span class="method-name"> |
687 |
set_y_title |
688 |
</span> |
689 |
(<span class="var-type">string</span> <span class="var-name">$title</span>) |
690 |
</div> |
691 |
|
692 |
<ul class="parameters"> |
693 |
<li> |
694 |
<span class="var-type">string</span> |
695 |
<span class="var-name">$title</span><span class="var-description">: - the title</span> </li> |
696 |
</ul> |
697 |
|
698 |
|
699 |
</div> |
700 |
<a name="method_add_options" id="_add_options"><!-- --></a> |
701 |
<div class="evenrow"> |
702 |
|
703 |
<div class="method-header"> |
704 |
<span class="method-title">_add_options</span> (line <span class="line-number">102</span>) |
705 |
</div> |
706 |
|
707 |
<!-- ========== Info from phpDoc block ========= --> |
708 |
<p class="short-description">this method adds our own options that</p> |
709 |
<p class="description"><p>are different from the parent class</p></p> |
710 |
|
711 |
<div class="method-signature"> |
712 |
<span class="method-result">void</span> |
713 |
<span class="method-name"> |
714 |
_add_options |
715 |
</span> |
716 |
() |
717 |
</div> |
718 |
|
719 |
|
720 |
|
721 |
</div> |
722 |
<a name="method_background" id="_background"><!-- --></a> |
723 |
<div class="oddrow"> |
724 |
|
725 |
<div class="method-header"> |
726 |
<span class="method-title">_background</span> (line <span class="line-number">326</span>) |
727 |
</div> |
728 |
|
729 |
<!-- ========== Info from phpDoc block ========= --> |
730 |
|
731 |
<div class="method-signature"> |
732 |
<span class="method-result">void</span> |
733 |
<span class="method-name"> |
734 |
_background |
735 |
</span> |
736 |
() |
737 |
</div> |
738 |
|
739 |
|
740 |
|
741 |
</div> |
742 |
<a name="method_build_graph" id="_build_graph"><!-- --></a> |
743 |
<div class="evenrow"> |
744 |
|
745 |
<div class="method-header"> |
746 |
<span class="method-title">_build_graph</span> (line <span class="line-number">84</span>) |
747 |
</div> |
748 |
|
749 |
<!-- ========== Info from phpDoc block ========= --> |
750 |
<p class="short-description">This function does the work of building the graph itself</p> |
751 |
|
752 |
<div class="method-signature"> |
753 |
<span class="method-result">Container</span> |
754 |
<span class="method-name"> |
755 |
_build_graph |
756 |
</span> |
757 |
() |
758 |
</div> |
759 |
|
760 |
|
761 |
<hr class="separator" /> |
762 |
<div class="notes">Redefinition of:</div> |
763 |
<dl> |
764 |
<dt><a href="../../phpHtmlLib/SVG/SVGGraph.html#method_build_graph">SVGGraph::_build_graph()</a></dt> |
765 |
<dd>This is a stub that the child class must override to build the actual graph</dd> |
766 |
</dl> |
767 |
|
768 |
</div> |
769 |
<a name="method_build_titles" id="_build_titles"><!-- --></a> |
770 |
<div class="oddrow"> |
771 |
|
772 |
<div class="method-header"> |
773 |
<span class="method-title">_build_titles</span> (line <span class="line-number">68</span>) |
774 |
</div> |
775 |
|
776 |
<!-- ========== Info from phpDoc block ========= --> |
777 |
<p class="short-description">This is a stub for building the title(s) for the graph</p> |
778 |
|
779 |
<div class="method-signature"> |
780 |
<span class="method-result">Container</span> |
781 |
<span class="method-name"> |
782 |
_build_titles |
783 |
</span> |
784 |
() |
785 |
</div> |
786 |
|
787 |
|
788 |
<hr class="separator" /> |
789 |
<div class="notes">Redefinition of:</div> |
790 |
<dl> |
791 |
<dt><a href="../../phpHtmlLib/SVG/SVGGraph.html#method_build_titles">SVGGraph::_build_titles()</a></dt> |
792 |
<dd>This is a stub for building the title(s) for the graph</dd> |
793 |
</dl> |
794 |
|
795 |
</div> |
796 |
<a name="method_build_x_axis" id="_build_x_axis"><!-- --></a> |
797 |
<div class="evenrow"> |
798 |
|
799 |
<div class="method-header"> |
800 |
<span class="method-title">_build_x_axis</span> (line <span class="line-number">373</span>) |
801 |
</div> |
802 |
|
803 |
<!-- ========== Info from phpDoc block ========= --> |
804 |
<p class="short-description">This function builds the X axis and its measurement lines/marks</p> |
805 |
|
806 |
<div class="method-signature"> |
807 |
<span class="method-result">Container</span> |
808 |
<span class="method-name"> |
809 |
_build_x_axis |
810 |
</span> |
811 |
() |
812 |
</div> |
813 |
|
814 |
|
815 |
|
816 |
</div> |
817 |
<a name="method_build_y_axis" id="_build_y_axis"><!-- --></a> |
818 |
<div class="oddrow"> |
819 |
|
820 |
<div class="method-header"> |
821 |
<span class="method-title">_build_y_axis</span> (line <span class="line-number">428</span>) |
822 |
</div> |
823 |
|
824 |
<!-- ========== Info from phpDoc block ========= --> |
825 |
<p class="short-description">This function builds the Y axis and its measurement lines/marks</p> |
826 |
|
827 |
<div class="method-signature"> |
828 |
<span class="method-result">Container</span> |
829 |
<span class="method-name"> |
830 |
_build_y_axis |
831 |
</span> |
832 |
() |
833 |
</div> |
834 |
|
835 |
|
836 |
|
837 |
</div> |
838 |
<a name="method_prepare_data" id="_prepare_data"><!-- --></a> |
839 |
<div class="evenrow"> |
840 |
|
841 |
<div class="method-header"> |
842 |
<span class="method-title">_prepare_data</span> (line <span class="line-number">235</span>) |
843 |
</div> |
844 |
|
845 |
<!-- ========== Info from phpDoc block ========= --> |
846 |
<p class="short-description">We need this to calculate the min,max values for</p> |
847 |
<p class="description"><p>both all x points and all y data points, so we can scale the graph correctly</p></p> |
848 |
|
849 |
<div class="method-signature"> |
850 |
<span class="method-result">void</span> |
851 |
<span class="method-name"> |
852 |
_prepare_data |
853 |
</span> |
854 |
() |
855 |
</div> |
856 |
|
857 |
|
858 |
<hr class="separator" /> |
859 |
<div class="notes">Redefinition of:</div> |
860 |
<dl> |
861 |
<dt><a href="../../phpHtmlLib/SVG/SVGGraph.html#method_prepare_data">SVGGraph::_prepare_data()</a></dt> |
862 |
<dd>This is a stub meant to provide a means for doing any data parsing/munging prior to actually building the svg for the graph output.</dd> |
863 |
</dl> |
864 |
|
865 |
</div> |
866 |
<a name="method_x_axis_title" id="_x_axis_title"><!-- --></a> |
867 |
<div class="oddrow"> |
868 |
|
869 |
<div class="method-header"> |
870 |
<span class="method-title">_x_axis_title</span> (line <span class="line-number">297</span>) |
871 |
</div> |
872 |
|
873 |
<!-- ========== Info from phpDoc block ========= --> |
874 |
<p class="short-description">This method builds the text title area that lives in the X axis</p> |
875 |
|
876 |
<div class="method-signature"> |
877 |
<span class="method-result"><a href="../../phpHtmlLib/TEXTsvgtag.html">TEXTsvgtag</a></span> |
878 |
<span class="method-name"> |
879 |
_x_axis_title |
880 |
</span> |
881 |
() |
882 |
</div> |
883 |
|
884 |
|
885 |
|
886 |
</div> |
887 |
<a name="method_y_axis_title" id="_y_axis_title"><!-- --></a> |
888 |
<div class="evenrow"> |
889 |
|
890 |
<div class="method-header"> |
891 |
<span class="method-title">_y_axis_title</span> (line <span class="line-number">314</span>) |
892 |
</div> |
893 |
|
894 |
<!-- ========== Info from phpDoc block ========= --> |
895 |
<p class="short-description">This method builds the text title area that lives in the X axis</p> |
896 |
|
897 |
<div class="method-signature"> |
898 |
<span class="method-result"><a href="../../phpHtmlLib/TEXTsvgtag.html">TEXTsvgtag</a></span> |
899 |
<span class="method-name"> |
900 |
_y_axis_title |
901 |
</span> |
902 |
() |
903 |
</div> |
904 |
|
905 |
|
906 |
|
907 |
</div> |
908 |
<h4>Inherited Methods</h4> |
909 |
<a name='inherited_methods'><!-- --></a> |
910 |
<!-- =========== Summary =========== --> |
911 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/SVG/SVGGraph.html">SVGGraph</a></span></p> |
912 |
<blockquote> |
913 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodSVGGraph">SVGGraph::SVGGraph()</a></span><br> |
914 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodformat_label">SVGGraph::format_label()</a></span><br> |
915 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodget_option">SVGGraph::get_option()</a></span><br> |
916 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodget_options">SVGGraph::get_options()</a></span><br> |
917 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodrender">SVGGraph::render()</a></span><br> |
918 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodset_axis_font_height">SVGGraph::set_axis_font_height()</a></span><br> |
919 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodset_axis_font_width">SVGGraph::set_axis_font_width()</a></span><br> |
920 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodset_height">SVGGraph::set_height()</a></span><br> |
921 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodset_option">SVGGraph::set_option()</a></span><br> |
922 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodset_title">SVGGraph::set_title()</a></span><br> |
923 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodset_title_font_height">SVGGraph::set_title_font_height()</a></span><br> |
924 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodset_title_font_width">SVGGraph::set_title_font_width()</a></span><br> |
925 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodset_title_style">SVGGraph::set_title_style()</a></span><br> |
926 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#methodset_width">SVGGraph::set_width()</a></span><br> |
927 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#method_build_graph">SVGGraph::_build_graph()</a></span><br> |
928 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#method_build_title">SVGGraph::_build_title()</a></span><br> |
929 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#method_build_titles">SVGGraph::_build_titles()</a></span><br> |
930 |
<span class="method-name"><a href="../../phpHtmlLib/SVG/SVGGraph.html#method_prepare_data">SVGGraph::_prepare_data()</a></span><br> |
931 |
</blockquote> |
932 |
<!-- =========== Summary =========== --> |
933 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
934 |
<blockquote> |
935 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
936 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
937 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
938 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
939 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
940 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
941 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
942 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
943 |
</blockquote> |
944 |
<!-- =========== Summary =========== --> |
945 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/Container.html">Container</a></span></p> |
946 |
<blockquote> |
947 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
948 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
949 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
950 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
951 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br> |
952 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
953 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
954 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
955 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
956 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
957 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
958 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
959 |
</blockquote> |
960 |
|
961 |
</div> |
962 |
</div> |
963 |
|
964 |
|
965 |
<p class="notes" id="credit"> |
966 |
Documentation generated on Thu, 1 Apr 2004 09:40:05 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
967 |
</p> |
968 |
</div></body> |
969 |
</html> |