Subversion Repositories Applications.gtt

Rev

Rev 60 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
60 jpm 1
<html>
2
	<head>
3
		<title>Documentation</title>
4
		<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
5
		<link rel='stylesheet' href='style.css' />
6
	</head>
7
 
8
	<body>
9
		<div align='center'>
10
		<table cellpadding='0' cellspacing='0' id='contenu' class='round' style='width: 80%; margin-bottom: 20px'>
11
			<tr>
12
				<td class='borderhg'>&nbsp;</td>
13
				<td class='borderh'>&nbsp;</td>
14
				<td class='cornerhd'></td>
15
			</tr>
16
			<tr>
17
				<td class='borderg'>&nbsp;</td>
18
				<td><a id="top"></a><h2> Class Plot</h2><div class="extends"><ul>
19
<li><a href="Component.html">Component</a></li>
20
<ul><li>Plot</li></ul>
21
</ul></div><div class="description">
22
		<p>
23
			Cette classe est la base des <a href="LinePlot.html">courbes</a> et <a href="BarPlot.html">histogrammes</a> sur Artichow.
24
		</p>
25
	</div><div class="inherit">
26
			Les classes suivantes dérivent de Plot :
27
				<ul>
28
<li><a href="LinePlot.html">LinePlot</a></li>
29
<li><a href="BarPlot.html">BarPlot</a></li>
30
<li><a href="ScatterPlot.html">ScatterPlot</a></li>
31
</ul>
32
</div><ul class="links"><li><a href="index.html">Retourner voir la liste de toutes les classes</a></li></ul><h2>Méthodes et propriétés</h2><ul class="constants">
33
<li>
34
<span class="access">const</span> <span class="type">string</span> <a href="Plot.html#constant.LEFT">LEFT</a> := <span class="default">left</span>
35
</li>
36
<li>
37
<span class="access">const</span> <span class="type">string</span> <a href="Plot.html#constant.RIGHT">RIGHT</a> := <span class="default">right</span>
38
</li>
39
<li>
40
<span class="access">const</span> <span class="type">string</span> <a href="Plot.html#constant.TOP">TOP</a> := <span class="default">top</span>
41
</li>
42
<li>
43
<span class="access">const</span> <span class="type">string</span> <a href="Plot.html#constant.BOTTOM">BOTTOM</a> := <span class="default">bottom</span>
44
</li>
45
<li>
46
<span class="access">const</span> <span class="type">string</span> <a href="Plot.html#constant.BOTH">BOTH</a> := <span class="default">both</span>
47
</li>
48
</ul><ul class="properties">
49
<li>
50
<span class="access">public</span> <span class="type">array</span> <a href="Plot.html#property.datay"><span class="argument">$datay</span></a>
51
</li>
52
<li>
53
<span class="access">public</span> <span class="type">array</span> <a href="Plot.html#property.datax"><span class="argument">$datax</span></a>
54
</li>
55
<li>
56
<span class="access">public</span> <a href="Grid.html"><span class="type">Grid</span></a> <a href="Plot.html#property.grid"><span class="argument">$grid</span></a>
57
</li>
58
<li>
59
<span class="access">public</span> <a href="Axis.html"><span class="type">Axis</span></a> <a href="Plot.html#property.xAxis"><span class="argument">$xAxis</span></a>
60
</li>
61
<li>
62
<span class="access">public</span> <a href="Axis.html"><span class="type">Axis</span></a> <a href="Plot.html#property.yAxis"><span class="argument">$yAxis</span></a>
63
</li>
64
<li>
65
<span class="access">protected</span> <span class="type">bool</span> <a href="Plot.html#property.xAxisZero"><span class="argument">$xAxisZero</span></a> := <span class="default">TRUE</span>
66
</li>
67
</ul><ul class="methods">
68
<li>
69
<span class="access">public</span> <a href="Plot.html#method.__construct">__construct</a>()
70
	</li>
71
<li>
72
<span class="access">public</span> <a href="Plot.html#method.reduce">reduce</a>(<a href="number.html"><span class="type">number</span></a> <span class="argument">$number</span>)
73
	</li>
74
<li>
75
<span class="access">public</span> <a href="Plot.html#method.setXAxis">setXAxis</a>(<span class="type">string</span> <span class="argument">$axis</span>)
76
	</li>
77
<li>
78
<span class="access">public</span> <a href="Plot.html#method.setYAxis">setYAxis</a>(<span class="type">string</span> <span class="argument">$axis</span>)
79
	</li>
80
<li>
81
<span class="access">public</span> <a href="Plot.html#method.setXAxisZero">setXAxisZero</a>(<span class="type">bool</span> <span class="argument">$zero</span>)
82
	</li>
83
<li>
84
<span class="access">public</span> <a href="Plot.html#method.setYAxisZero">setYAxisZero</a>(<span class="type">bool</span> <span class="argument">$zero</span>)
85
	</li>
86
<li>
87
<span class="access">public</span> <a href="Plot.html#method.setYMin">setYMin</a>(<span class="type">float</span> <span class="argument">$value</span>)
88
	</li>
89
<li>
90
<span class="access">public</span> <a href="Plot.html#method.setYMax">setYMax</a>(<span class="type">float</span> <span class="argument">$value</span>)
91
	</li>
92
<li>
93
<span class="access">public</span> <a href="Plot.html#method.setXMin">setXMin</a>(<span class="type">float</span> <span class="argument">$value</span>)
94
	</li>
95
<li>
96
<span class="access">public</span> <a href="Plot.html#method.setXMax">setXMax</a>(<span class="type">float</span> <span class="argument">$value</span>)
97
	</li>
98
</ul><h2>Documentation</h2><ul class="doc">
99
<li class="constant">
100
<a id="constant.LEFT"></a><span class="access">const</span> <span class="type">string</span> <a href="Plot.html#constant.LEFT">LEFT</a> := <span class="default">left</span><div class="description">
101
				Dessine l'axe des abscisses sur la gauche du graph.
102
			</div>
103
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
104
</li>
105
<li class="constant">
106
<a id="constant.RIGHT"></a><span class="access">const</span> <span class="type">string</span> <a href="Plot.html#constant.RIGHT">RIGHT</a> := <span class="default">right</span><div class="description">
107
				Dessine l'axe des abscisses sur la droite du graph.
108
			</div>
109
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
110
</li>
111
<li class="constant">
112
<a id="constant.TOP"></a><span class="access">const</span> <span class="type">string</span> <a href="Plot.html#constant.TOP">TOP</a> := <span class="default">top</span><div class="description">
113
				Dessine l'axe des ordonnées sur le haut du graph.
114
			</div>
115
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
116
</li>
117
<li class="constant">
118
<a id="constant.BOTTOM"></a><span class="access">const</span> <span class="type">string</span> <a href="Plot.html#constant.BOTTOM">BOTTOM</a> := <span class="default">bottom</span><div class="description">
119
				Dessine l'axe des ordonnées sur le bas du graph.
120
			</div>
121
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
122
</li>
123
<li class="constant">
124
<a id="constant.BOTH"></a><span class="access">const</span> <span class="type">string</span> <a href="Plot.html#constant.BOTH">BOTH</a> := <span class="default">both</span><div class="description">
125
				 Dessine l'axe des abscisses (ou des ordonnées) sur la gauche et la droite (ou le haut et la bas) du graph.
126
			</div>
127
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
128
</li>
129
<li class="property">
130
<a id="property.datay"></a><span class="access">public</span> <span class="type">array</span> <a href="Plot.html#property.datay"><span class="argument">$datay</span></a><div class="description">
131
				Les valeurs de l'axe des Y.
132
			</div>
133
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
134
</li>
135
<li class="property">
136
<a id="property.datax"></a><span class="access">public</span> <span class="type">array</span> <a href="Plot.html#property.datax"><span class="argument">$datax</span></a><div class="description">
137
				Les valeurs de l'axe des X.
138
			</div>
139
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
140
</li>
141
<li class="property">
142
<a id="property.grid"></a><span class="access">public</span> <a href="Grid.html"><span class="type">Grid</span></a> <a href="Plot.html#property.grid"><span class="argument">$grid</span></a><div class="description">
143
				Représente la grille de fond du composant.
144
			</div>
145
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
146
</li>
147
<li class="property">
148
<a id="property.xAxis"></a><span class="access">public</span> <a href="Axis.html"><span class="type">Axis</span></a> <a href="Plot.html#property.xAxis"><span class="argument">$xAxis</span></a><div class="description">
149
				L'axe des abscisses
150
			</div>
151
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
152
</li>
153
<li class="property">
154
<a id="property.yAxis"></a><span class="access">public</span> <a href="Axis.html"><span class="type">Axis</span></a> <a href="Plot.html#property.yAxis"><span class="argument">$yAxis</span></a><div class="description">
155
				L'axe des ordonnées
156
			</div>
157
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
158
</li>
159
<li class="property">
160
<a id="property.xAxisZero"></a><span class="access">protected</span> <span class="type">bool</span> <a href="Plot.html#property.xAxisZero"><span class="argument">$xAxisZero</span></a> := <span class="default">TRUE</span><div class="description">
161
				Est-ce le ou les axes des abscisses doivent être centrés sur zéro ?
162
			</div>
163
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
164
</li>
165
<li class="method">
166
<a id="method.__construct"></a><span class="access">public</span> <a href="Plot.html#method.__construct">__construct</a>()
167
	<div class="description">
168
				Construit le composant.
169
			</div>
170
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
171
</li>
172
<li class="method">
173
<a id="method.reduce"></a><span class="access">public</span> <a href="Plot.html#method.reduce">reduce</a>(<a href="number.html"><span class="type">number</span></a> <span class="argument">$number</span>)
174
	<div class="description">
175
				Réduit le nombre de valeurs à afficher sur le composant à $number.<br>
176
				Cette fonctionnalité est utile dans le cas où vous souhaitez afficher plus de 400 ou 500 valeurs sur un graphique.
177
				En effet, au delà d'un certain nombre de valeurs, toutes ne seront pas affichées et le temps de création du graphique sera très élevé.
178
				La solution est de réduire le nombre de valeurs sur votre graphique, ce que permet cette fonction.
179
				Le processus de réduction se fait à travers un système de moyennes, afin de garder une courbe identique à celle que vous auriez eu en affichant toutes les valeurs.
180
				Le nombre $number que vous spécifiez en paramètre est un nombre maximal. Pas plus de $number valeurs seront affichées sur le graphique. En revanche, dans certains cas, il est possible qu'un nombre inférieur de valeurs soient affichées.
181
				Voici un exemple d'utilisation de cette fonctionnalité :
182
<pre>
183
 
184
&lt;?php
185
 
186
require_once "LinePlot.class.php";
187
 
188
$graph = new <a href="Graph.html">Graph</a>(400, 400);
189
 
190
$datay = array();
191
$datax = array();
192
 
193
// On créé un tableau avec 3000 valeurs
194
for($i = 1; $i &lt;= 3000; $i++) {
195
	$datay[] = log($i);
196
	$datax[] = $i;
197
}
198
 
199
$plot = new <a href="LinePlot.html">LinePlot</a>($datay);
200
$plot-&gt;xAxis-&gt;<a href="Axis.html#method.setLabelText">setLabelText</a>($datax);
201
$plot-&gt;xAxis-&gt;label-&gt;<a href="Label.html#method.setAngle">setAngle</a>(90);
202
 
203
// On réduit le nombre de valeurs à afficher sur le graphique à 30,
204
// soit 100 fois moins
205
$plot-&gt;<a href="Plot.html#method.reduce">reduce</a>(30);
206
 
207
// On affiche le graphique
208
// Les valeurs de l'axe des X ont été automatiquement mises à jour
209
$graph-&gt;<a href="Graph.html#method.add">add</a>($plot);
210
$graph-&gt;<a href="Graph.html#method.draw">draw</a>();
211
 
212
// Finalement, la courbe représentative de log(x) apparaît très correctement
213
 
214
?&gt;
215
 
216
</pre>
217
			</div>
218
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
219
</li>
220
<li class="method">
221
<a id="method.setXAxis"></a><span class="access">public</span> <a href="Plot.html#method.setXAxis">setXAxis</a>(<span class="type">string</span> <span class="argument">$axis</span>)
222
	<div class="description">
223
				Change l'axe de abscisses qui sera affiché sur l'image.
224
				Cela peut être <a href="Plot.html#constant.TOP">Plot::TOP</a>, <a href="Plot.html#constant.BOTTOM">Plot::BOTTOM</a> ou <a href="Plot.html#constant.BOTH">Plot::BOTH</a>.
225
			</div>
226
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
227
</li>
228
<li class="method">
229
<a id="method.setYAxis"></a><span class="access">public</span> <a href="Plot.html#method.setYAxis">setYAxis</a>(<span class="type">string</span> <span class="argument">$axis</span>)
230
	<div class="description">
231
				Change l'axe de ordonnées qui sera affiché sur l'image.
232
				Cela peut être <a href="Plot.html#constant.LEFT">Plot::LEFT</a>, <a href="Plot.html#constant.RIGHT">Plot::RIGHT</a> ou <a href="Plot.html#constant.BOTH">Plot::BOTH</a>.
233
			</div>
234
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
235
</li>
236
<li class="method">
237
<a id="method.setXAxisZero"></a><span class="access">public</span> <a href="Plot.html#method.setXAxisZero">setXAxisZero</a>(<span class="type">bool</span> <span class="argument">$zero</span>)
238
	<div class="description">
239
				Précise si le ou les axes des abscisses doivent être centrés sur le zéro de l'axe des ordonnées.
240
				Comme il peut y avoir plus axes des ordonnées, l'axe de gauche est choisi en premier pour sélectionner la valeur du zéro. S'il n'existe pas, alors on utilise l'axe de droite.
241
			</div>
242
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
243
</li>
244
<li class="method">
245
<a id="method.setYAxisZero"></a><span class="access">public</span> <a href="Plot.html#method.setYAxisZero">setYAxisZero</a>(<span class="type">bool</span> <span class="argument">$zero</span>)
246
	<div class="description">
247
				Précise si le ou les axes des ordonnées doivent être centrés sur le zéro de l'axe des abscisses.
248
				Comme il peut y avoir plus axes des abscisses, l'axe du bas est choisi en premier pour sélectionner la valeur du zéro. S'il n'existe pas, alors on utilise l'axe du haut.
249
			</div>
250
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
251
</li>
252
<li class="method">
253
<a id="method.setYMin"></a><span class="access">public</span> <a href="Plot.html#method.setYMin">setYMin</a>(<span class="type">float</span> <span class="argument">$value</span>)
254
	<div class="description">
255
				Force la valeur minimale de l'axe des ordonnées à $value.
256
				L'appel à cette méthode désactive la gestion automatique de l'axe des ordonnées.
257
			<div class="see">
258
					Voir aussi :
259
					<ul>
260
<li><a href="Plot.html#method.setYMax">Plot::setYMax()</a></li>
261
<li><a href="Axis.html#method.auto">Axis::auto()</a></li>
262
</ul>
263
</div>
264
</div>
265
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
266
</li>
267
<li class="method">
268
<a id="method.setYMax"></a><span class="access">public</span> <a href="Plot.html#method.setYMax">setYMax</a>(<span class="type">float</span> <span class="argument">$value</span>)
269
	<div class="description">
270
				Force la valeur maximale de l'axe des ordonnées à $value.
271
				L'appel à cette méthode désactive la gestion automatique de l'axe des ordonnées.
272
			<div class="see">
273
					Voir aussi :
274
					<ul>
275
<li><a href="Plot.html#method.setYMin">Plot::setYMin()</a></li>
276
<li><a href="Axis.html#method.auto">Axis::auto()</a></li>
277
</ul>
278
</div>
279
</div>
280
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
281
</li>
282
<li class="method">
283
<a id="method.setXMin"></a><span class="access">public</span> <a href="Plot.html#method.setXMin">setXMin</a>(<span class="type">float</span> <span class="argument">$value</span>)
284
	<div class="description">
285
				Force la valeur minimale de l'axe des abscisses à $value.
286
			<div class="see">
287
					Voir aussi :
288
					<ul><li><a href="Plot.html#method.setXMax">Plot::setXMax()</a></li></ul>
289
</div>
290
</div>
291
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
292
</li>
293
<li class="method">
294
<a id="method.setXMax"></a><span class="access">public</span> <a href="Plot.html#method.setXMax">setXMax</a>(<span class="type">float</span> <span class="argument">$value</span>)
295
	<div class="description">
296
				Force la valeur maximale de l'axe des abscisses à $value.
297
			<div class="see">
298
					Voir aussi :
299
					<ul><li><a href="Plot.html#method.setXMin">Plot::setXMin()</a></li></ul>
300
</div>
301
</div>
302
<div class="description-bottom"><a href="Plot.html#top">Remonter</a></div>
303
</li>
304
</ul>
305
</td>
306
				<td class='borderd'>&nbsp;</td>
307
			</tr>
308
			<tr>
309
				<td class='cornerbg'></td>
310
				<td class='borderb'>&nbsp;</td>
311
				<td class='cornerbd'></td>
312
			</tr>
313
		</table>
314
		</div>
315
	</body>
316
</html>