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