Subversion Repositories Applications.gtt

Rev

Rev 61 | 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 Axis</h2><div class="description">
19
		<p>
20
			La classe <a href="Axis.html">Axis</a> permet de manipuler des axes.
21
			Un axe permet à un utilisateur de répérer les points et leurs valeurs sur un graphique.
22
		</p>
23
		<p>
24
			De nombreuses méthodes de la classe <a href="Axis.html">Axis</a> ne sont pas documentées,
25
			car elles ne sont utilisées qu'en interne par Artichow.
26
			Néanmoins, si vous développez Artichow, vous aurez besoin de ces méthodes.
27
			N'hésitez donc pas à parcourir le code source de cette classe.
28
		</p>
29
	</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="properties">
30
<li>
31
<span class="access">public</span> <a href="Label.html"><span class="type">Label</span></a> <a href="Axis.html#property.title"><span class="argument">$title</span></a>
32
</li>
33
<li>
34
<span class="access">public</span> <a href="Label.html"><span class="type">Label</span></a> <a href="Axis.html#property.label"><span class="argument">$label</span></a>
35
</li>
36
<li>
37
<span class="access">public</span> <a href="Line.html"><span class="type">Line</span></a> <a href="Axis.html#property.line"><span class="argument">$line</span></a>
38
</li>
39
<li>
40
<span class="access">protected</span> <span class="type">bool</span> <a href="Axis.html#property.auto"><span class="argument">$auto</span></a>
41
</li>
42
</ul><ul class="methods">
43
<li>
44
<span class="access">public</span> <a href="Axis.html#method.__construct">__construct</a>(<span class="type">float</span> <span class="argument">$min</span>, <span class="type">float</span> <span class="argument">$max</span>)
45
	</li>
46
<li>
47
<span class="access">public</span> <a href="Axis.html#method.auto">auto</a>(<span class="type">bool</span> <span class="argument">$auto</span>)
48
	</li>
49
<li>
50
<span class="access">public</span> <a href="true.html"><span class="type">true</span></a> <a href="Axis.html#method.isAuto">isAuto</a>()
51
	</li>
52
<li>
53
<span class="access">public</span> <a href="Axis.html#method.hide">hide</a>(<span class="type">bool</span> <span class="argument">$hide</span> := <span class="default">TRUE</span>)
54
	</li>
55
<li>
56
<span class="access">public</span> <a href="Axis.html#method.addTick">addTick</a>(<span class="type">string</span> <span class="argument">$name</span>, <a href="Tick.html"><span class="type">Tick</span></a> <span class="argument">$tick</span>)
57
	</li>
58
<li>
59
<span class="access">public</span> <a href="Tick.html"><span class="type">Tick</span></a> <a href="Axis.html#method.tick">tick</a>(<span class="type">string</span> <span class="argument">$name</span>)
60
	</li>
61
<li>
62
<span class="access">public</span> <a href="Axis.html#method.deleteTick">deleteTick</a>(<span class="type">string</span> <span class="argument">$name</span>)
63
	</li>
64
<li>
65
<span class="access">public</span> <a href="Axis.html#method.hideTicks">hideTicks</a>(<span class="type">bool</span> <span class="argument">$hide</span> := <span class="default">TRUE</span>)
66
	</li>
67
<li>
68
<span class="access">public</span> <a href="Axis.html#method.setTickStyle">setTickStyle</a>(<span class="type">int</span> <span class="argument">$style</span>)
69
	</li>
70
<li>
71
<span class="access">public</span> <a href="Axis.html#method.reverseTickStyle">reverseTickStyle</a>()
72
	</li>
73
<li>
74
<span class="access">public</span> <a href="Axis.html#method.setTickInterval">setTickInterval</a>(<span class="type">int</span> <span class="argument">$interval</span>)
75
	</li>
76
<li>
77
<span class="access">public</span> <a href="Axis.html#method.setNumberByTick">setNumberByTick</a>(<span class="type">string</span> <span class="argument">$to</span>, <span class="type">string</span> <span class="argument">$from</span>, <span class="type">float</span> <span class="argument">$number</span>)
78
	</li>
79
<li>
80
<span class="access">public</span> <a href="Axis.html#method.setLabelInterval">setLabelInterval</a>(<span class="type">int</span> <span class="argument">$interval</span>)
81
	</li>
82
<li>
83
<span class="access">public</span> <a href="Axis.html#method.setLabelNumber">setLabelNumber</a>(<span class="type">int</span> <span class="argument">$number</span>)
84
	</li>
85
<li>
86
<span class="access">public</span> <span class="type">int</span> <a href="Axis.html#method.getLabelNumber">getLabelNumber</a>()
87
	</li>
88
<li>
89
<span class="access">public</span> <a href="Axis.html#method.setLabelPrecision">setLabelPrecision</a>(<span class="type">int</span> <span class="argument">$precision</span>)
90
	</li>
91
<li>
92
<span class="access">public</span> <a href="Axis.html#method.setLabelText">setLabelText</a>(<span class="type">array</span> <span class="argument">$texts</span>)
93
	</li>
94
<li>
95
<span class="access">public</span> <a href="Axis.html#method.setTitleAlignment">setTitleAlignment</a>(<span class="type">int</span> <span class="argument">$alignment</span>)
96
	</li>
97
<li>
98
<span class="access">public</span> <a href="Axis.html#method.setTitlePosition">setTitlePosition</a>(<span class="type">float</span> <span class="argument">$postion</span>)
99
	</li>
100
<li>
101
<span class="access">public</span> <a href="Axis.html#method.setColor">setColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
102
	</li>
103
<li>
104
<span class="access">public</span> <a href="Axis.html#method.setPadding">setPadding</a>(<span class="type">int</span> <span class="argument">$left</span>, <span class="type">int</span> <span class="argument">$right</span>)
105
	</li>
106
<li>
107
<span class="access">public</span> <a href="Side.html"><span class="type">Side</span></a> <a href="Axis.html#method.getPadding">getPadding</a>()
108
	</li>
109
</ul><h2>Documentation</h2><ul class="doc">
110
<li class="property">
111
<a id="property.title"></a><span class="access">public</span> <a href="Label.html"><span class="type">Label</span></a> <a href="Axis.html#property.title"><span class="argument">$title</span></a><div class="description">
112
				Représente le titre de l'axe.
113
			</div>
114
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
115
</li>
116
<li class="property">
117
<a id="property.label"></a><span class="access">public</span> <a href="Label.html"><span class="type">Label</span></a> <a href="Axis.html#property.label"><span class="argument">$label</span></a><div class="description">
118
				Représente les étiquettes qui portent les valeurs affichées sur l'axe.
119
			</div>
120
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
121
</li>
122
<li class="property">
123
<a id="property.line"></a><span class="access">public</span> <a href="Line.html"><span class="type">Line</span></a> <a href="Axis.html#property.line"><span class="argument">$line</span></a><div class="description">
124
				Représente la ligne de l'axe.
125
				Vous pouvez modifier le style et l'épaisseur de cette ligne, pas ses coordonnées.
126
			</div>
127
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
128
</li>
129
<li class="property">
130
<a id="property.auto"></a><span class="access">protected</span> <span class="type">bool</span> <a href="Axis.html#property.auto"><span class="argument">$auto</span></a><div class="description">
131
				Précise si la gestion de l'axe doit être automatique ou non.
132
			</div>
133
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
134
</li>
135
<li class="method">
136
<a id="method.__construct"></a><span class="access">public</span> <a href="Axis.html#method.__construct">__construct</a>(<span class="type">float</span> <span class="argument">$min</span>, <span class="type">float</span> <span class="argument">$max</span>)
137
	<div class="description">
138
				Déclare un nouvel axe.
139
				Les variables $min et $max représentent respectivement la valeurs minimales et maximales associées à l'axe.
140
				Par exemple, choisir $min = -12 et $max = 42 signifie tout simplement que l'axe ira de -12 à 42.
141
			</div>
142
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
143
</li>
144
<li class="method">
145
<a id="method.auto"></a><span class="access">public</span> <a href="Axis.html#method.auto">auto</a>(<span class="type">bool</span> <span class="argument">$auto</span>)
146
	<div class="description">
147
				Active/désactive la gestion automatique de l'axe.
148
				La gestion automatique est automatiquement désactivée en cas d'appel aux méthodes suivantes : <a href="Axis.html#method.setLabelNumber">Axis::setLabelNumber()</a>, <a href="Axis.html#method.setLabelInterval">Axis::setLabelInterval()</a>, <a href="Axis.html#method.setLabelPrecision">Axis::setLabelPrecision()</a> et <a href="Axis.html#method.setLabelText">Axis::setLabelText()</a>.
149
				Lorsqu'un axe est sous gestion automatique, l'échelle est le nombre de valeurs à afficher sur l'axe sont automatiquement calculés.
150
			</div>
151
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
152
</li>
153
<li class="method">
154
<a id="method.isAuto"></a><span class="access">public</span> <a href="true.html"><span class="type">true</span></a> <a href="Axis.html#method.isAuto">isAuto</a>()
155
	<div class="description">
156
				Retourne TRUE si l'axe est gérée automatiquement, FALSE sinon.
157
			</div>
158
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
159
</li>
160
<li class="method">
161
<a id="method.hide"></a><span class="access">public</span> <a href="Axis.html#method.hide">hide</a>(<span class="type">bool</span> <span class="argument">$hide</span> := <span class="default">TRUE</span>)
162
	<div class="description">
163
				Cache ou non l'axe. Le paramètre $hide est par défaut à TRUE (ce qui signifie que l'axe ne sera pas dessiné).
164
				S'il est mis à FALSE, l'axe sera dessiné.
165
			</div>
166
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
167
</li>
168
<li class="method">
169
<a id="method.addTick"></a><span class="access">public</span> <a href="Axis.html#method.addTick">addTick</a>(<span class="type">string</span> <span class="argument">$name</span>, <a href="Tick.html"><span class="type">Tick</span></a> <span class="argument">$tick</span>)
170
	<div class="description">
171
				Associe un objet <a href="Tick.html">Tick</a> $tick à l'axe.
172
				Cet objet sera reconnu par le nom $name au sein de la classe <a href="Axis.html">Axis</a>.
173
			</div>
174
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
175
</li>
176
<li class="method">
177
<a id="method.tick"></a><span class="access">public</span> <a href="Tick.html"><span class="type">Tick</span></a> <a href="Axis.html#method.tick">tick</a>(<span class="type">string</span> <span class="argument">$name</span>)
178
	<div class="description">
179
				Récupère un objet <a href="Tick.html">Tick</a> en fonction de son nom.
180
				Cet objet doit avoir été précédemment ajouté avec la méthode <a href="Axis.html#method.addTick">Axis::addTick()</a>.
181
			</div>
182
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
183
</li>
184
<li class="method">
185
<a id="method.deleteTick"></a><span class="access">public</span> <a href="Axis.html#method.deleteTick">deleteTick</a>(<span class="type">string</span> <span class="argument">$name</span>)
186
	<div class="description">
187
				Supprime l'objet <a href="Tick.html">Tick</a> de nom $name associé à l'axe.
188
				Pour pouvoir être supprimé, cet objet doit avoir été précédemment ajouté avec la méthode <a href="Axis.html#method.addTick">Axis::addTick()</a>.
189
			</div>
190
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
191
</li>
192
<li class="method">
193
<a id="method.hideTicks"></a><span class="access">public</span> <a href="Axis.html#method.hideTicks">hideTicks</a>(<span class="type">bool</span> <span class="argument">$hide</span> := <span class="default">TRUE</span>)
194
	<div class="description">
195
				Cache ou non tous les ticks qui ont été associés à cet axe.
196
			<div class="see">
197
					Voir aussi :
198
					<ul><li><a href="Axis.html#method.addTick">Axis::addTick()</a></li></ul>
199
</div>
200
</div>
201
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
202
</li>
203
<li class="method">
204
<a id="method.setTickStyle"></a><span class="access">public</span> <a href="Axis.html#method.setTickStyle">setTickStyle</a>(<span class="type">int</span> <span class="argument">$style</span>)
205
	<div class="description">
206
				Change le style de tous les ticks associés à l'axe pour $style.
207
			<div class="see">
208
					Voir aussi :
209
					<ul><li><a href="Tick.html#method.setStyle">Tick::setStyle()</a></li></ul>
210
</div>
211
</div>
212
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
213
</li>
214
<li class="method">
215
<a id="method.reverseTickStyle"></a><span class="access">public</span> <a href="Axis.html#method.reverseTickStyle">reverseTickStyle</a>()
216
	<div class="description">
217
				Inverse le style de tous les ticks associés à l'axe pour $style.
218
				Si les ticks étaient tournés vers l'extérieur, ils seront désormais tournés vers l'intérieur.
219
				Et vice-versa.
220
			<div class="see">
221
					Voir aussi :
222
					<ul><li><a href="Tick.html#method.setStyle">Tick::setStyle()</a></li></ul>
223
</div>
224
</div>
225
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
226
</li>
227
<li class="method">
228
<a id="method.setTickInterval"></a><span class="access">public</span> <a href="Axis.html#method.setTickInterval">setTickInterval</a>(<span class="type">int</span> <span class="argument">$interval</span>)
229
	<div class="description">
230
				Change l'intervalle d'affichage de tous les ticks associés à l'axe pour $interval.
231
				Cette méthode permet d'espacer l'affichage des ticks par rapport aux valeurs de l'axe.
232
			<div class="see">
233
					Voir aussi :
234
					<ul><li><a href="Tick.html#method.setStyle">Tick::setStyle()</a></li></ul>
235
</div>
236
</div>
237
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
238
</li>
239
<li class="method">
240
<a id="method.setNumberByTick"></a><span class="access">public</span> <a href="Axis.html#method.setNumberByTick">setNumberByTick</a>(<span class="type">string</span> <span class="argument">$to</span>, <span class="type">string</span> <span class="argument">$from</span>, <span class="type">float</span> <span class="argument">$number</span>)
241
	<div class="description">
242
				Cette méthode permet de modifier la fréquence d'affichage d'un objet <a href="Tick.html">Tick</a> par rapport à un autre.
243
				$to représente l'objet dont la fréquence d'affichage doit être modifiée et $from l'objet auquel on se réfère.
244
				A chaque fois qu'un tick $from sera affiché, on affichera $number ticks $to.
245
				Si $number vaut 2, cela signifie que deux ticks $to seront affichés pour un tick $from.
246
				Cette méthode prend tout son sens donc le cadre des <a href="Plot.html">Plot</a> par exemple :
247
<pre>
248
 
249
&lt;?php
250
 
251
require_once 'LinePlot.class.php';
252
 
253
$graph = new <a href="Graph.html">Graph</a>(400, 400);
254
 
255
$plot = new <a href="LinePlot.html">LinePlot</a>(array(1, 2, 3));
256
 
257
// Pour chaque tick major affiché,
258
// on affichera 10 ticks minor
259
$plot-&gt;xAxis-&gt;setNumberByTick('minor', 'major', 10);
260
 
261
$graph-&gt;<a href="Graph.html#method.add">add</a>($plot);
262
$graph-&gt;<a href="Graph.html#method.draw">draw</a>();
263
 
264
?&gt;
265
 
266
</pre>
267
			Cela donne 10 ticks mineurs par tick majeur :
268
			<div class="image">
269
				<img src="doc/image/ticks.png" alt="10 ticks mineurs par tick majeur">
270
			</div>
271
			</div>
272
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
273
</li>
274
<li class="method">
275
<a id="method.setLabelInterval"></a><span class="access">public</span> <a href="Axis.html#method.setLabelInterval">setLabelInterval</a>(<span class="type">int</span> <span class="argument">$interval</span>)
276
	<div class="description">
277
				Change l'intervalle d'affichage des étiquettes sur l'axe pour $interval.
278
				Par défaut, cet intervalle est égal à 1.
279
			</div>
280
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
281
</li>
282
<li class="method">
283
<a id="method.setLabelNumber"></a><span class="access">public</span> <a href="Axis.html#method.setLabelNumber">setLabelNumber</a>(<span class="type">int</span> <span class="argument">$number</span>)
284
	<div class="description">
285
				Change le nombre d'étiquettes à afficher sur l'axe pour $number.
286
			</div>
287
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
288
</li>
289
<li class="method">
290
<a id="method.getLabelNumber"></a><span class="access">public</span> <span class="type">int</span> <a href="Axis.html#method.getLabelNumber">getLabelNumber</a>()
291
	<div class="description">
292
				Retourne le nombre d'étiquettes qui seront affichées sur l'axe.
293
			</div>
294
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
295
</li>
296
<li class="method">
297
<a id="method.setLabelPrecision"></a><span class="access">public</span> <a href="Axis.html#method.setLabelPrecision">setLabelPrecision</a>(<span class="type">int</span> <span class="argument">$precision</span>)
298
	<div class="description">
299
				Change la précision des valeurs affichées sur chaque étiquette de l'axe.
300
				$number représente le nombre de chiffres après la virgule qui doivent être affiché.
301
				Par défaut, $precision vaut 0.
302
			<div class="see">
303
					Voir aussi :
304
					<ul>
305
<li><a href="Axis.html#method.setLabelText">Axis::setLabelText()</a></li>
306
<li><a href="Label.html#method.setCallbackFunction">Label::setCallbackFunction()</a></li>
307
</ul>
308
</div>
309
</div>
310
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
311
</li>
312
<li class="method">
313
<a id="method.setLabelText"></a><span class="access">public</span> <a href="Axis.html#method.setLabelText">setLabelText</a>(<span class="type">array</span> <span class="argument">$texts</span>)
314
	<div class="description">
315
				Cette méthode permet d'afficher des valeurs arbitraires plutôt que des valeurs numériques sur les étiquettes de l'axe.
316
				$texts est un tableau comportant autant d'entrées que d'étiquettes et qui contient les nouvelles valeurs à afficher.
317
			<div class="see">
318
					Voir aussi :
319
					<ul>
320
<li><a href="Axis.html#method.setLabelPrecision">Axis::setLabelPrecision()</a></li>
321
<li><a href="Label.html#method.setCallbackFunction">Label::setCallbackFunction()</a></li>
322
</ul>
323
</div>
324
</div>
325
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
326
</li>
327
<li class="method">
328
<a id="method.setTitleAlignment"></a><span class="access">public</span> <a href="Axis.html#method.setTitleAlignment">setTitleAlignment</a>(<span class="type">int</span> <span class="argument">$alignment</span>)
329
	<div class="description">
330
				Change l'alignement du titre de l'axe sur l'axe.
331
				Les valeurs possibles sont <a href="Label.html#constant.LEFT">Label::LEFT</a>, <a href="Label.html#constant.RIGHT">Label::RIGHT</a>, <a href="Label.html#constant.TOP">Label::TOP</a> et <a href="Label.html#constant.BOTTOM">Label::BOTTOM</a>.
332
			</div>
333
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
334
</li>
335
<li class="method">
336
<a id="method.setTitlePosition"></a><span class="access">public</span> <a href="Axis.html#method.setTitlePosition">setTitlePosition</a>(<span class="type">float</span> <span class="argument">$postion</span>)
337
	<div class="description">
338
				Change la position du titre sur l'axe.
339
				$position est une fraction de la taille de l'axe.
340
				Par exemple, si $position est placé à 0.5, le titre sera affiché au milieu de l'axe.
341
				Si $position vaut 0.25, alors le titre sera affiché sur le premier quart de l'axe.
342
				Pour aligner le titre par rapport à cette position, utilisez la méthode <a href="Axis.html#method.setTitleAlignment">Axis::setTitleAlignment()</a>.
343
			<div class="see">
344
					Voir aussi :
345
					<ul><li><a href="Axis.html#method.setTitleAlignment">Axis::setTitleAlignment()</a></li></ul>
346
</div>
347
</div>
348
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
349
</li>
350
<li class="method">
351
<a id="method.setColor"></a><span class="access">public</span> <a href="Axis.html#method.setColor">setColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
352
	<div class="description">
353
				Change la couleur de l'axe et de son titre pour $color.
354
			</div>
355
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
356
</li>
357
<li class="method">
358
<a id="method.setPadding"></a><span class="access">public</span> <a href="Axis.html#method.setPadding">setPadding</a>(<span class="type">int</span> <span class="argument">$left</span>, <span class="type">int</span> <span class="argument">$right</span>)
359
	<div class="description">
360
				Change l'espace interne à gauche et à droite de l'axe.
361
				Gauche et droite n'ont de sens que pour les axes verticaux.
362
				Pour les axes plus horizontaux, préférez haut à gauche et bas à droite.
363
			</div>
364
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
365
</li>
366
<li class="method">
367
<a id="method.getPadding"></a><span class="access">public</span> <a href="Side.html"><span class="type">Side</span></a> <a href="Axis.html#method.getPadding">getPadding</a>()
368
	<div class="description">
369
				Retourne l'espace interne associé à l'axe.
370
			</div>
371
<div class="description-bottom"><a href="Axis.html#top">Remonter</a></div>
372
</li>
373
</ul>
374
</td>
375
				<td class='borderd'>&nbsp;</td>
376
			</tr>
377
			<tr>
378
				<td class='cornerbg'></td>
379
				<td class='borderb'>&nbsp;</td>
380
				<td class='cornerbd'></td>
381
			</tr>
382
		</table>
383
		</div>
384
	</body>
385
</html>