| 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 SVGGraph</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 SVGGraph</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 SVG graphs</p> |
| 28 |
<p class="description"><p>$Id: SVGGraph.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_SVGGraph_inc.html">/widgets/svg/SVGGraph.inc</a> (line <span class="field">23</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 |
--SVGGraph</pre> |
| 42 |
|
| 43 |
</div> |
| 44 |
</div> |
| 45 |
|
| 46 |
<a name="sec-descendents"></a> |
| 47 |
<div class="info-box"> |
| 48 |
<div class="info-box-title">Direct descendents</div> |
| 49 |
<div class="nav-bar"> |
| 50 |
<a href="#sec-description">Description</a> | |
| 51 |
<span class="disabled">Descendents</span> |
| 52 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 53 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 54 |
|
| 55 |
</div> |
| 56 |
<div class="info-box-body"> |
| 57 |
<table cellpadding="2" cellspacing="0" class="class-table"> |
| 58 |
<tr> |
| 59 |
<th class="class-table-header">Class</th> |
| 60 |
<th class="class-table-header">Description</th> |
| 61 |
</tr> |
| 62 |
<tr> |
| 63 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/SVG/SVGXYGraph.html">SVGXYGraph</a></td> |
| 64 |
<td> |
| 65 |
This is the base Graph class for doing XY coordinate system based graphs in SVG. |
| 66 |
</td> |
| 67 |
</tr> |
| 68 |
</table> |
| 69 |
</div> |
| 70 |
</div> |
| 71 |
|
| 72 |
|
| 73 |
<a name="sec-var-summary"></a> |
| 74 |
<div class="info-box"> |
| 75 |
<div class="info-box-title">Variable Summary</span></div> |
| 76 |
<div class="nav-bar"> |
| 77 |
<a href="#sec-description">Description</a> | |
| 78 |
<a href="#sec-descendents">Descendents</a> | |
| 79 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 80 |
| |
| 81 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 82 |
|
| 83 |
</div> |
| 84 |
<div class="info-box-body"> |
| 85 |
<div class="var-summary"> |
| 86 |
<div class="var-title"> |
| 87 |
<span class="var-type">mixed</span> |
| 88 |
<a href="#$_draw" title="details" class="var-name">$_draw</a> |
| 89 |
</div> |
| 90 |
<div class="var-title"> |
| 91 |
<span class="var-type">mixed</span> |
| 92 |
<a href="#$_options" title="details" class="var-name">$_options</a> |
| 93 |
</div> |
| 94 |
</div> |
| 95 |
</div> |
| 96 |
</div> |
| 97 |
|
| 98 |
<a name="sec-method-summary"></a> |
| 99 |
<div class="info-box"> |
| 100 |
<div class="info-box-title">Method Summary</span></div> |
| 101 |
<div class="nav-bar"> |
| 102 |
<a href="#sec-description">Description</a> | |
| 103 |
<a href="#sec-descendents">Descendents</a> | |
| 104 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 105 |
|
| 106 |
| |
| 107 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 108 |
</div> |
| 109 |
<div class="info-box-body"> |
| 110 |
<div class="method-summary"> |
| 111 |
|
| 112 |
<div class="method-definition"> |
| 113 |
<span class="method-result">SVGGraph</span> |
| 114 |
<a href="#SVGGraph" title="details" class="method-name">SVGGraph</a> |
| 115 |
(<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>) |
| 116 |
</div> |
| 117 |
|
| 118 |
<div class="method-definition"> |
| 119 |
<span class="method-result">string</span> |
| 120 |
<a href="#format_label" title="details" class="method-name">format_label</a> |
| 121 |
(<span class="var-type">string</span> <span class="var-name">$number</span>) |
| 122 |
</div> |
| 123 |
|
| 124 |
<div class="method-definition"> |
| 125 |
<span class="method-result">mixed</span> |
| 126 |
<a href="#get_option" title="details" class="method-name">get_option</a> |
| 127 |
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
| 128 |
</div> |
| 129 |
|
| 130 |
<div class="method-definition"> |
| 131 |
<span class="method-result">array</span> |
| 132 |
<a href="#get_options" title="details" class="method-name">get_options</a> |
| 133 |
() |
| 134 |
</div> |
| 135 |
|
| 136 |
<div class="method-definition"> |
| 137 |
<span class="method-result">void</span> |
| 138 |
<a href="#render" title="details" class="method-name">render</a> |
| 139 |
(<span class="var-type">mixed</span> <span class="var-name">$indent_level</span>, <span class="var-type">mixed</span> <span class="var-name">$output_debug</span>) |
| 140 |
</div> |
| 141 |
|
| 142 |
<div class="method-definition"> |
| 143 |
<span class="method-result">void</span> |
| 144 |
<a href="#set_axis_font_height" title="details" class="method-name">set_axis_font_height</a> |
| 145 |
(<span class="var-type">int</span> <span class="var-name">$height</span>) |
| 146 |
</div> |
| 147 |
|
| 148 |
<div class="method-definition"> |
| 149 |
<span class="method-result">void</span> |
| 150 |
<a href="#set_axis_font_width" title="details" class="method-name">set_axis_font_width</a> |
| 151 |
(<span class="var-type">int</span> <span class="var-name">$width</span>) |
| 152 |
</div> |
| 153 |
|
| 154 |
<div class="method-definition"> |
| 155 |
<span class="method-result">void</span> |
| 156 |
<a href="#set_height" title="details" class="method-name">set_height</a> |
| 157 |
(<span class="var-type">int</span> <span class="var-name">$height</span>) |
| 158 |
</div> |
| 159 |
|
| 160 |
<div class="method-definition"> |
| 161 |
<span class="method-result">void</span> |
| 162 |
<a href="#set_option" title="details" class="method-name">set_option</a> |
| 163 |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>) |
| 164 |
</div> |
| 165 |
|
| 166 |
<div class="method-definition"> |
| 167 |
<span class="method-result">void</span> |
| 168 |
<a href="#set_title" title="details" class="method-name">set_title</a> |
| 169 |
(<span class="var-type">string</span> <span class="var-name">$title</span>) |
| 170 |
</div> |
| 171 |
|
| 172 |
<div class="method-definition"> |
| 173 |
<span class="method-result">void</span> |
| 174 |
<a href="#set_title_font_height" title="details" class="method-name">set_title_font_height</a> |
| 175 |
(<span class="var-type">int</span> <span class="var-name">$height</span>) |
| 176 |
</div> |
| 177 |
|
| 178 |
<div class="method-definition"> |
| 179 |
<span class="method-result">void</span> |
| 180 |
<a href="#set_title_font_width" title="details" class="method-name">set_title_font_width</a> |
| 181 |
(<span class="var-type">int</span> <span class="var-name">$width</span>) |
| 182 |
</div> |
| 183 |
|
| 184 |
<div class="method-definition"> |
| 185 |
<span class="method-result">void</span> |
| 186 |
<a href="#set_title_style" title="details" class="method-name">set_title_style</a> |
| 187 |
(<span class="var-type">string</span> <span class="var-name">$style</span>) |
| 188 |
</div> |
| 189 |
|
| 190 |
<div class="method-definition"> |
| 191 |
<span class="method-result">void</span> |
| 192 |
<a href="#set_width" title="details" class="method-name">set_width</a> |
| 193 |
(<span class="var-type">int</span> <span class="var-name">$width</span>) |
| 194 |
</div> |
| 195 |
|
| 196 |
<div class="method-definition"> |
| 197 |
<span class="method-result">Container</span> |
| 198 |
<a href="#_build_graph" title="details" class="method-name">_build_graph</a> |
| 199 |
() |
| 200 |
</div> |
| 201 |
|
| 202 |
<div class="method-definition"> |
| 203 |
<span class="method-result"><a href="../../phpHtmlLib/TEXTsvgtag.html">TEXTsvgtag</a></span> |
| 204 |
<a href="#_build_title" title="details" class="method-name">_build_title</a> |
| 205 |
() |
| 206 |
</div> |
| 207 |
|
| 208 |
<div class="method-definition"> |
| 209 |
<span class="method-result">Container</span> |
| 210 |
<a href="#_build_titles" title="details" class="method-name">_build_titles</a> |
| 211 |
() |
| 212 |
</div> |
| 213 |
|
| 214 |
<div class="method-definition"> |
| 215 |
<span class="method-result">void</span> |
| 216 |
<a href="#_prepare_data" title="details" class="method-name">_prepare_data</a> |
| 217 |
() |
| 218 |
</div> |
| 219 |
</div> |
| 220 |
</div> |
| 221 |
</div> |
| 222 |
|
| 223 |
<a name="sec-vars"></a> |
| 224 |
<div class="info-box"> |
| 225 |
<div class="info-box-title">Variables</div> |
| 226 |
<div class="nav-bar"> |
| 227 |
<a href="#sec-description">Description</a> | |
| 228 |
<a href="#sec-descendents">Descendents</a> | |
| 229 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 230 |
|
| 231 |
|
| 232 |
| |
| 233 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 234 |
|
| 235 |
</div> |
| 236 |
<div class="info-box-body"> |
| 237 |
<a name="var$_draw" id="$_draw"><!-- --></A> |
| 238 |
<div class="oddrow"> |
| 239 |
|
| 240 |
<div class="var-header"> |
| 241 |
<span class="var-title"> |
| 242 |
<span class="var-type">mixed</span> |
| 243 |
<span class="var-name">$_draw</span> |
| 244 |
= <span class="var-default">array()</span> (line <span class="line-number">50</span>) |
| 245 |
</span> |
| 246 |
</div> |
| 247 |
|
| 248 |
<!-- ========== Info from phpDoc block ========= --> |
| 249 |
<p class="short-description">Various calculated image properties</p> |
| 250 |
|
| 251 |
|
| 252 |
|
| 253 |
|
| 254 |
|
| 255 |
</div> |
| 256 |
<a name="var$_options" id="$_options"><!-- --></A> |
| 257 |
<div class="evenrow"> |
| 258 |
|
| 259 |
<div class="var-header"> |
| 260 |
<span class="var-title"> |
| 261 |
<span class="var-type">mixed</span> |
| 262 |
<span class="var-name">$_options</span> |
| 263 |
= <span class="var-default">array("title" => "",<br /> "title_style" => "font-size:20px;font-weight:bold;font-family: geneva, trebuchet ms",<br /> "width" => 100,<br /> "height" => 100,<br /> "left_margin" => 5,<br /> "right_margin" => 0,<br /> "top_margin" => 20,<br /> "bottom_margin" => 0,<br /> "title_font_width" => 10,<br /> "title_font_height" => 20,<br /> "axis_font_width" => 5,<br /> "axis_font_height" => 8,<br /> "axis_label_font_width" => 12,<br /> "axis_label_font_height" => 12)</span> (line <span class="line-number">30</span>) |
| 264 |
</span> |
| 265 |
</div> |
| 266 |
|
| 267 |
<!-- ========== Info from phpDoc block ========= --> |
| 268 |
<p class="short-description">This array holds various</p> |
| 269 |
<p class="description"><p>config options for this graph</p></p> |
| 270 |
|
| 271 |
|
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
</div> |
| 276 |
|
| 277 |
<h4>Inherited Variables</h4> |
| 278 |
<A NAME='inherited_vars'><!-- --></A> |
| 279 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
| 280 |
<blockquote> |
| 281 |
<span class="var-title"> |
| 282 |
<span class="var-name"><a href="../../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
| 283 |
</span> |
| 284 |
<span class="var-title"> |
| 285 |
<span class="var-name"><a href="../../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
| 286 |
</span> |
| 287 |
</blockquote> |
| 288 |
|
| 289 |
</div> |
| 290 |
</div> |
| 291 |
|
| 292 |
<a name="sec-methods"></a> |
| 293 |
<div class="info-box"> |
| 294 |
<div class="info-box-title">Methods</div> |
| 295 |
<div class="nav-bar"> |
| 296 |
<a href="#sec-description">Description</a> | |
| 297 |
<a href="#sec-descendents">Descendents</a> | |
| 298 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 299 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 300 |
|
| 301 |
</div> |
| 302 |
<div class="info-box-body"> |
| 303 |
<A NAME='method_detail'></A> |
| 304 |
<a name="methodSVGGraph" id="SVGGraph"><!-- --></a> |
| 305 |
<div class="oddrow"> |
| 306 |
|
| 307 |
<div class="method-header"> |
| 308 |
<span class="method-title">Constructor SVGGraph</span> (line <span class="line-number">53</span>) |
| 309 |
</div> |
| 310 |
|
| 311 |
<!-- ========== Info from phpDoc block ========= --> |
| 312 |
|
| 313 |
<div class="method-signature"> |
| 314 |
<span class="method-result">SVGGraph</span> |
| 315 |
<span class="method-name"> |
| 316 |
SVGGraph |
| 317 |
</span> |
| 318 |
(<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>) |
| 319 |
</div> |
| 320 |
|
| 321 |
|
| 322 |
|
| 323 |
</div> |
| 324 |
<a name="methodformat_label" id="format_label"><!-- --></a> |
| 325 |
<div class="evenrow"> |
| 326 |
|
| 327 |
<div class="method-header"> |
| 328 |
<span class="method-title">format_label</span> (line <span class="line-number">235</span>) |
| 329 |
</div> |
| 330 |
|
| 331 |
<!-- ========== Info from phpDoc block ========= --> |
| 332 |
<p class="short-description">This function will format the axis label</p> |
| 333 |
<ul class="tags"> |
| 334 |
<li><span class="field">return:</span> - the formated #</li> |
| 335 |
</ul> |
| 336 |
|
| 337 |
<div class="method-signature"> |
| 338 |
<span class="method-result">string</span> |
| 339 |
<span class="method-name"> |
| 340 |
format_label |
| 341 |
</span> |
| 342 |
(<span class="var-type">string</span> <span class="var-name">$number</span>) |
| 343 |
</div> |
| 344 |
|
| 345 |
<ul class="parameters"> |
| 346 |
<li> |
| 347 |
<span class="var-type">string</span> |
| 348 |
<span class="var-name">$number</span><span class="var-description">: - the number</span> </li> |
| 349 |
</ul> |
| 350 |
|
| 351 |
|
| 352 |
</div> |
| 353 |
<a name="methodget_option" id="get_option"><!-- --></a> |
| 354 |
<div class="oddrow"> |
| 355 |
|
| 356 |
<div class="method-header"> |
| 357 |
<span class="method-title">get_option</span> (line <span class="line-number">128</span>) |
| 358 |
</div> |
| 359 |
|
| 360 |
<!-- ========== Info from phpDoc block ========= --> |
| 361 |
<p class="short-description">This function retuns the value of 1 option</p> |
| 362 |
<ul class="tags"> |
| 363 |
<li><span class="field">return:</span> - the value</li> |
| 364 |
</ul> |
| 365 |
|
| 366 |
<div class="method-signature"> |
| 367 |
<span class="method-result">mixed</span> |
| 368 |
<span class="method-name"> |
| 369 |
get_option |
| 370 |
</span> |
| 371 |
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
| 372 |
</div> |
| 373 |
|
| 374 |
<ul class="parameters"> |
| 375 |
<li> |
| 376 |
<span class="var-type">string</span> |
| 377 |
<span class="var-name">$name</span><span class="var-description">: - the option name</span> </li> |
| 378 |
</ul> |
| 379 |
|
| 380 |
|
| 381 |
</div> |
| 382 |
<a name="methodget_options" id="get_options"><!-- --></a> |
| 383 |
<div class="evenrow"> |
| 384 |
|
| 385 |
<div class="method-header"> |
| 386 |
<span class="method-title">get_options</span> (line <span class="line-number">138</span>) |
| 387 |
</div> |
| 388 |
|
| 389 |
<!-- ========== Info from phpDoc block ========= --> |
| 390 |
<p class="short-description">This returns the array of ALL of the options for this graph</p> |
| 391 |
|
| 392 |
<div class="method-signature"> |
| 393 |
<span class="method-result">array</span> |
| 394 |
<span class="method-name"> |
| 395 |
get_options |
| 396 |
</span> |
| 397 |
() |
| 398 |
</div> |
| 399 |
|
| 400 |
|
| 401 |
|
| 402 |
</div> |
| 403 |
<a name="methodrender" id="render"><!-- --></a> |
| 404 |
<div class="oddrow"> |
| 405 |
|
| 406 |
<div class="method-header"> |
| 407 |
<span class="method-title">render</span> (line <span class="line-number">60</span>) |
| 408 |
</div> |
| 409 |
|
| 410 |
<!-- ========== Info from phpDoc block ========= --> |
| 411 |
|
| 412 |
<div class="method-signature"> |
| 413 |
<span class="method-result">void</span> |
| 414 |
<span class="method-name"> |
| 415 |
render |
| 416 |
</span> |
| 417 |
(<span class="var-type">mixed</span> <span class="var-name">$indent_level</span>, <span class="var-type">mixed</span> <span class="var-name">$output_debug</span>) |
| 418 |
</div> |
| 419 |
|
| 420 |
|
| 421 |
<hr class="separator" /> |
| 422 |
<div class="notes">Redefinition of:</div> |
| 423 |
<dl> |
| 424 |
<dt><a href="../../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
| 425 |
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
| 426 |
</dl> |
| 427 |
|
| 428 |
</div> |
| 429 |
<a name="methodset_axis_font_height" id="set_axis_font_height"><!-- --></a> |
| 430 |
<div class="evenrow"> |
| 431 |
|
| 432 |
<div class="method-header"> |
| 433 |
<span class="method-title">set_axis_font_height</span> (line <span class="line-number">224</span>) |
| 434 |
</div> |
| 435 |
|
| 436 |
<!-- ========== Info from phpDoc block ========= --> |
| 437 |
<p class="short-description">This method sets the height of font used in calculating the x and y axis point fonts.</p> |
| 438 |
|
| 439 |
<div class="method-signature"> |
| 440 |
<span class="method-result">void</span> |
| 441 |
<span class="method-name"> |
| 442 |
set_axis_font_height |
| 443 |
</span> |
| 444 |
(<span class="var-type">int</span> <span class="var-name">$height</span>) |
| 445 |
</div> |
| 446 |
|
| 447 |
<ul class="parameters"> |
| 448 |
<li> |
| 449 |
<span class="var-type">int</span> |
| 450 |
<span class="var-name">$height</span><span class="var-description">: - the height</span> </li> |
| 451 |
</ul> |
| 452 |
|
| 453 |
|
| 454 |
</div> |
| 455 |
<a name="methodset_axis_font_width" id="set_axis_font_width"><!-- --></a> |
| 456 |
<div class="oddrow"> |
| 457 |
|
| 458 |
<div class="method-header"> |
| 459 |
<span class="method-title">set_axis_font_width</span> (line <span class="line-number">213</span>) |
| 460 |
</div> |
| 461 |
|
| 462 |
<!-- ========== Info from phpDoc block ========= --> |
| 463 |
<p class="short-description">This method sets the width of font used in calculating the x and y axis point fonts.</p> |
| 464 |
|
| 465 |
<div class="method-signature"> |
| 466 |
<span class="method-result">void</span> |
| 467 |
<span class="method-name"> |
| 468 |
set_axis_font_width |
| 469 |
</span> |
| 470 |
(<span class="var-type">int</span> <span class="var-name">$width</span>) |
| 471 |
</div> |
| 472 |
|
| 473 |
<ul class="parameters"> |
| 474 |
<li> |
| 475 |
<span class="var-type">int</span> |
| 476 |
<span class="var-name">$width</span><span class="var-description">: - the width</span> </li> |
| 477 |
</ul> |
| 478 |
|
| 479 |
|
| 480 |
</div> |
| 481 |
<a name="methodset_height" id="set_height"><!-- --></a> |
| 482 |
<div class="evenrow"> |
| 483 |
|
| 484 |
<div class="method-header"> |
| 485 |
<span class="method-title">set_height</span> (line <span class="line-number">179</span>) |
| 486 |
</div> |
| 487 |
|
| 488 |
<!-- ========== Info from phpDoc block ========= --> |
| 489 |
<p class="short-description">This method sets the height of the graph</p> |
| 490 |
|
| 491 |
<div class="method-signature"> |
| 492 |
<span class="method-result">void</span> |
| 493 |
<span class="method-name"> |
| 494 |
set_height |
| 495 |
</span> |
| 496 |
(<span class="var-type">int</span> <span class="var-name">$height</span>) |
| 497 |
</div> |
| 498 |
|
| 499 |
<ul class="parameters"> |
| 500 |
<li> |
| 501 |
<span class="var-type">int</span> |
| 502 |
<span class="var-name">$height</span><span class="var-description">: - the height</span> </li> |
| 503 |
</ul> |
| 504 |
|
| 505 |
|
| 506 |
</div> |
| 507 |
<a name="methodset_option" id="set_option"><!-- --></a> |
| 508 |
<div class="oddrow"> |
| 509 |
|
| 510 |
<div class="method-header"> |
| 511 |
<span class="method-title">set_option</span> (line <span class="line-number">117</span>) |
| 512 |
</div> |
| 513 |
|
| 514 |
<!-- ========== Info from phpDoc block ========= --> |
| 515 |
<p class="short-description">This function is used to set a particular option for the graph</p> |
| 516 |
|
| 517 |
<div class="method-signature"> |
| 518 |
<span class="method-result">void</span> |
| 519 |
<span class="method-name"> |
| 520 |
set_option |
| 521 |
</span> |
| 522 |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">mixed</span> <span class="var-name">$value</span>) |
| 523 |
</div> |
| 524 |
|
| 525 |
<ul class="parameters"> |
| 526 |
<li> |
| 527 |
<span class="var-type">string</span> |
| 528 |
<span class="var-name">$name</span><span class="var-description">: - the option name</span> </li> |
| 529 |
<li> |
| 530 |
<span class="var-type">mixed</span> |
| 531 |
<span class="var-name">$value</span><span class="var-description">: - the value</span> </li> |
| 532 |
</ul> |
| 533 |
|
| 534 |
|
| 535 |
</div> |
| 536 |
<a name="methodset_title" id="set_title"><!-- --></a> |
| 537 |
<div class="evenrow"> |
| 538 |
|
| 539 |
<div class="method-header"> |
| 540 |
<span class="method-title">set_title</span> (line <span class="line-number">149</span>) |
| 541 |
</div> |
| 542 |
|
| 543 |
<!-- ========== Info from phpDoc block ========= --> |
| 544 |
<p class="short-description">This method sets the title for the graph</p> |
| 545 |
|
| 546 |
<div class="method-signature"> |
| 547 |
<span class="method-result">void</span> |
| 548 |
<span class="method-name"> |
| 549 |
set_title |
| 550 |
</span> |
| 551 |
(<span class="var-type">string</span> <span class="var-name">$title</span>) |
| 552 |
</div> |
| 553 |
|
| 554 |
<ul class="parameters"> |
| 555 |
<li> |
| 556 |
<span class="var-type">string</span> |
| 557 |
<span class="var-name">$title</span><span class="var-description">: - the graph's title</span> </li> |
| 558 |
</ul> |
| 559 |
|
| 560 |
<hr class="separator" /> |
| 561 |
<div class="notes">Redefinition of:</div> |
| 562 |
<dl> |
| 563 |
<dt><a href="../../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></dt> |
| 564 |
<dd>Set the title for the widget.</dd> |
| 565 |
</dl> |
| 566 |
|
| 567 |
</div> |
| 568 |
<a name="methodset_title_font_height" id="set_title_font_height"><!-- --></a> |
| 569 |
<div class="oddrow"> |
| 570 |
|
| 571 |
<div class="method-header"> |
| 572 |
<span class="method-title">set_title_font_height</span> (line <span class="line-number">201</span>) |
| 573 |
</div> |
| 574 |
|
| 575 |
<!-- ========== Info from phpDoc block ========= --> |
| 576 |
<p class="short-description">This method sets the height of font in pixels for the Graph Title.</p> |
| 577 |
|
| 578 |
<div class="method-signature"> |
| 579 |
<span class="method-result">void</span> |
| 580 |
<span class="method-name"> |
| 581 |
set_title_font_height |
| 582 |
</span> |
| 583 |
(<span class="var-type">int</span> <span class="var-name">$height</span>) |
| 584 |
</div> |
| 585 |
|
| 586 |
<ul class="parameters"> |
| 587 |
<li> |
| 588 |
<span class="var-type">int</span> |
| 589 |
<span class="var-name">$height</span><span class="var-description">: - the height</span> </li> |
| 590 |
</ul> |
| 591 |
|
| 592 |
|
| 593 |
</div> |
| 594 |
<a name="methodset_title_font_width" id="set_title_font_width"><!-- --></a> |
| 595 |
<div class="evenrow"> |
| 596 |
|
| 597 |
<div class="method-header"> |
| 598 |
<span class="method-title">set_title_font_width</span> (line <span class="line-number">190</span>) |
| 599 |
</div> |
| 600 |
|
| 601 |
<!-- ========== Info from phpDoc block ========= --> |
| 602 |
<p class="short-description">This method sets the width of font in pixels for the Graph Title.</p> |
| 603 |
|
| 604 |
<div class="method-signature"> |
| 605 |
<span class="method-result">void</span> |
| 606 |
<span class="method-name"> |
| 607 |
set_title_font_width |
| 608 |
</span> |
| 609 |
(<span class="var-type">int</span> <span class="var-name">$width</span>) |
| 610 |
</div> |
| 611 |
|
| 612 |
<ul class="parameters"> |
| 613 |
<li> |
| 614 |
<span class="var-type">int</span> |
| 615 |
<span class="var-name">$width</span><span class="var-description">: - the width</span> </li> |
| 616 |
</ul> |
| 617 |
|
| 618 |
|
| 619 |
</div> |
| 620 |
<a name="methodset_title_style" id="set_title_style"><!-- --></a> |
| 621 |
<div class="oddrow"> |
| 622 |
|
| 623 |
<div class="method-header"> |
| 624 |
<span class="method-title">set_title_style</span> (line <span class="line-number">159</span>) |
| 625 |
</div> |
| 626 |
|
| 627 |
<!-- ========== Info from phpDoc block ========= --> |
| 628 |
<p class="short-description">This method sets the title for the graph</p> |
| 629 |
|
| 630 |
<div class="method-signature"> |
| 631 |
<span class="method-result">void</span> |
| 632 |
<span class="method-name"> |
| 633 |
set_title_style |
| 634 |
</span> |
| 635 |
(<span class="var-type">string</span> <span class="var-name">$style</span>) |
| 636 |
</div> |
| 637 |
|
| 638 |
<ul class="parameters"> |
| 639 |
<li> |
| 640 |
<span class="var-type">string</span> |
| 641 |
<span class="var-name">$style</span><span class="var-description">: - the graph's title</span> </li> |
| 642 |
</ul> |
| 643 |
|
| 644 |
|
| 645 |
</div> |
| 646 |
<a name="methodset_width" id="set_width"><!-- --></a> |
| 647 |
<div class="evenrow"> |
| 648 |
|
| 649 |
<div class="method-header"> |
| 650 |
<span class="method-title">set_width</span> (line <span class="line-number">169</span>) |
| 651 |
</div> |
| 652 |
|
| 653 |
<!-- ========== Info from phpDoc block ========= --> |
| 654 |
<p class="short-description">This method sets the width of the graph</p> |
| 655 |
|
| 656 |
<div class="method-signature"> |
| 657 |
<span class="method-result">void</span> |
| 658 |
<span class="method-name"> |
| 659 |
set_width |
| 660 |
</span> |
| 661 |
(<span class="var-type">int</span> <span class="var-name">$width</span>) |
| 662 |
</div> |
| 663 |
|
| 664 |
<ul class="parameters"> |
| 665 |
<li> |
| 666 |
<span class="var-type">int</span> |
| 667 |
<span class="var-name">$width</span><span class="var-description">: - the width</span> </li> |
| 668 |
</ul> |
| 669 |
|
| 670 |
<hr class="separator" /> |
| 671 |
<div class="notes">Redefinition of:</div> |
| 672 |
<dl> |
| 673 |
<dt><a href="../../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></dt> |
| 674 |
<dd>Set the width for the widget.</dd> |
| 675 |
</dl> |
| 676 |
|
| 677 |
</div> |
| 678 |
<a name="method_build_graph" id="_build_graph"><!-- --></a> |
| 679 |
<div class="oddrow"> |
| 680 |
|
| 681 |
<div class="method-header"> |
| 682 |
<span class="method-title">_build_graph</span> (line <span class="line-number">99</span>) |
| 683 |
</div> |
| 684 |
|
| 685 |
<!-- ========== Info from phpDoc block ========= --> |
| 686 |
<p class="short-description">This is a stub that the child class must override to build the actual graph</p> |
| 687 |
|
| 688 |
<div class="method-signature"> |
| 689 |
<span class="method-result">Container</span> |
| 690 |
<span class="method-name"> |
| 691 |
_build_graph |
| 692 |
</span> |
| 693 |
() |
| 694 |
</div> |
| 695 |
|
| 696 |
|
| 697 |
|
| 698 |
<hr class="separator" /> |
| 699 |
<div class="notes">Redefined in descendants as:</div> |
| 700 |
<ul class="redefinitions"> |
| 701 |
<li> |
| 702 |
<a href="../../phpHtmlLib/SVG/SVGXYGraph.html#method_build_graph">SVGXYGraph::_build_graph()</a> |
| 703 |
: This function does the work of building the graph itself |
| 704 |
</li> |
| 705 |
</ul> |
| 706 |
</div> |
| 707 |
<a name="method_build_title" id="_build_title"><!-- --></a> |
| 708 |
<div class="evenrow"> |
| 709 |
|
| 710 |
<div class="method-header"> |
| 711 |
<span class="method-title">_build_title</span> (line <span class="line-number">246</span>) |
| 712 |
</div> |
| 713 |
|
| 714 |
<!-- ========== Info from phpDoc block ========= --> |
| 715 |
<p class="short-description">This method builds the text title area that lives on top of the graph</p> |
| 716 |
|
| 717 |
<div class="method-signature"> |
| 718 |
<span class="method-result"><a href="../../phpHtmlLib/TEXTsvgtag.html">TEXTsvgtag</a></span> |
| 719 |
<span class="method-name"> |
| 720 |
_build_title |
| 721 |
</span> |
| 722 |
() |
| 723 |
</div> |
| 724 |
|
| 725 |
|
| 726 |
|
| 727 |
</div> |
| 728 |
<a name="method_build_titles" id="_build_titles"><!-- --></a> |
| 729 |
<div class="oddrow"> |
| 730 |
|
| 731 |
<div class="method-header"> |
| 732 |
<span class="method-title">_build_titles</span> (line <span class="line-number">88</span>) |
| 733 |
</div> |
| 734 |
|
| 735 |
<!-- ========== Info from phpDoc block ========= --> |
| 736 |
<p class="short-description">This is a stub for building the title(s) for the graph</p> |
| 737 |
|
| 738 |
<div class="method-signature"> |
| 739 |
<span class="method-result">Container</span> |
| 740 |
<span class="method-name"> |
| 741 |
_build_titles |
| 742 |
</span> |
| 743 |
() |
| 744 |
</div> |
| 745 |
|
| 746 |
|
| 747 |
|
| 748 |
<hr class="separator" /> |
| 749 |
<div class="notes">Redefined in descendants as:</div> |
| 750 |
<ul class="redefinitions"> |
| 751 |
<li> |
| 752 |
<a href="../../phpHtmlLib/SVG/SVGXYGraph.html#method_build_titles">SVGXYGraph::_build_titles()</a> |
| 753 |
: This is a stub for building the title(s) for the graph |
| 754 |
</li> |
| 755 |
</ul> |
| 756 |
</div> |
| 757 |
<a name="method_prepare_data" id="_prepare_data"><!-- --></a> |
| 758 |
<div class="evenrow"> |
| 759 |
|
| 760 |
<div class="method-header"> |
| 761 |
<span class="method-title">_prepare_data</span> (line <span class="line-number">77</span>) |
| 762 |
</div> |
| 763 |
|
| 764 |
<!-- ========== Info from phpDoc block ========= --> |
| 765 |
<p class="short-description">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.</p> |
| 766 |
|
| 767 |
<div class="method-signature"> |
| 768 |
<span class="method-result">void</span> |
| 769 |
<span class="method-name"> |
| 770 |
_prepare_data |
| 771 |
</span> |
| 772 |
() |
| 773 |
</div> |
| 774 |
|
| 775 |
|
| 776 |
|
| 777 |
<hr class="separator" /> |
| 778 |
<div class="notes">Redefined in descendants as:</div> |
| 779 |
<ul class="redefinitions"> |
| 780 |
<li> |
| 781 |
<a href="../../phpHtmlLib/SVG/SVGXYGraph.html#method_prepare_data">SVGXYGraph::_prepare_data()</a> |
| 782 |
: We need this to calculate the min,max values for |
| 783 |
</li> |
| 784 |
</ul> |
| 785 |
</div> |
| 786 |
<h4>Inherited Methods</h4> |
| 787 |
<a name='inherited_methods'><!-- --></a> |
| 788 |
<!-- =========== Summary =========== --> |
| 789 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
| 790 |
<blockquote> |
| 791 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
| 792 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
| 793 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
| 794 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
| 795 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
| 796 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
| 797 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
| 798 |
<span class="method-name"><a href="../../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
| 799 |
</blockquote> |
| 800 |
<!-- =========== Summary =========== --> |
| 801 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/Container.html">Container</a></span></p> |
| 802 |
<blockquote> |
| 803 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
| 804 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
| 805 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
| 806 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
| 807 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br> |
| 808 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
| 809 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
| 810 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
| 811 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
| 812 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
| 813 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
| 814 |
<span class="method-name"><a href="../../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
| 815 |
</blockquote> |
| 816 |
|
| 817 |
</div> |
| 818 |
</div> |
| 819 |
|
| 820 |
|
| 821 |
<p class="notes" id="credit"> |
| 822 |
Documentation generated on Thu, 1 Apr 2004 09:39:15 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
| 823 |
</p> |
| 824 |
</div></body> |
| 825 |
</html> |