RGraph/docs/keys.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 - Examples of keys</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
  25     <script src="../libraries/RGraph.common.core.js" ></script>
  26     <script src="../libraries/RGraph.line.js" ></script>
  27     <script src="../libraries/RGraph.pie.js" ></script>
  28     <!--[if IE 8]><script src="../excanvas/excanvas.compressed.js"></script><![endif]-->
  29
  30     <script>
  31         window.onload = function ()
  32         {
  33             var pie = new RGraph.Pie('myPie', [45,43,23,68,84,41]);
  34             pie.Set('chart.title', 'A pie chart showing graph mode');
  35             pie.Set('chart.key', ['John','Fred','Lou','Pete','Kevin','Gary']);
  36             pie.Set('chart.key.rounded', false);
  37
  38             pie.Set('chart.key.shadow', true);
  39             pie.Set('chart.key.shadow.offsetx', 3);
  40             pie.Set('chart.key.shadow.offsety', 3);
  41             pie.Set('chart.key.shadow.blur', 0);
  42             pie.Set('chart.key.shadow.color', '#aaa');
  43
  44             pie.Draw();
  45
  46             var line = new RGraph.Line('myLine', [8,4,2,5,6,4,3,7,8,9,7,6], [4,3,1,6,5,8,4,9,8,7,4,6]);
  47             line.Set('chart.key', ['Richard', 'Fred']);
  48             line.Set('chart.title', 'A line chart showing the key in gutter mode');
  49             line.Set('chart.key.position', 'gutter');
  50             line.Set('chart.key.position.y', line.canvas.height - 45); // 45 pixels from the bottom
  51             line.Set('chart.key.shadow', true);
  52             line.Set('chart.key.shadow.offsetx', 0);
  53             line.Set('chart.key.shadow.offsety', 0);
  54             line.Set('chart.key.shadow.blur', 15);
  55             line.Set('chart.key.shadow.color', '#ccc');
  56             line.Set('chart.hmargin', 5);
  57             line.Set('chart.linewidth', 3);
  58             line.Set('chart.labels', ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec']);
  59             line.Draw();
  60         }
  61     </script>
  62 </head>
  63 <body>
  64
  65     <!-- Social networking buttons -->
  66
  67     <script>
  68         function HideTwitterDIV ()
  69         {
  70             document.getElementById("twitter_div").style.opacity = 0;
  71             document.getElementById("twitter_div").style.display = 'none';
  72         }
  73
  74
  75         function ShowTwitterDIV (e)
  76         {
  77             var e   = RGraph.FixEventObject(document.all ? event : e);
  78             var div = document.getElementById("twitter_div");
  79             var img = document.getElementById("twitter_icon");
  80
  81             div.style.display = 'block';
  82             div.style.left    = (RGraph.getCanvasXY(img)[0] + img.offsetWidth - div.offsetWidth + 110) + 'px';
  83             div.style.top     = (RGraph.getCanvasXY(img)[1] - 1) + 'px';
  84
  85             /**
  86             * Fade it in
  87             */
  88             setTimeout('document.getElementById("twitter_div").style.opacity = 0.2;', 25);
  89             setTimeout('document.getElementById("twitter_div").style.opacity = 0.4;', 50);
  90             setTimeout('document.getElementById("twitter_div").style.opacity = 0.6;', 100);
  91             setTimeout('document.getElementById("twitter_div").style.opacity = 0.8;', 125);
  92             setTimeout('document.getElementById("twitter_div").style.opacity = 1.0;', 150);
  93
  94             e.stopPropagation();
  95
  96             return false;
  97         }
  98
  99         /**
 100         * This code installs the event handler that hides the Twitter DIV
 101         */
 102         if (RGraph.isIE8()) {
 103              window.attachEvent('onload', function () {document.body.attachEvent('onclick', HideTwitterDIV);});
 104         } else {
 105             window.addEventListener('click', HideTwitterDIV, false);
 106         }
 107     </script>
 108
 109     <!-- The twitter DIV -->
 110     <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;">
 111         <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>
 112         <a href="http://twitter.com/_rgraph" style="text-decoration: none" rel="nofollow" target="_blank">Follow for HTML5 news</a>
 113     </div>
 114
 115     <div id="social_icons" class="warning" style="top: 0; left: 5px; position: absolute">
 116         <script>
 117             // Opera fix
 118             if (navigator.userAgent.indexOf('Opera') == -1) {
 119               document.getElementById("social_icons").style.position = 'fixed';
 120               document.getElementById("twitter_div").style.position = 'fixed';
 121
 122             }
 123         </script>
 124
 125         <b style="display: inline-block; position: relative; top: 1px">Bookmark and share:</b>
 126
 127
 128             <div id="social">
 129                 <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">
 130                     <img src="../images/delicious.png" alt="Bookmark with delicious" width="22" height="22" border="0" align="absmiddle" />
 131                 </a>
 132
 133                 <a href="" target="_blank" onmouseover="if (document.getElementById('twitter_div').style.display == 'none') ShowTwitterDIV(event);" onclick="event.stopPropagation(); event.cancelBubble = true; return false">
 134                     <img src="../images/twitter.png" id="twitter_icon" alt="tweet this site" width="22" height="22" border="0" align="absmiddle" />
 135                 </a>
 136
 137
 138 <!--
 139                 <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">
 140                     <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"/>
 141                 </a>
 142
 143
 144                 <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">
 145                     <img src="../images/facebook.png" width="22" height="22" alt="Post to Facebook" align="absmiddle" style="position: relative; top: -2px; border: 0" border="0"/>
 146                 </a>
 147
 148                 <a href="mailto:share@friendfeed.com" title="Share on FriendFeed">
 149                     <img src="../images/friendfeed.png" width="22" height="22" alt="Share on FriendFeed" border="0" align="absmiddle" />
 150                 </a>
 151
 152                 <a href="http://www.stumbleupon.com/submit?url=http://www.rgraph.net" target="_blank" title="Share on StumbleUpon" >
 153                     <img src="../images/stumble.png" alt="Stumble! this site" width="22" height="22" border="0" align="absmiddle" />
 154                 </a>
 155 -->
 156             </div>
 157     </div>
 158     <!-- /Social networking buttons -->
 159
 160     <div id="breadcrumb">
 161         <a href="../index.html">RGraph: HTML5 canvas graph library</a>
 162         >
 163         <a href="index.html">Documentation</a>
 164         >
 165         Examples of keys
 166     </div>
 167
 168     <h1>RGraph: HTML5 canvas graph library - Examples of keys</h1>
 169
 170     <div style="float: right; display: inline-block; width: 650px">
 171         <canvas id="myLine" width="600" height="250" style="float: right">[No canvas support]</canvas>
 172         <canvas id="myPie" width="450" height="250" style="float: right">[No canvas support]</canvas>
 173     </div>
 174
 175     <p>
 176         As of 4th December 2010 the code that produces the keys has been rewritten. There are two variants of keys available,
 177         a horizontal one designed to sit in the gutter, and a vertical one that is designed to sit on top of (ie over) the graph.
 178     </p>
 179
 180     <p>
 181         The actual positioning is now configurable though, so you could have a horizontal key and position it to sit on top
 182         of the chart.
 183     </p>
 184
 185     <h4>Key properties</h4>
 186
 187     <p>
 188         The available key properties and their defaults are listed below (some graph types have slightly different defaults to
 189         suit):
 190     </p>
 191
 192
 193     <ul>
 194         <li>chart.key (<i>[] (An empty array)</i>)</li>
 195         <li>chart.key.position (<i>graph</i>)</li>
 196         <li>chart.key.position.gutter.boxed (<i>true</i>)</li>
 197         <li>chart.key.position.x (<i>null</i>)</li>
 198         <li>chart.key.position.y (<i>null</i>)</li>
 199         <li>chart.key.shadow (<i>false</i>)</li>
 200         <li>chart.key.shadow.offsetx (<i>2</i>)</li>
 201         <li>chart.key.shadow.offsety (<i>2</i>)</li>
 202         <li>chart.key.shadow.color (<i>#666</i>)</li>
 203         <li>chart.key.shadow.blur (<i>3</i>)</li>
 204         <li>chart.key.color.shape (<i>square</i>)</li>
 205         <li>chart.key.background (<i>white</i>)</li>
 206         <li>chart.key.rounded (<i>true</i>)</li>
 207         <li>chart.key.text.size (<i>10</i>)</li>
 208     </ul>
 209
 210 </body>
 211 </html>