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'> </td>
|
|
|
13 |
<td class='borderh'> </td>
|
|
|
14 |
<td class='cornerhd'></td>
|
|
|
15 |
</tr>
|
|
|
16 |
<tr>
|
|
|
17 |
<td class='borderg'> </td>
|
|
|
18 |
<td><a id="top"></a><h2> Class Pie</h2><div class="extends"><ul>
|
|
|
19 |
<li><a href="Component.html">Component</a></li>
|
|
|
20 |
<ul><li>Pie</li></ul>
|
|
|
21 |
</ul></div><div class="description">
|
|
|
22 |
<p>
|
|
|
23 |
La classe <a href="Pie.html">Pie</a> permet de générer des camemberts en deux ou trois dimensions.
|
|
|
24 |
</p>
|
|
|
25 |
</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">
|
|
|
26 |
<li>
|
|
|
27 |
<span class="access">const</span> <span class="type">int</span> <a href="Pie.html#constant.DARK">DARK</a> := <span class="default">1</span>
|
|
|
28 |
</li>
|
|
|
29 |
<li>
|
|
|
30 |
<span class="access">const</span> <span class="type">int</span> <a href="Pie.html#constant.COLORED">COLORED</a> := <span class="default">2</span>
|
|
|
31 |
</li>
|
|
|
32 |
<li>
|
|
|
33 |
<span class="access">const</span> <span class="type">int</span> <a href="Pie.html#constant.AQUA">AQUA</a> := <span class="default">3</span>
|
|
|
34 |
</li>
|
|
|
35 |
<li>
|
|
|
36 |
<span class="access">const</span> <span class="type">int</span> <a href="Pie.html#constant.EARTH">EARTH</a> := <span class="default">4</span>
|
|
|
37 |
</li>
|
|
|
38 |
</ul><ul class="properties">
|
|
|
39 |
<li>
|
|
|
40 |
<span class="access">protected</span> <a href="Border.html"><span class="type">Border</span></a> <a href="Pie.html#property.border"><span class="argument">$border</span></a>
|
|
|
41 |
</li>
|
|
|
42 |
<li>
|
|
|
43 |
<span class="access">public</span> <span class="type">array</span> <a href="Pie.html#property.values"><span class="argument">$values</span></a>
|
|
|
44 |
</li>
|
|
|
45 |
<li>
|
|
|
46 |
<span class="access">public</span> <span class="type">array</span> <a href="Pie.html#property.colors"><span class="argument">$colors</span></a>
|
|
|
47 |
</li>
|
|
|
48 |
</ul><ul class="methods">
|
|
|
49 |
<li>
|
|
|
50 |
<span class="access">public</span> <a href="Pie.html#method.__construct">__construct</a>(<span class="type">array</span> <span class="argument">$values</span>, <span class="type">mixed</span> <span class="argument">$colors</span> := <span class="default">Pie::COLORED</span>)
|
|
|
51 |
</li>
|
|
|
52 |
<li>
|
|
|
53 |
<span class="access">public</span> <a href="Pie.html#method.setLegend">setLegend</a>(<span class="type">array</span> <span class="argument">$legend</span>)
|
|
|
54 |
</li>
|
|
|
55 |
<li>
|
|
|
56 |
<span class="access">public</span> <a href="Pie.html#method.setBorder">setBorder</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
|
|
|
57 |
</li>
|
|
|
58 |
<li>
|
|
|
59 |
<span class="access">public</span> <a href="Pie.html#method.setBorderColor">setBorderColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
|
|
|
60 |
</li>
|
|
|
61 |
<li>
|
|
|
62 |
<span class="access">public</span> <a href="Pie.html#method.set3D">set3D</a>(<span class="type">int</span> <span class="argument">$size</span>)
|
|
|
63 |
</li>
|
|
|
64 |
<li>
|
|
|
65 |
<span class="access">public</span> <a href="Pie.html#method.setStartAngle">setStartAngle</a>(<span class="type">int</span> <span class="argument">$angle</span>)
|
|
|
66 |
</li>
|
|
|
67 |
<li>
|
|
|
68 |
<span class="access">public</span> <a href="Pie.html#method.setLabelPrecision">setLabelPrecision</a>(<span class="type">int</span> <span class="argument">$precision</span>)
|
|
|
69 |
</li>
|
|
|
70 |
<li>
|
|
|
71 |
<span class="access">public</span> <a href="Pie.html#method.setLabelPosition">setLabelPosition</a>(<span class="type">int</span> <span class="argument">$position</span>)
|
|
|
72 |
</li>
|
|
|
73 |
<li>
|
|
|
74 |
<span class="access">public</span> <a href="Pie.html#method.setLabelNumber">setLabelNumber</a>(<span class="type">int</span> <span class="argument">$number</span>)
|
|
|
75 |
</li>
|
|
|
76 |
<li>
|
|
|
77 |
<span class="access">public</span> <a href="Pie.html#method.setLabelMinimum">setLabelMinimum</a>(<span class="type">int</span> <span class="argument">$minimum</span>)
|
|
|
78 |
</li>
|
|
|
79 |
<li>
|
|
|
80 |
<span class="access">public</span> <a href="Pie.html#method.explode">explode</a>(<span class="type">array</span> <span class="argument">$explode</span>)
|
|
|
81 |
</li>
|
|
|
82 |
</ul><h2>Documentation</h2><ul class="doc">
|
|
|
83 |
<li class="constant">
|
|
|
84 |
<a id="constant.DARK"></a><span class="access">const</span> <span class="type">int</span> <a href="Pie.html#constant.DARK">DARK</a> := <span class="default">1</span><div class="description">
|
|
|
85 |
Un thème sombre pour les camemberts.
|
|
|
86 |
</div>
|
|
|
87 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
88 |
</li>
|
|
|
89 |
<li class="constant">
|
|
|
90 |
<a id="constant.COLORED"></a><span class="access">const</span> <span class="type">int</span> <a href="Pie.html#constant.COLORED">COLORED</a> := <span class="default">2</span><div class="description">
|
|
|
91 |
Un thème coloré pour les camemberts (thème par défaut).
|
|
|
92 |
</div>
|
|
|
93 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
94 |
</li>
|
|
|
95 |
<li class="constant">
|
|
|
96 |
<a id="constant.AQUA"></a><span class="access">const</span> <span class="type">int</span> <a href="Pie.html#constant.AQUA">AQUA</a> := <span class="default">3</span><div class="description">
|
|
|
97 |
Un thème plutôt bleu pour les camemberts.
|
|
|
98 |
</div>
|
|
|
99 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
100 |
</li>
|
|
|
101 |
<li class="constant">
|
|
|
102 |
<a id="constant.EARTH"></a><span class="access">const</span> <span class="type">int</span> <a href="Pie.html#constant.EARTH">EARTH</a> := <span class="default">4</span><div class="description">
|
|
|
103 |
Un thème aux couleurs de la Terre pour les camemberts.
|
|
|
104 |
</div>
|
|
|
105 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
106 |
</li>
|
|
|
107 |
<li class="property">
|
|
|
108 |
<a id="property.border"></a><span class="access">protected</span> <a href="Border.html"><span class="type">Border</span></a> <a href="Pie.html#property.border"><span class="argument">$border</span></a><div class="description">
|
|
|
109 |
La bordure qui entoure chaque part du camembert.
|
|
|
110 |
</div>
|
|
|
111 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
112 |
</li>
|
|
|
113 |
<li class="property">
|
|
|
114 |
<a id="property.values"></a><span class="access">public</span> <span class="type">array</span> <a href="Pie.html#property.values"><span class="argument">$values</span></a><div class="description">
|
|
|
115 |
Les valeurs du camembert.
|
|
|
116 |
</div>
|
|
|
117 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
118 |
</li>
|
|
|
119 |
<li class="property">
|
|
|
120 |
<a id="property.colors"></a><span class="access">public</span> <span class="type">array</span> <a href="Pie.html#property.colors"><span class="argument">$colors</span></a><div class="description">
|
|
|
121 |
Les couleurs des parts du camembert.
|
|
|
122 |
</div>
|
|
|
123 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
124 |
</li>
|
|
|
125 |
<li class="method">
|
|
|
126 |
<a id="method.__construct"></a><span class="access">public</span> <a href="Pie.html#method.__construct">__construct</a>(<span class="type">array</span> <span class="argument">$values</span>, <span class="type">mixed</span> <span class="argument">$colors</span> := <span class="default">Pie::COLORED</span>)
|
|
|
127 |
<div class="description">
|
|
|
128 |
Construit un nouveau camembert avec comme valeurs $values.
|
|
|
129 |
Le paramètre $colors peut soit être un tableau de couleurs, soit un thème prédéfini (<a href="Pie.html#constant.DARK">Pie::DARK</a>, <a href="Pie.html#constant.COLORED">Pie::COLORED</a>, <a href="Pie.html#constant.AQUA">Pie::AQUA</a> ou <a href="Pie.html#constant.EARTH">Pie::EARTH</a>).
|
|
|
130 |
</div>
|
|
|
131 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
132 |
</li>
|
|
|
133 |
<li class="method">
|
|
|
134 |
<a id="method.setLegend"></a><span class="access">public</span> <a href="Pie.html#method.setLegend">setLegend</a>(<span class="type">array</span> <span class="argument">$legend</span>)
|
|
|
135 |
<div class="description">
|
|
|
136 |
Change les valeurs de la légende associée au camembert.
|
|
|
137 |
$legend est un tableau qui contient autant d'entrées que de valeurs présentes sur le camembert.
|
|
|
138 |
</div>
|
|
|
139 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
140 |
</li>
|
|
|
141 |
<li class="method">
|
|
|
142 |
<a id="method.setBorder"></a><span class="access">public</span> <a href="Pie.html#method.setBorder">setBorder</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
|
|
|
143 |
<ul class="version"><li>
|
|
|
144 |
Déprécié depuis Artichow 1.0.9</li></ul>
|
|
|
145 |
<div class="description">
|
|
|
146 |
Change la couleur de la bordure entourant le camembert et séparant chaque part.
|
|
|
147 |
Cette méthode a été remplacée par Pie::setBorderColor() depuis Artichow 1.0.9.
|
|
|
148 |
<div class="see">
|
|
|
149 |
Voir aussi :
|
|
|
150 |
<ul><li><a href="Pie.html#method.setBorderColor">Pie::setBorderColor()</a></li></ul>
|
|
|
151 |
</div>
|
|
|
152 |
</div>
|
|
|
153 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
154 |
</li>
|
|
|
155 |
<li class="method">
|
|
|
156 |
<a id="method.setBorderColor"></a><span class="access">public</span> <a href="Pie.html#method.setBorderColor">setBorderColor</a>(<a href="Color.html"><span class="type">Color</span></a> <span class="argument">$color</span>)
|
|
|
157 |
<ul class="version"><li>
|
|
|
158 |
Disponible depuis Artichow 1.0.9</li></ul>
|
|
|
159 |
<div class="description">
|
|
|
160 |
Change la couleur de la bordure entourant le camembert et séparant chaque part.
|
|
|
161 |
</div>
|
|
|
162 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
163 |
</li>
|
|
|
164 |
<li class="method">
|
|
|
165 |
<a id="method.set3D"></a><span class="access">public</span> <a href="Pie.html#method.set3D">set3D</a>(<span class="type">int</span> <span class="argument">$size</span>)
|
|
|
166 |
<div class="description">
|
|
|
167 |
Associe au camembert à un effet 3D de taille $size (à spécifier en pixels).
|
|
|
168 |
</div>
|
|
|
169 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
170 |
</li>
|
|
|
171 |
<li class="method">
|
|
|
172 |
<a id="method.setStartAngle"></a><span class="access">public</span> <a href="Pie.html#method.setStartAngle">setStartAngle</a>(<span class="type">int</span> <span class="argument">$angle</span>)
|
|
|
173 |
<div class="description">
|
|
|
174 |
Angle initial en degrés pour commencer le dessin du camembert.
|
|
|
175 |
La valeur par défaut est de 0°.
|
|
|
176 |
</div>
|
|
|
177 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
178 |
</li>
|
|
|
179 |
<li class="method">
|
|
|
180 |
<a id="method.setLabelPrecision"></a><span class="access">public</span> <a href="Pie.html#method.setLabelPrecision">setLabelPrecision</a>(<span class="type">int</span> <span class="argument">$precision</span>)
|
|
|
181 |
<div class="description">
|
|
|
182 |
Change la précision des étiquettes associées à chaque part du camembert.
|
|
|
183 |
Par défaut à 0, cette précision donne le nombre de chiffres après la virgule à afficher.
|
|
|
184 |
</div>
|
|
|
185 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
186 |
</li>
|
|
|
187 |
<li class="method">
|
|
|
188 |
<a id="method.setLabelPosition"></a><span class="access">public</span> <a href="Pie.html#method.setLabelPosition">setLabelPosition</a>(<span class="type">int</span> <span class="argument">$position</span>)
|
|
|
189 |
<div class="description">
|
|
|
190 |
Change la distance des étiquettes par rapport au camembert.
|
|
|
191 |
La valeur est à donner en pixels et vaut par défaut 15 pixels.
|
|
|
192 |
Elle peut également être négative.
|
|
|
193 |
</div>
|
|
|
194 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
195 |
</li>
|
|
|
196 |
<li class="method">
|
|
|
197 |
<a id="method.setLabelNumber"></a><span class="access">public</span> <a href="Pie.html#method.setLabelNumber">setLabelNumber</a>(<span class="type">int</span> <span class="argument">$number</span>)
|
|
|
198 |
<div class="description">
|
|
|
199 |
Permet de choisir le nombre maximale d'étiquettes à afficher autour du camembert.
|
|
|
200 |
Par défaut, toutes les étiquettes sont affichées.
|
|
|
201 |
</div>
|
|
|
202 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
203 |
</li>
|
|
|
204 |
<li class="method">
|
|
|
205 |
<a id="method.setLabelMinimum"></a><span class="access">public</span> <a href="Pie.html#method.setLabelMinimum">setLabelMinimum</a>(<span class="type">int</span> <span class="argument">$minimum</span>)
|
|
|
206 |
<div class="description">
|
|
|
207 |
Permet de choisir une valeur minimum pour l'affichage des étiquettes.
|
|
|
208 |
Tout part dont le pourcentage sera inférieur à $minimum n'aura aucune étiquette associée.
|
|
|
209 |
Par défaut, il n'y a aucun minimum.
|
|
|
210 |
</div>
|
|
|
211 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
212 |
</li>
|
|
|
213 |
<li class="method">
|
|
|
214 |
<a id="method.explode"></a><span class="access">public</span> <a href="Pie.html#method.explode">explode</a>(<span class="type">array</span> <span class="argument">$explode</span>)
|
|
|
215 |
<div class="description">
|
|
|
216 |
Cette méthode permet de séparer une ou plusieurs parts du camembert.
|
|
|
217 |
Le paramètre $explode est un tableau dont les clés représente les numéros des parts à séparer et les valeurs la distance de séparation.
|
|
|
218 |
</div>
|
|
|
219 |
<div class="description-bottom"><a href="Pie.html#top">Remonter</a></div>
|
|
|
220 |
</li>
|
|
|
221 |
</ul>
|
|
|
222 |
</td>
|
|
|
223 |
<td class='borderd'> </td>
|
|
|
224 |
</tr>
|
|
|
225 |
<tr>
|
|
|
226 |
<td class='cornerbg'></td>
|
|
|
227 |
<td class='borderb'> </td>
|
|
|
228 |
<td class='cornerbd'></td>
|
|
|
229 |
</tr>
|
|
|
230 |
</table>
|
|
|
231 |
</div>
|
|
|
232 |
</body>
|
|
|
233 |
</html>
|