initial commit
[home-automation.git] / RGraph / docs / pie.html
1 <?php ob_start('ob_gzhandler') ?>
2 <!DOCTYPE html>
3 <html>
4 <head>
5     <meta http-equiv="X-UA-Compatible" content="chrome=1">
6     <!--
7         /**
8         * o------------------------------------------------------------------------------o
9         * | This file is part of the RGraph package - you can learn more at:             |
10         * |                                                                              |
11         * |                          http://www.rgraph.net                               |
12         * |                                                                              |
13         * | This package is licensed under the RGraph license. For all kinds of business |
14         * | purposes there is a small one-time licensing fee to pay and for non          |
15         * | commercial  purposes it is free to use. You can read the full license here:  |
16         * |                                                                              |
17         * |                      http://www.rgraph.net/LICENSE.txt                       |
18         * o------------------------------------------------------------------------------o
19         */
20     -->
21     <title>RGraph: HTML5 canvas graph library - Pie chart documentation</title>
22     
23     <meta name="keywords" content="rgraph html5 canvas graph docs pie chart" />
24     <meta name="description" content="RGraph: HTML5 canvas graph software - Documentation about the Pie chart" />
25
26     <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
27     <link rel="icon" type="image/png" href="/favicon.png">
28 </head>
29 <body>
30
31     <!-- Social networking buttons -->
32     <script src="../libraries/RGraph.common.core.js" ></script>
33     
34     <script>
35         function HideTwitterDIV ()
36         {
37             document.getElementById("twitter_div").style.opacity = 0;
38             document.getElementById("twitter_div").style.display = 'none';
39         }
40
41
42         function ShowTwitterDIV (e)
43         {
44             var e   = RGraph.FixEventObject(document.all ? event : e);
45             var div = document.getElementById("twitter_div");
46             var img = document.getElementById("twitter_icon");
47
48             div.style.display = 'block';
49             div.style.left    = (RGraph.getCanvasXY(img)[0] + img.offsetWidth - div.offsetWidth + 110) + 'px';
50             div.style.top     = (RGraph.getCanvasXY(img)[1] - 1) + 'px';
51
52             /**
53             * Fade it in
54             */
55             setTimeout('document.getElementById("twitter_div").style.opacity = 0.2;', 25);
56             setTimeout('document.getElementById("twitter_div").style.opacity = 0.4;', 50);
57             setTimeout('document.getElementById("twitter_div").style.opacity = 0.6;', 100);
58             setTimeout('document.getElementById("twitter_div").style.opacity = 0.8;', 125);
59             setTimeout('document.getElementById("twitter_div").style.opacity = 1.0;', 150);
60
61             e.stopPropagation();
62
63             return false;
64         }
65
66         /**
67         * This code installs the event handler that hides the Twitter DIV
68         */
69         if (RGraph.isIE8()) {
70              window.attachEvent('onload', function () {document.body.attachEvent('onclick', HideTwitterDIV);});
71         } else {
72             window.addEventListener('click', HideTwitterDIV, false);
73         }
74     </script>
75
76     <!-- The twitter DIV --> 
77     <div id="twitter_div" style="position: absolute;top: 0;left: 0;background-color: #eee;border: 2px dashed black;box-shadow: 0 0 15px #aaa;-moz-box-shadow: 0 0 15px #aaa;-webkit-box-shadow: 0 0 15px #aaa;padding: 3px;display: none;opacity: 0;z-index: 99;"> 
78         <a href="http://twitter.com/home/?status=RGraph%3A+HTML5+canvas+graph+library+based+on+the+HTML5+canvas+tag+http%3A%2F%2Fwww.rgraph.net+%23rgraph+%23html5+%23canvas" target="_blank" title="Share on Twitter" rel="nofollow" style="text-decoration: none">Tweet&nbsp;about&nbsp;RGraph</a><br>
79         <a href="http://twitter.com/_rgraph" style="text-decoration: none" rel="nofollow" target="_blank">Follow for HTML5 news</a> 
80     </div>
81
82     <div id="social_icons" class="warning" style="top: 0; left: 5px; position: absolute">
83         <script>
84             // Opera fix
85             if (navigator.userAgent.indexOf('Opera') == -1) {
86               document.getElementById("social_icons").style.position = 'fixed';
87               document.getElementById("twitter_div").style.position = 'fixed';
88     
89             }
90         </script>
91     
92         <b style="display: inline-block; position: relative; top: 1px">Bookmark and share:</b>
93     
94     
95             <div id="social">
96                 <a title="Bookmark with delicious" href="http://delicious.com/save?jump=close&v=4&noui&jump=close&url=http://www.rgraph.net&notes=RGraph%20is%20a%20HTML5%20based%20graph%20library%20supporting%20a%20wide%20range%20of%20different%20graph%20types:Bar,%20Bipolar,%20Donut,%20Funnel,%20Gantt,%20Horizontal%20Bar,%20LED,%20Line,%20Meter,%20Odometer,%20Pie,%20Progress%20Bar,%20Rose,%20RScatter,%20Scatter%20and%20Traditional%20Radar&title=RGraph:%20HTML5%20canvas%20graph%20library%20based%20on%20the%20HTML5%20canvas%20tag" target="_blank">
97                     <img src="../images/delicious.png" alt="Bookmark with delicious" width="22" height="22" border="0" align="absmiddle" /> 
98                 </a> 
99      
100                 <a href="" target="_blank" onmouseover="if (document.getElementById('twitter_div').style.display == 'none') ShowTwitterDIV(event);" onclick="event.stopPropagation(); event.cancelBubble = true; return false">
101                     <img src="../images/twitter.png" id="twitter_icon" alt="tweet this site" width="22" height="22" border="0" align="absmiddle" />
102                 </a>
103     
104     
105 <!--
106                 <a title="Post to Google Buzz!" href="" onclick="window.open('http://www.google.com/buzz/post?url=http://www.rgraph.net&imageurl=http://www.rgraph.net/images/logo.png', 'google_buzz_window', 'width=800,height=400,top=100,left=100'); return false">
107                     <img src="../images/buzz.png" width="22" height="22" alt="Post to Google Buzz!" align="absmiddle" style="position: relative; top: -2px; border: 0" border="0"/>
108                 </a>
109     
110     
111                 <a title="Share RGraph on Facebook" href="" onclick="window.open('http://www.facebook.com/sharer.php?u=http://www.rgraph.net&t=RGraph:%20HTML5%20canvas%20graph%20library', 'facebook_window', 'width=500,height=300,top=100,left=100'); return false">
112                     <img src="../images/facebook.png" width="22" height="22" alt="Post to Facebook" align="absmiddle" style="position: relative; top: -2px; border: 0" border="0"/>
113                 </a>
114     
115                 <a href="mailto:share@friendfeed.com" title="Share on FriendFeed"> 
116                     <img src="../images/friendfeed.png" width="22" height="22" alt="Share on FriendFeed" border="0" align="absmiddle" /> 
117                 </a>
118     
119                 <a href="http://www.stumbleupon.com/submit?url=http://www.rgraph.net" target="_blank" title="Share on StumbleUpon" >
120                     <img src="../images/stumble.png" alt="Stumble! this site" width="22" height="22" border="0" align="absmiddle" /> 
121                 </a>
122 -->
123             </div>
124     </div>
125     <!-- /Social networking buttons -->
126
127     <div id="breadcrumb">
128         <a href="../index.html">RGraph: HTML5 canvas graph library</a>
129         >
130         <a href="index.html">Documentation</a>
131         >
132         Pie chart
133     </div>
134
135     <h1>RGraph: HTML5 canvas graph library - Pie chart documentation</h1>
136
137     <script>
138         if (RGraph.isIE8()) {
139             document.write('<div style="background-color: #fee; border: 2px dashed red; padding: 5px"><b>Important</b><br /><br /> Internet Explorer 8 does not natively support the HTML5 canvas tag, so if you want to see the graphs, you can either:<ul><li>Install <a href="http://code.google.com/chrome/chromeframe/">Google Chrome Frame</a></li><li>Use ExCanvas. This is provided in the RGraph Archive.</li><li>Use another browser entirely. Your choices are Firefox 3.5+, Chrome 2+, Safari 4+ or Opera 10.5+. </li></ul> <b>Note:</b> Internet Explorer 9 fully supports the canvas tag. Click <a href="http://groups.google.com/group/rgraph/browse_thread/thread/c5651ff8c56b8f3c#" target="_blank">here</a> to see some screenshots.</div>');
140         }
141     </script>
142
143     <p>
144         The pie chart can be used, for example, to represent something that is akin to percentages. ie A set of data that
145         should be taken as part of a whole.
146     </p>
147     
148     <p> 
149         The example file is <a href="../examples/pie.html">here</a>.
150     </p> 
151     
152     <pre class="code">
153 &lt;script&gt;
154     window.onload = function ()
155     {
156         var data = [564,155,499,611,322];
157     
158         var pie = new RGraph.Pie('myPie', data);
159         pie.Set('chart.labels', ['Abc', 'Def', 'Ghi', 'Jkl', 'Mno']);
160         pie.Set('chart.linewidth', 5);
161         pie.Set('chart.stroke', '#fff');
162         pie.Draw();
163     }
164 &lt;/script&gt;
165 </pre>
166     
167     <a name="available.properties"></a>
168     <ul>
169         <li><a href="#available.properties">Properties</a></li>
170         <li><a href="#available.methods">Methods</a></li>
171     </ul>
172
173     <h2>Properties</h2>
174
175     <p>
176         You can use these properties to control how the pie chart looks. You can set them by using the Set() method. Eg:
177     </p>
178     
179     <p>
180         <b>myPie.Set('name', 'value');</b>
181     </p>
182     
183     <ul>
184         <li><a href="#margins">Margins</a></li>
185         <li><a href="#colors">Colors</a></li>
186         <li><a href="#labels and text">Labels and text</a></li>
187         <li><a href="#titles">Titles</a></li>
188         <li><a href="#shadows">Shadows</a></li>
189         <li><a href="#interactive features">Interactive features</a></li>
190         <li><a href="#key">Key</a></li>
191         <li><a href="#zoom">Zoom</a></li>
192         <li><a href="#scale">Scale</a></li>
193         <li><a href="#miscellaneous">Miscellaneous</a></li>
194     </ul>
195
196
197 <a name="margins"></a>
198 <h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Margins</h3>            <a name="chart.gutter"></a>
199 <b>chart.gutter</b><br />
200             The gutter of the graph (for text labels). <br /><i>Default: 25</i><br /><br />
201 <a name="colors"></a>
202 <h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Colors</h3>            <a name="chart.colors"></a>
203 <b>chart.colors</b><br />
204             Colors to be used for the pie segments. <br /><i>Default: ['rgb(255,0,0)', '#ddd', 'rgb(0,255,0)', 'rgb(0,0,255)', 'rgb(255,255,0)', 'rgb(0,255,255)', 'red', 'pink', 'black', 'white']</i><br /><br />
205             <a name="chart.strokestyle"></a>
206 <b>chart.strokestyle</b><br />
207             The color of the seperating lines. By setting this to your background color, and setting the linewidth to approx. 5, it will make the pie chart look "exploded". <br /><i>Default: #999</i><br /><br />
208 <a name="labels and text"></a>
209 <h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Labels and text</h3>            <a name="chart.text.size"></a>
210 <b>chart.text.size</b><br />
211             The size of the text (in points). <br /><i>Default: 10</i><br /><br />
212             <a name="chart.text.font"></a>
213 <b>chart.text.font</b><br />
214             The font used to render the text.<br /><i>Default: Verdana</i><br /><br />
215             <a name="chart.text.color"></a>
216 <b>chart.text.color</b><br />
217             The color of the labels. <br /><i>Default: black</i><br /><br />
218             <a name="chart.labels"></a>
219 <b>chart.labels</b><br />
220             An array of labels to be used for the chart. <br /><i>Default: [] (an empty array)</i><br /><br />
221             <a name="chart.labels.sticks"></a>
222 <b>chart.labels.sticks</b><br />
223             Stipulates that small sticks for the labels are shown. The <a href="../examples/pie.html">example page</a> has an example of this.<br /><i>Default: false</i><br /><br />
224             <a name="chart.labels.sticks.color"></a>
225 <b>chart.labels.sticks.color</b><br />
226             Sets the color of the label sticks.<br /><i>Default: #aaa</i><br /><br />
227 <a name="titles"></a>
228 <h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Titles</h3>            <a name="chart.title"></a>
229 <b>chart.title</b><br />
230             The title of the pie chart. <br /><i>Default: none</i><br /><br />
231
232 <a name="chart.title.background"></a>
233 <b>chart.title.background</b><br />
234 The background color (if any) for the title.<br />
235 <i>Default: null</i><br /><br />
236
237             <a name="chart.title.color"></a>
238 <b>chart.title.color</b><br />
239             The color of the title.<br /> <i>Default: black</i><br /><br />
240             <a name="chart.title.hpos"></a>
241 <b>chart.title.hpos</b><br />
242             This allows you to completely override the horizontal positioning of the title. It should be a number between 0 and 1, and is multiplied with the whole width of the canvas and then used as the horizontal position. <br /><i>Default: null</i><br /><br />
243             <a name="chart.title.vpos"></a>
244 <b>chart.title.vpos</b><br />
245             This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.<br /><i>Default: null</i><br /><br />
246 <a name="shadows"></a>
247 <h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Shadows</h3>            <a name="chart.shadow"></a>
248 <b>chart.shadow</b><br />
249             Whether a simple shadow effect is applied. <br /><i>Default: false</i><br /><br />
250             <a name="chart.shadow.color"></a>
251 <b>chart.shadow.color</b><br />
252             The color of the shadow. <br /> <i>Default: rgba(0,0,0,0.5)</i><br /><br />
253             <a name="chart.shadow.blur"></a>
254 <b>chart.shadow.blur</b><br />
255             The severity of the shadow blurring effect. <br /> <i>Default: 3</i><br /><br />
256             <a name="chart.shadow.offsetx"></a>
257 <b>chart.shadow.offsetx</b><br />
258             The X offset of the shadow.<br /><i>Default: 3</i><br /><br />
259             <a name="chart.shadow.offsety"></a>
260 <b>chart.shadow.offsety</b><br />
261             The Y offset of the shadow.<br /><i>Default: 3</i><br /><br />
262 <a name="interactive features"></a>
263 <h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Interactive features</h3>
264
265             <a name="chart.tooltips"></a>
266             <b>chart.tooltips</b><br />
267             An array of tooltips, starting from the middle right (ie east) axis, and going clockwise sequentially.<br />
268             <i>Default: [] (An empty array)</i><br /><br />
269
270             <a name="chart.tooltips.event"></a>
271             <b>chart.tooltips.event</b><br />
272             This can be <i>onclick</i> or <i>onmousemove</i> and determines which event is used for tooltips.<br />
273             <i>Default: onclick</i><br /><br />
274
275             <a name="chart.tooltips.effect"></a>
276             <b>chart.tooltips.effect</b><br />
277             The animated effect used for showing tooltips. Can be either <i>fade</i> or <i>expand</i>.<br />
278             <i>Default: fade</i><br /><br />
279             
280             <a name="chart.tooltips.css.class"></a>
281             <b>chart.tooltips.css.class</b><br />
282             This is the name of the CSS class the graph uses.<br />
283             <i>Default: RGraph_tooltip</i><br /><br />
284             
285             <a name="chart.tooltips.override"></a>
286             <b>chart.tooltips.override</b><br />
287             If you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more
288             information on the <a href="tooltips.html">tooltips documentation page</a><br />
289             <i>Default: null</i><br /><br />
290
291
292             <a name="chart.contextmenu"></a>
293 <b>chart.contextmenu</b><br />
294             An array of context menu items. More information on context menus is <a href="context.html">here</a>.<br /><i>Default: [] (An empty array)</i><br /><br />
295             <a name="chart.annotatable"></a>
296 <b>chart.annotatable</b><br />
297             Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i><br /><br />
298             <a name="chart.annotate.color"></a>
299 <b>chart.annotate.color</b><br />
300             If you do not allow the use of the palette, then this will be the only colour allowed for annotations.<br /><i>Default: black</i><br /><br />
301             <a name="chart.resizable"></a>
302 <b>chart.resizable</b><br />
303             Defaulting to false, this determines whether your graph will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).<br /><i>Default: false</i><br /><br />
304
305
306
307
308             <a name="key"></a>
309             <h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Key</h3>
310             
311             <a name="chart.key"></a>
312             <b>chart.key</b><br />
313             An array of key information. <br />
314             <i>Default: [] (An empty array)</i><br /><br />
315
316             <a name="chart.key.background"></a>
317             <b>chart.key.background</b><br />
318             The color of the key background. Typically white, you could set this to something like rgba(255,255,255,0.7) to allow people to see things behind it.<br>
319             <i>Default: white</i><br /><br />
320             
321             <a name="chart.key.position"></a>
322             <b>chart.key.position</b><br />
323             Determines the position of the key.Either <b>graph</b> (default), or <b>gutter</b>.<br />
324             <i>Default: graph</i><br /><br />
325             
326             <b>chart.key.position.x</b><br />
327             This allows you to specify a specific X coordinate for the key.<br />
328             <i>Default: null</i><br /><br />
329             
330             <b>chart.key.position.y</b><br />
331             This allows you to specify a specific Y coordinate for the key.<br />
332             <i>Default: null</i><br /><br />
333             
334             <b>chart.key.position.gutter.boxed</b><br />
335             If you have the key in gutter mode (ie horizontal), this allows you to give a background color.<br />
336             <i>Default: true</i><br /><br />
337             
338             <a name="chart.key.shadow"></a>
339             <b>chart.key.shadow</b><br />
340             Whether a small drop shadow is applied to the key.<br />
341             <i>Default: false</i><br /><br />
342
343             <a name="chart.key.shadow.color"></a>
344             <b>chart.key.shadow.color</b><br />
345             The color of the shadow.<br />
346             <i>Default: #666</i><br /><br />
347
348             <a name="chart.key.shadow.blur"></a>
349             <b>chart.key.shadow.blur</b><br />
350             The extent of the blurring effect used on the shadow.<br />
351             <i>Default: 3</i><br /><br />
352
353             <a name="chart.key.shadow.offsetx"></a>
354             <b>chart.key.shadow.offsetx</b><br />
355             The X offset of the shadow.<br />
356             <i>Default: 2</i><br /><br />
357
358             <a name="chart.key.shadow.offsety"></a>
359             <b>chart.key.shadow.offsety</b><br />
360             The Y offset of the shadow.<br />
361             <i>Default: 2</i><br /><br />
362
363             <b>chart.key.rounded</b><br />
364             This controls whether the corners of the key (in graph mode) are curved. If the key is gutter mode, this has no effect.<br />
365             <i>Default: false</i><br /><br />
366             
367             <b>chart.key.color.shape</b><br />
368             This can be <i>square</i>, <i>circle</i> or <i>line</i> and controls how the color indicators in the key appear.<br />
369             <i>Default: square</i><br /><br />
370
371
372
373 <a name="zoom"></a>
374 <h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Zoom</h3>            <a name="chart.zoom.mode"></a>
375 <b>chart.zoom.mode</b><br />
376             Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: <i>thumbnail</i> and <i>canvas</i>.<br /><i>Default: canvas</i><br /><br />
377             <a name="chart.zoom.factor"></a>
378 <b>chart.zoom.factor</b><br />
379             This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i><br /><br />
380             <a name="chart.zoom.fade.in"></a>
381 <b>chart.zoom.fade.in</b><br />
382             Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i><br /><br />
383             <a name="chart.zoom.fade.out"></a>
384 <b>chart.zoom.fade.out</b><br />
385             Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.<br /><i>Default: true</i><br /><br />
386             <a name="chart.zoom.hdir"></a>
387 <b>chart.zoom.hdir</b><br />
388             The horizontal direction of the zoom. Possible values are: <i>left</i>, <i>center</i>, <i>right</i><br /><i>Default: right</i><br /><br />
389             <a name="chart.zoom.vdir"></a>
390 <b>chart.zoom.vdir</b><br />
391             The vertical direction of the zoom. Possible values are: <i>up</i>, <i>center</i>, <i>down</i><br /><i>Default: down</i><br /><br />
392             <a name="chart.zoom.delay"></a>
393 <b>chart.zoom.delay</b><br />
394             The delay (in milliseconds) between frames.<br /><i>Default: 50</i><br /><br />
395             <a name="chart.zoom.frames"></a>
396 <b>chart.zoom.frames</b><br />
397             The number of frames in the zoom animation.<br /><i>Default: 10</i><br /><br />
398             <a name="chart.zoom.shadow"></a>
399 <b>chart.zoom.shadow</b><br />
400             Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i><br /><br />
401             <a name="chart.zoom.thumbnail.width"></a>
402 <b>chart.zoom.thumbnail.width</b><br />
403             When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
404             <a name="chart.zoom.thumbnail.height"></a>
405 <b>chart.zoom.thumbnail.height</b><br />
406             When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
407             <a name="chart.zoom.background"></a>
408 <b>chart.zoom.background</b><br />
409             Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.<br /><i>Default: true</i><br /><br />
410 <a name="scale"></a>
411 <h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Scale</h3>            <a name="chart.units.pre"></a>
412 <b>chart.units.pre</b><br />
413             The units that the value is measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50" and is only used if chart.value.text is <i>true</i>.<br /><i>Default: none</i><br /><br />
414             <a name="chart.units.post"></a>
415 <b>chart.units.post</b><br />
416             The units that the value is measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms" and is only used if chart.value.text is <i>true</i>.<br /><i>Default: none</i><br /><br />
417 <a name="miscellaneous"></a>
418 <h3 style="border: 1px solid #aaa; background-color: #eee; font-style: italic; padding: 5px; -moz-border-radius: 10px; -webkit-border-radius: 10px; border-radius: 10px">Miscellaneous</h3>            <a name="chart.align"></a>
419 <b>chart.align</b><br />
420             Whether to left, center or right align the pie chart.<br /><i>Default: center</i><br /><br />
421             <a name="chart.linewidth"></a>
422 <b>chart.linewidth</b><br />
423             By setting this to roughly 5, and setting the strokestyle to the same colour as your background colour,you will get a segment separation effect.<br /><i>Default: 1</i><br /><br />
424             <a name="chart.variant"></a>
425 <b>chart.variant</b><br />
426             This can be either <i>pie</i> (the default) or <i>donut</i>. Setting this to <i>donut</i> is how you get a donut chart.<br /><i>Default: pie</i><br /><br />
427             <a name="chart.value.text"></a>
428 <b>chart.value.text</b><br />
429             Set this to true if you want the value displayed in text beow the center of the pointer.<br /><i>Default: false</i><br /><br />
430             
431             <a name="chart.highlight.style"></a>
432             <b>chart.highlight.style</b><br />
433             Can be either <i>2d</i> or <i>3d</i> and determines which style of segment highlighting is used in
434             conjunction with tooltips.<br />
435             <i>Default: 2d</i><br /><br />
436             
437             <a name="chart.highlight.style.2d.color"></a>
438             <b>chart.highlight.style.2d.color</b><br />
439             When 2D highlighting for tooltips is used, this controls the color of the highlighting.<br />
440             <i>Default: rgba(255,255,255,0.5)</i><br /><br />
441 </div>
442
443     <a name="available.methods"></a>
444     <br />&nbsp;<br />
445     <h2>Methods</h2>
446
447     <b>RGraph.getSegment()</b><br /><br />
448     
449     RGraph.getSegment() makes it easy to determine which segment of the Pie chart was clicked on. It provides:
450     
451     <ul>
452         <li>Originating X coordinate</li>
453         <li>Originating Y coordinate</li>
454         <li>The radius of the segment</li>
455         <li>The starting angle (in degrees)</li>
456         <li>The ending angle (in degrees)</li>
457     </ul>
458
459     <pre class="code">
460 &lt;script&gt;
461     RGraph.Register(myGraph);
462     
463     myGraph.canvas.onclick = function (e)
464     {
465         RGraph.FixEventObject(e);
466         RGraph.Redraw();
467
468         var canvas  = e.target;
469         var context = canvas.getContext('2d');
470         var obj     = canvas.__object__;
471         <span style="color: green">var segment = RGraph.getSegment(e);</span>
472         
473         if (segment) {
474             context.fillStyle = 'rgba(255,255,255,0.5)';
475             context.beginPath();
476                 
477                 // Angles are provided in degrees, so convert them to radians
478                 segment[3] /= 57.29;
479                 segment[4] /= 57.29;
480             
481                 context.moveTo(segment[0], segment[1]);
482                 context.arc(segment[0], segment[1], segment[2], segment[3], segment[4], 0);
483             context.stroke();
484             context.fill();
485             
486             e.stopPropagation();
487         }
488     }
489     
490     window.onclick = function (e)
491     {
492         RGraph.Redraw();
493     }
494 &lt;/script&gt;
495 </pre>
496
497 </body>
498 </html>