RGraph/docs/tradar.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 personal,    |
  15         * | charity and educational purposes it is free to use. You can read the full    |
  16         * | license here:                                                                |
  17         * |                      http://www.rgraph.net/LICENSE.txt                       |
  18         * o------------------------------------------------------------------------------o
  19         */
  20     -->
  21     <title>RGraph: HTML5 canvas graph library - Traditional radar chart documentation</title>
  22     <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
  23     <link rel="icon" type="image/png" href="/favicon.png">
  24 </head>
  25 <body>
  26
  27     <!-- Social networking buttons -->
  28     <script src="../libraries/RGraph.common.core.js" ></script>
  29
  30     <script>
  31         function HideTwitterDIV ()
  32         {
  33             document.getElementById("twitter_div").style.opacity = 0;
  34             document.getElementById("twitter_div").style.display = 'none';
  35         }
  36
  37
  38         function ShowTwitterDIV (e)
  39         {
  40             var e   = RGraph.FixEventObject(document.all ? event : e);
  41             var div = document.getElementById("twitter_div");
  42             var img = document.getElementById("twitter_icon");
  43
  44             div.style.display = 'block';
  45             div.style.left    = (RGraph.getCanvasXY(img)[0] + img.offsetWidth - div.offsetWidth + 110) + 'px';
  46             div.style.top     = (RGraph.getCanvasXY(img)[1] - 1) + 'px';
  47
  48             /**
  49             * Fade it in
  50             */
  51             setTimeout('document.getElementById("twitter_div").style.opacity = 0.2;', 25);
  52             setTimeout('document.getElementById("twitter_div").style.opacity = 0.4;', 50);
  53             setTimeout('document.getElementById("twitter_div").style.opacity = 0.6;', 100);
  54             setTimeout('document.getElementById("twitter_div").style.opacity = 0.8;', 125);
  55             setTimeout('document.getElementById("twitter_div").style.opacity = 1.0;', 150);
  56
  57             e.stopPropagation();
  58
  59             return false;
  60         }
  61
  62         /**
  63         * This code installs the event handler that hides the Twitter DIV
  64         */
  65         if (RGraph.isIE8()) {
  66              window.attachEvent('onload', function () {document.body.attachEvent('onclick', HideTwitterDIV);});
  67         } else {
  68             window.addEventListener('click', HideTwitterDIV, false);
  69         }
  70     </script>
  71
  72     <!-- The twitter DIV -->
  73     <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;">
  74         <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>
  75         <a href="http://twitter.com/_rgraph" style="text-decoration: none" rel="nofollow" target="_blank">Follow for HTML5 news</a>
  76     </div>
  77
  78     <div id="social_icons" class="warning" style="top: 0; left: 5px; position: absolute">
  79         <script>
  80             // Opera fix
  81             if (navigator.userAgent.indexOf('Opera') == -1) {
  82               document.getElementById("social_icons").style.position = 'fixed';
  83               document.getElementById("twitter_div").style.position = 'fixed';
  84
  85             }
  86         </script>
  87
  88         <b style="display: inline-block; position: relative; top: 1px">Bookmark and share:</b>
  89
  90
  91             <div id="social">
  92                 <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">
  93                     <img src="../images/delicious.png" alt="Bookmark with delicious" width="22" height="22" border="0" align="absmiddle" />
  94                 </a>
  95
  96                 <a href="" target="_blank" onmouseover="if (document.getElementById('twitter_div').style.display == 'none') ShowTwitterDIV(event);" onclick="event.stopPropagation(); event.cancelBubble = true; return false">
  97                     <img src="../images/twitter.png" id="twitter_icon" alt="tweet this site" width="22" height="22" border="0" align="absmiddle" />
  98                 </a>
  99
 100
 101 <!--
 102                 <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">
 103                     <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"/>
 104                 </a>
 105
 106
 107                 <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">
 108                     <img src="../images/facebook.png" width="22" height="22" alt="Post to Facebook" align="absmiddle" style="position: relative; top: -2px; border: 0" border="0"/>
 109                 </a>
 110
 111                 <a href="mailto:share@friendfeed.com" title="Share on FriendFeed">
 112                     <img src="../images/friendfeed.png" width="22" height="22" alt="Share on FriendFeed" border="0" align="absmiddle" />
 113                 </a>
 114
 115                 <a href="http://www.stumbleupon.com/submit?url=http://www.rgraph.net" target="_blank" title="Share on StumbleUpon" >
 116                     <img src="../images/stumble.png" alt="Stumble! this site" width="22" height="22" border="0" align="absmiddle" />
 117                 </a>
 118 -->
 119             </div>
 120     </div>
 121     <!-- /Social networking buttons -->
 122
 123     <div id="breadcrumb">
 124         <a href="../index.html">RGraph: HTML5 canvas graph library</a>
 125         >
 126         <a href="index.html">Documentation</a>
 127         >
 128         Traditional radar chart
 129     </div>
 130
 131     <h1>RGraph: HTML5 canvas graph library - Traditional radar chart documentation</h1>
 132
 133     <script>
 134         if (RGraph.isIE8()) {
 135             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>');
 136         }
 137     </script>
 138
 139     <p>
 140         A traditional radar chart.
 141     </p>
 142
 143     <p>
 144         The example file is <a href="../examples/tradar.html">here</a>.
 145     </p>
 146
 147     <pre class="code">
 148 &lt;script&gt;
 149     window.onload = function ()
 150     {
 151         var data = [3, 3, 41, 37, 16];
 152
 153         var tradar = new RGraph.Tradar('myTradar', data);
 154         tradar.Set('chart.background.circles', true);
 155         tradar.Set('chart.color', 'rgba(255,0,0,0.5)');
 156         tradar.Set('chart.circle', 20);
 157         tradar.Set('chart.circle.fill', 'rgba(200,255,200,0.5)');
 158         tradar.Set('chart.labels', ['Safari (3%)', 'Other (3%)', 'MSIE 7 (41%)', 'MSIE 6 (37%)', 'Firefox (16%)']);
 159         tradar.Set('chart.key', ['Market share', 'A made up figure']);
 160         tradar.Draw();
 161     }
 162 &lt;/script&gt;
 163 </pre>
 164
 165
 166     <h2>Properties</h2>
 167
 168     <p>
 169         You can use these properties to control how the chart apears. You can set these properties by using the Set() method. Eg:
 170     </p>
 171
 172     <p>
 173         <b>myTradar.Set('color', 'rgba(255,0,0,0.5)');</b>
 174     </p>
 175
 176     <ul>
 177         <li><a href="#margins">Margins</a></li>
 178         <li><a href="#colors">Colors</a></li>
 179         <li><a href="#title">Title</a></li>
 180         <li><a href="#labels and text">Labels and text</a></li>
 181         <li><a href="#scale">Scale</a></li>
 182         <li><a href="#miscellaneous">Miscellaneous</a></li>
 183         <li><a href="#key">Key</a></li>
 184         <li><a href="#interactive features">Interactive features</a></li>
 185         <li><a href="#zoom">Zoom</a></li>
 186     </ul>
 187
 188
 189 <a name="margins"></a>
 190 <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>
 191 <b>chart.gutter</b><br />
 192             The gutter that the chart uses. This is effectively the margin.<br /><i>Default: 25</i><br /><br />
 193 <a name="colors"></a>
 194 <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.color"></a>
 195 <b>chart.color</b><br />
 196             The color of the radar chart.<br /><i>Default: rgba(255,0,0,0.5)</i><br /><br />
 197 <a name="title"></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">Title</h3>            <a name="chart.title"></a>
 199 <b>chart.title</b><br />
 200             The title, if any, of the chart.<br /><i>Default: Not set</i><br /><br />
 201             <a name="chart.title.color"></a>
 202 <b>chart.title.color</b><br />
 203             The color of the title.<br /> <i>Default: black</i><br /><br />
 204             <a name="chart.title.vpos"></a>
 205 <b>chart.title.vpos</b><br />
 206             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 />
 207             <a name="chart.title.hpos"></a>
 208 <b>chart.title.hpos</b><br />
 209             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 />
 210 <a name="labels and text"></a>
 211 <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.labels"></a>
 212 <b>chart.labels</b><br />
 213             The labels to use for the chart.<br /><i>Default: An empty array</i><br /><br />
 214             <a name="chart.labels.axes"></a>
 215 <b>chart.labels.axes</b><br />
 216             This controls the axes that show the scale labels. Each letter stands for the appropriate axis (North, South, East and West)<br /><i>Default: nsew</i><br /><br />
 217             <a name="chart.labels.offsetx"></a>
 218 <b>chart.labels.offsetx</b><br />
 219             The X pixel offset for the labels.<br /><i>Default: 10</i><br /><br />
 220             <a name="chart.labels.offsety"></a>
 221 <b>chart.labels.offsety</b><br />
 222             The Y pixel offset for the labels.<br /><i>Default: 10</i><br /><br />
 223             <a name="chart.text.font"></a>
 224 <b>chart.text.font</b><br />
 225             The font used to render the text.<br /><i>Default: Verdana</i><br /><br />
 226             <a name="chart.text.color"></a>
 227 <b>chart.text.color</b><br />
 228             The color of the labels. <br /><i>Default: black</i><br /><br />
 229             <a name="chart.text.size"></a>
 230 <b>chart.text.size</b><br />
 231             The size of the text (in points).<br /><i>Default: 10</i><br /><br />
 232 <a name="scale"></a>
 233
 234 <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.ymax"></a>
 235             <b>chart.ymax</b><br />
 236             The optional maximum Y scale value. If not specified then it will be calculated.<br /><i>Default: null (It's calculated)</i><br /><br />
 237
 238             <a name="chart.scale.round"></a>
 239             <b>chart.scale.round</b><br />
 240             Whether to round the maximum scale value up or not. This will produce slightly better scales in some instances.<br />
 241             <i>Default: null</i><br /><br />
 242
 243 <a name="miscellaneous"></a>
 244 <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.background.circles"></a>
 245 <b>chart.background.circles</b><br />
 246             Whether to draw the grey background circles.<br /><i>Default: true</i><br /><br />
 247             <a name="chart.linewidth"></a>
 248 <b>chart.linewidth</b><br />
 249             The width of the outline.<br /><i>Default: 1</i><br /><br />
 250             <a name="chart.circle"></a>
 251 <b>chart.circle</b><br />
 252             What value to draw a circle at. Defaults to zero (off). You could use this to represent a threshold of some sort.<br /><i>Default: 0</i><br /><br />
 253             <a name="chart.circle.fill"></a>
 254 <b>chart.circle.fill</b><br />
 255             What color to fill the circle with.<br /><i>Default: red</i><br /><br />
 256             <a name="chart.circle.stroke"></a>
 257 <b>chart.circle.stroke</b><br />
 258             What color to stroke (ie The outline) the circle with.<br /><i>Default: black</i><br /><br />
 259
 260
 261
 262
 263
 264
 265             <a name="key"></a>
 266             <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>
 267
 268             <a name="chart.key"></a>
 269             <b>chart.key</b><br />
 270             An array of key information. <br />
 271             <i>Default: [] (An empty array)</i><br /><br />
 272
 273             <a name="chart.key.background"></a>
 274             <b>chart.key.background</b><br />
 275             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>
 276             <i>Default: white</i><br /><br />
 277
 278             <a name="chart.key.position"></a>
 279             <b>chart.key.position</b><br />
 280             Determines the position of the key.Either <b>graph</b> (default), or <b>gutter</b>.<br />
 281             <i>Default: graph</i><br /><br />
 282
 283             <b>chart.key.position.x</b><br />
 284             This allows you to specify a specific X coordinate for the key.<br />
 285             <i>Default: null</i><br /><br />
 286
 287             <b>chart.key.position.y</b><br />
 288             This allows you to specify a specific Y coordinate for the key.<br />
 289             <i>Default: null</i><br /><br />
 290
 291             <b>chart.key.position.gutter.boxed</b><br />
 292             If you have the key in gutter mode (ie horizontal), this allows you to give a background color.<br />
 293             <i>Default: true</i><br /><br />
 294
 295             <a name="chart.key.shadow"></a>
 296             <b>chart.key.shadow</b><br />
 297             Whether a small drop shadow is applied to the key.<br />
 298             <i>Default: false</i><br /><br />
 299
 300             <a name="chart.key.shadow.color"></a>
 301             <b>chart.key.shadow.color</b><br />
 302             The color of the shadow.<br />
 303             <i>Default: #666</i><br /><br />
 304
 305             <a name="chart.key.shadow.blur"></a>
 306             <b>chart.key.shadow.blur</b><br />
 307             The extent of the blurring effect used on the shadow.<br />
 308             <i>Default: 3</i><br /><br />
 309
 310             <a name="chart.key.shadow.offsetx"></a>
 311             <b>chart.key.shadow.offsetx</b><br />
 312             The X offset of the shadow.<br />
 313             <i>Default: 2</i><br /><br />
 314
 315             <a name="chart.key.shadow.offsety"></a>
 316             <b>chart.key.shadow.offsety</b><br />
 317             The Y offset of the shadow.<br />
 318             <i>Default: 2</i><br /><br />
 319
 320             <b>chart.key.rounded</b><br />
 321             This controls whether the corners of the key (in graph mode) are curved. If the key is gutter mode, this has no effect.<br />
 322             <i>Default: false</i><br /><br />
 323
 324             <b>chart.key.color.shape</b><br />
 325             This can be <i>square</i>, <i>circle</i> or <i>line</i> and controls how the color indicators in the key appear.<br />
 326             <i>Default: square</i><br /><br />
 327
 328
 329
 330
 331
 332
 333
 334 <a name="interactive features"></a>
 335 <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>            <a name="chart.contextmenu"></a>
 336 <b>chart.contextmenu</b><br />
 337             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 />
 338             <a name="chart.annotatable"></a>
 339 <b>chart.annotatable</b><br />
 340             Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i><br /><br />
 341             <a name="chart.annotate.color"></a>
 342 <b>chart.annotate.color</b><br />
 343             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 />
 344             <a name="chart.tooltips"></a>
 345 <b>chart.tooltips</b><br />
 346             A numerically indexed array of tooltips that are shown when a hotspot is hovered over. These can contain HTML.<br /><i>Default: An empty array</i><br /><br />
 347             <a name="chart.tooltips.effect"></a>
 348 <b>chart.tooltips.effect</b><br />
 349             The visual effect used when showing tooltips. Can be either <i>fade</i> or <i>expand</i>.<br /><i>Default: fade</i><br /><br />
 350             <a name="chart.tooltips.css.class"></a>
 351 <b>chart.tooltips.css.class</b><br />
 352             This is the name of the CSS class the graph uses.<br /><i>Default: RGraph_tooltip</i><br /><br />
 353             <a name="chart.tooltips.override"></a>
 354 <b>chart.tooltips.override</b><br />
 355             If you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more information on the <a href="tooltips.html">tooltips documentation page</a><br /><i>Default: null</i><br /><br />
 356             <a name="chart.resizable"></a>
 357 <b>chart.resizable</b><br />
 358             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 />
 359 <a name="zoom"></a>
 360 <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>
 361 <b>chart.zoom.mode</b><br />
 362             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 />
 363             <a name="chart.zoom.factor"></a>
 364 <b>chart.zoom.factor</b><br />
 365             This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i><br /><br />
 366             <a name="chart.zoom.fade.in"></a>
 367 <b>chart.zoom.fade.in</b><br />
 368             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 />
 369             <a name="chart.zoom.fade.out"></a>
 370 <b>chart.zoom.fade.out</b><br />
 371             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 />
 372             <a name="chart.zoom.hdir"></a>
 373 <b>chart.zoom.hdir</b><br />
 374             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 />
 375             <a name="chart.zoom.vdir"></a>
 376 <b>chart.zoom.vdir</b><br />
 377             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 />
 378             <a name="chart.zoom.delay"></a>
 379 <b>chart.zoom.delay</b><br />
 380             The delay (in milliseconds) between frames.<br /><i>Default: 50</i><br /><br />
 381             <a name="chart.zoom.frames"></a>
 382 <b>chart.zoom.frames</b><br />
 383             The number of frames in the zoom animation.<br /><i>Default: 10</i><br /><br />
 384             <a name="chart.zoom.shadow"></a>
 385 <b>chart.zoom.shadow</b><br />
 386             Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i><br /><br />
 387             <a name="chart.zoom.thumbnail.width"></a>
 388 <b>chart.zoom.thumbnail.width</b><br />
 389             When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
 390             <a name="chart.zoom.thumbnail.height"></a>
 391 <b>chart.zoom.thumbnail.height</b><br />
 392             When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
 393             <a name="chart.zoom.background"></a>
 394 <b>chart.zoom.background</b><br />
 395             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 />
 396 </div><!-- /DOCS --><br /><br />
 397 </body>
 398 </html>