PageRenderTime 61ms CodeModel.GetById 9ms app.highlight 44ms RepoModel.GetById 1ms app.codeStats 1ms

/jpgraph/docs/classref/Plot.html

https://gitlab.com/track-iot/ui
HTML | 220 lines | 163 code | 46 blank | 11 comment | 0 complexity | c40a5bf90383d99b4bd9ec06ccfb2458 MD5 | raw file
  1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML><HEAD><style type="text/css">
  2		<!--
  3		A:link        {font-family: helvetica, arial, geneva, sans-serif; font-size: small; text-decoration: none; color: #000000}
  4		A:visited     {font-family: helvetica, arial, geneva, sans-serif; font-size: small; text-decoration: none; color: #000000}
  5		A:hover       {font-family: helvetica, arial, geneva, sans-serif; font-size: small; text-decoration: underline; color: #FF0000}
  6        A.no:link        {font-family:inherit; font-size: inhreit;text-decoration: none; color: #000000}
  7        A.no:visited     {font-family:inherit; font-size: inherit;text-decoration: none; color: #000000}
  8        A.no:hover       {font-family:inherit; font-size: inherit;text-decoration: none; color: #000000}
  9		th            {font-family: helvetica, arial; color : black; font-size:90%; background : #b7c8b7; border-right:black solid 1pt; border-bottom:black solid 1pt;}
 10        td            {font-family: helvetica, arial; color : black; font-size:90%; background : white; border-right:black solid 1pt; border-bottom:black solid 1pt;}
 11
 12		//-->
 13		</style></HEAD><hr><div style="padding-left:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;background-color:#deaa87;font-family:courier new;font-size:16pt;">Class <a class="no" name="_C_PLOT"><b>Plot</b></a></div>
 14<i>(Defined in: jpgraph.php : 5093)</i><br>&nbsp;<br><table cellspaceing=0 cellpadding=4 style="border:solid #303030 1px;"><tr><td align="center" style="background:lightgray;" >&nbsp;<a href="Plot.html" style="font-family:arial;font-weight:bold;color:darkblue;">Plot</a>&nbsp;</td></tr><tr><td valign=top>&nbsp;<a href="Plot.html#_PLOT_HIDELEGEND">HideLegend()</a>&nbsp;<br>
 15&nbsp;<a href="Plot.html#_PLOT_PRESCALESETUP">PreScaleSetup()</a>&nbsp;<br>
 16&nbsp;<a href="Plot.html#_PLOT_SETCENTER">SetCenter()</a>&nbsp;<br>
 17&nbsp;<a href="Plot.html#_PLOT_SETCOLOR">SetColor()</a>&nbsp;<br>
 18&nbsp;<a href="Plot.html#_PLOT_SETCSIMTARGETS">SetCSIMTargets()</a>&nbsp;<br>
 19&nbsp;<a href="Plot.html#_PLOT_SETLEGEND">SetLegend()</a>&nbsp;<br>
 20&nbsp;<a href="Plot.html#_PLOT_SETLINEWEIGHT">SetLineWeight()</a>&nbsp;<br>
 21</td></tr></table>&nbsp;<p><div style="font-weight:bold;font-family:arial;font-size:100%;">Class usage and Overview</div>Abstract base class for all plots. This abstract base class defines the signature that all plots must adhere to. It also provides the default trivial implementation for these framework methods.
 22
 23<b>Public properties:</b>
 24<table width=80%>
 25<tr><th width=20%> Name </th><th width=20%> Type </th><th> Description </th></tr>
 26
 27<tr><td> value </td><td> DisplayValue </td><td> Control the data value displayed at each data point</td></tr>
 28
 29</table>
 30 <p> &nbsp;
 31<div style="font-weight:bold;font-family:arial;font-size:85%;">See also related classes:</div><a href="DisplayValue.html">DisplayValue</a>, <a href="LinePlot.html">LinePlot</a>, <a href="ErrorPlot.html">ErrorPlot</a> and <a href="ScatterPlot.html">ScatterPlot</a> <p> &nbsp;<hr><span style="font-family:arial;font-size:120%;font-weight:bold;">Class Methods</span><hr><p>
 32<p> &nbsp; <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_PLOT_HIDELEGEND"><span style="color:#555555;">Plot ::</span><br><b>HideLegend</b>($f)</a></div>
 33
 34<span style='font-family:arial;font-size:95%;'><i>Hide legend for this plot</i></span><p>
 35
 36<table cellspacing=0 style='border:black solid 1pt;' width=100%>
 37<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
 38<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
 39<span style="color: #0000BB">$f</span>
 40</span>
 41
 42</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
 43<span style="color: #0000BB">true</span>
 44</span>
 45</td><td>TRUE=Hide legend</td></tr>
 46</table>
 47
 48<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Hide legend for this plot even if it was specified (with SetLegend() ) &nbsp;<br>
 49
 50<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
 51<span style="color: #0000BB">$bar&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">GanttBar</span><span style="color: #007700">(...);
 52<br /></span><span style="color: #0000BB">$bar</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">HideLegend</span><span style="color: #007700">();
 53<br /></span><span style="color: #0000BB"></span>
 54</span>
 55</b></div><br>
 56<p>
 57<p> &nbsp; <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_PLOT_PRESCALESETUP"><span style="color:#555555;">Plot ::</span><br><b>PreScaleSetup</b>($aGraph)</a></div>
 58
 59<span style='font-family:arial;font-size:95%;'><i>// Virtual function to the the concrete plot class to make any changes to the graph// and scale before the stroke process begins</i></span><p>
 60
 61<table cellspacing=0 style='border:black solid 1pt;' width=100%>
 62<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
 63<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
 64<span style="color: #0000BB">$aGraph</span>
 65</span>
 66
 67</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'>&nbsp;</td><td>No description available</td></tr>
 68</table>
 69
 70<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>No description available.<p>
 71<p> &nbsp; <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_PLOT_SETCENTER"><span style="color:#555555;">Plot ::</span><br><b>SetCenter</b>($aCenter)</a></div>
 72
 73<span style='font-family:arial;font-size:95%;'><i>Center the data pointr between tick labels</i></span><p>
 74
 75<table cellspacing=0 style='border:black solid 1pt;' width=100%>
 76<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
 77<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
 78<span style="color: #0000BB">$aCenter</span>
 79</span>
 80
 81</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
 82<span style="color: #0000BB">true</span>
 83</span>
 84</td><td>True=Center each data point</td></tr>
 85</table>
 86
 87<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Used for text scales. Centers the data values between the ticvk marks instead if falling exactly on them.
 88&nbsp;<br>
 89
 90<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
 91<span style="color: #0000BB">$barplot</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">SetCenter</span><span style="color: #007700">();</span><span style="color: #0000BB"></span>
 92</span>
 93</b></div><br>
 94<p>
 95<p> &nbsp; <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_PLOT_SETCOLOR"><span style="color:#555555;">Plot ::</span><br><b>SetColor</b>($aColor)</a></div>
 96
 97<span style='font-family:arial;font-size:95%;'><i>Specify color for plot.</i></span><p>
 98
 99<table cellspacing=0 style='border:black solid 1pt;' width=100%>
100<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
101<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
102<span style="color: #0000BB">$aColor</span>
103</span>
104
105</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'>&nbsp;</td><td>Color</td></tr>
106</table>
107
108<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Specify color for plot. Each plot type is free to interpret it to its own choosing.&nbsp;<br>
109
110<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
111<span style="color: #0000BB">$lineplot</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">SetColor</span><span style="color: #007700">(</span><span style="color: #DD0000">'red'</span><span style="color: #007700">);
112<br /></span><span style="color: #0000BB"></span>
113</span>
114</b></div><br>
115<p>
116<p> &nbsp; <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_PLOT_SETCSIMTARGETS"><span style="color:#555555;">Plot ::</span><br><b>SetCSIMTargets</b>($aTargets, $aAlts, $aWinTargets)</a></div>
117
118<span style='font-family:arial;font-size:95%;'><i>Set URL targets for CSIM</i></span><p>
119
120<table cellspacing=0 style='border:black solid 1pt;' width=100%>
121<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
122<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
123<span style="color: #0000BB">$aTargets</span>
124</span>
125
126</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'>&nbsp;</td><td>Array of URL targets</td></tr>
127
128<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
129<span style="color: #0000BB">$aAlts</span>
130</span>
131
132</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
133<span style="color: #0000BB"></span><span style="color: #DD0000">''</span><span style="color: #0000BB"></span>
134</span>
135</td><td>Alt texts for each CSIM point</td></tr>
136
137<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
138<span style="color: #0000BB">$aWinTargets</span>
139</span>
140
141</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
142<span style="color: #0000BB"></span><span style="color: #DD0000">''</span><span style="color: #0000BB"></span>
143</span>
144</td><td>No description available</td></tr>
145</table>
146
147<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Set the URL links for the CSIM if the plot type support this.&nbsp;<br>
148
149<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
150<span style="color: #0000BB">$url1&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">"http://someotherurl.html"
151<br /></span><span style="color: #0000BB">$url2&nbsp;</span><span style="color: #007700">=&nbsp;..
152<br />...
153<br />
154<br /></span><span style="color: #0000BB">$targetarray&nbsp;</span><span style="color: #007700">=&nbsp;array(</span><span style="color: #0000BB">$url1</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$url2</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$url3</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$url4</span><span style="color: #007700">);
155<br /></span><span style="color: #0000BB">$barplot</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">SetCSIMTargets</span><span style="color: #007700">(</span><span style="color: #0000BB">$targetarray</span><span style="color: #007700">);</span><span style="color: #0000BB"></span>
156</span>
157</b></div><br>
158<p>
159<p> &nbsp; <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_PLOT_SETLEGEND"><span style="color:#555555;">Plot ::</span><br><b>SetLegend</b>($aLegend, $aCSIM, $aCSIMAlt, $aCSIMWinTarget)</a></div>
160
161<span style='font-family:arial;font-size:95%;'><i>Set legend string for this plot</i></span><p>
162
163<table cellspacing=0 style='border:black solid 1pt;' width=100%>
164<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
165<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
166<span style="color: #0000BB">$aLegend</span>
167</span>
168
169</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'>&nbsp;</td><td>Legend string</td></tr>
170
171<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
172<span style="color: #0000BB">$aCSIM</span>
173</span>
174
175</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
176<span style="color: #0000BB"></span><span style="color: #DD0000">''</span><span style="color: #0000BB"></span>
177</span>
178</td><td>URL for image map</td></tr>
179
180<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
181<span style="color: #0000BB">$aCSIMAlt</span>
182</span>
183
184</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
185<span style="color: #0000BB"></span><span style="color: #DD0000">''</span><span style="color: #0000BB"></span>
186</span>
187</td><td>Alt text for image map</td></tr>
188
189<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
190<span style="color: #0000BB">$aCSIMWinTarget</span>
191</span>
192
193</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
194<span style="color: #0000BB"></span><span style="color: #DD0000">''</span><span style="color: #0000BB"></span>
195</span>
196</td><td>No description available</td></tr>
197</table>
198
199<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Set legend string for this plot. If the CSIM string is epscified then the legend will become an image map. To use image maps you need to use the StrokeCSIM() instead of the normal Stroke()&nbsp;<br>
200 &nbsp; <div style="font-weight:bold;font-family:arial;font-size:90%;">See also:</div><ul><li><a href="Graph.html#_GRAPH_STROKECSIM">Graph::StrokeCSIM()</a></ul>
201<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
202<span style="color: #0000BB">$lineplot</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">SetLegend</span><span style="color: #007700">(</span><span style="color: #DD0000">'Year&nbsp;2002'</span><span style="color: #007700">);</span><span style="color: #0000BB"></span>
203</span>
204</b></div><br>
205<p>
206<p> &nbsp; <div style='font-family: helvetica, arial, geneva, sans-serif;margin-bottom:4px;border-left:solid black 1px;border-top:solid black 1px;border-bottom:solid black 2px;border-right:solid black 2px;font-size:120%;background:#dde9af;padding:4px;'><a class="no" name="_PLOT_SETLINEWEIGHT"><span style="color:#555555;">Plot ::</span><br><b>SetLineWeight</b>($aWeight)</a></div>
207
208<span style='font-family:arial;font-size:95%;'><i>Specify line weight for plot</i></span><p>
209
210<table cellspacing=0 style='border:black solid 1pt;' width=100%>
211<tr><th width=25%>Argument</th><th width=15%>Default</th><th width=60%>Description</th></tr>
212<tr><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
213<span style="color: #0000BB">$aWeight</span>
214</span>
215
216</td><td style='border-right:black solid 1pt;font-family:courier;font-size:100%;font-weight:bold;'><span style="color: #000000">
217<span style="color: #0000BB">1</span>
218</span>
219</td><td>Line weight in pixels</td></tr>
220</table>
221
222<div style="font-weight:bold;font-family:arial;font-size:90%;">Description:</div>Specify line weight for plot&nbsp;<br>
223
224<div style="font-weight:bold;font-family:arial;font-size:90%;"><p>Example:</div><div style="padding:5px;border:dashed gray 1px;background-color:#f3f3f3;font-family:courier new;font-size:90%;font-weight:bold;"><b><span style="color: #000000">
225<span style="color: #0000BB">$lineplot</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">SetWeight</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">);</span><span style="color: #0000BB"></span>
226</span>
227</b></div><br>
228<p> <hr> <p></html>