1 <?php ob_start('ob_gzhandler') ?>
5 <meta http-equiv="X-UA-Compatible" content="chrome=1">
8 * o------------------------------------------------------------------------------o
9 * | This file is part of the RGraph package - you can learn more at: |
11 * | http://www.rgraph.net |
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: |
17 * | http://www.rgraph.net/LICENSE.txt |
18 * o------------------------------------------------------------------------------o
21 <title>RGraph: HTML5 canvas graph library - Annotating your graphs</title>
23 <meta name="keywords" content="rgraph html5 canvas graph docs animating" />
24 <meta name="description" content="RGraph: HTML5 canvas graph software - Documentation about annotating your charts" />
26 <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
27 <link rel="icon" type="image/png" href="../images/favicon.png">
29 <script src="../libraries/RGraph.common.core.js" ></script>
30 <script src="../libraries/RGraph.common.annotate.js" ></script>
31 <script src="../libraries/RGraph.common.context.js" ></script>
32 <script src="../libraries/RGraph.common.zoom.js" ></script>
33 <script src="../libraries/RGraph.bar.js" ></script>
34 <!--[if IE 8]><script src="../excanvas/excanvas.compressed.js"></script><![endif]-->
37 window.onload = function ()
39 bar = new RGraph.Bar('myBar', [[45,64],[32,51],[41,52],[54,43],[43,50]]);
40 bar.Set('chart.title', 'An annotatable graph with context menu');
41 bar.Set('chart.labels', ['John','Fred', 'Barry', 'Charlie', 'Joan']);
42 bar.Set('chart.colors', ['red', 'blue']);
43 bar.Set('chart.background.barcolor1', '#fff');
44 bar.Set('chart.background.barcolor2', '#fff');
45 bar.Set('chart.annotatable', true);
46 bar.Set('chart.contextmenu', [['Show palette', RGraph.Showpalette], ['Clear', function () {RGraph.Clear(bar.canvas); bar.Draw();}]]);
49 RGraph.AddCustomEventListener(bar, 'onannotatestart', function (obj) {cl('Started annotating: ' + obj.id);});
50 RGraph.AddCustomEventListener(bar, 'onannotate', function (obj) {cl('Annotating: ' + obj.id);});
51 RGraph.AddCustomEventListener(bar, 'onannotateend', function (obj) {cl('Finished annotating: ' + obj.id);});
57 <!-- Social networking buttons -->
58 <script src="../libraries/RGraph.common.core.js" ></script>
61 function HideTwitterDIV ()
63 document.getElementById("twitter_div").style.opacity = 0;
64 document.getElementById("twitter_div").style.display = 'none';
68 function ShowTwitterDIV (e)
70 var e = RGraph.FixEventObject(document.all ? event : e);
71 var div = document.getElementById("twitter_div");
72 var img = document.getElementById("twitter_icon");
74 div.style.display = 'block';
75 div.style.left = (RGraph.getCanvasXY(img)[0] + img.offsetWidth - div.offsetWidth + 110) + 'px';
76 div.style.top = (RGraph.getCanvasXY(img)[1] - 1) + 'px';
81 setTimeout('document.getElementById("twitter_div").style.opacity = 0.2;', 25);
82 setTimeout('document.getElementById("twitter_div").style.opacity = 0.4;', 50);
83 setTimeout('document.getElementById("twitter_div").style.opacity = 0.6;', 100);
84 setTimeout('document.getElementById("twitter_div").style.opacity = 0.8;', 125);
85 setTimeout('document.getElementById("twitter_div").style.opacity = 1.0;', 150);
93 * This code installs the event handler that hides the Twitter DIV
96 window.attachEvent('onload', function () {document.body.attachEvent('onclick', HideTwitterDIV);});
98 window.addEventListener('click', HideTwitterDIV, false);
102 <!-- The twitter DIV -->
103 <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;">
104 <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 about RGraph</a><br>
105 <a href="http://twitter.com/_rgraph" style="text-decoration: none" rel="nofollow" target="_blank">Follow for HTML5 news</a>
108 <div id="social_icons" class="warning" style="top: 0; left: 5px; position: absolute">
111 if (navigator.userAgent.indexOf('Opera') == -1) {
112 document.getElementById("social_icons").style.position = 'fixed';
113 document.getElementById("twitter_div").style.position = 'fixed';
118 <b style="display: inline-block; position: relative; top: 1px">Bookmark and share:</b>
122 <a title="Bookmark with delicious" href="http://delicious.com/save?jump=close&v=4&noui&jump=close&url=http://www.rgraph.net¬es=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">
123 <img src="../images/delicious.png" alt="Bookmark with delicious" width="22" height="22" border="0" align="absmiddle" />
126 <a href="" target="_blank" onmouseover="if (document.getElementById('twitter_div').style.display == 'none') ShowTwitterDIV(event);" onclick="event.stopPropagation(); event.cancelBubble = true; return false">
127 <img src="../images/twitter.png" id="twitter_icon" alt="tweet this site" width="22" height="22" border="0" align="absmiddle" />
132 <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">
133 <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"/>
137 <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">
138 <img src="../images/facebook.png" width="22" height="22" alt="Post to Facebook" align="absmiddle" style="position: relative; top: -2px; border: 0" border="0"/>
141 <a href="mailto:share@friendfeed.com" title="Share on FriendFeed">
142 <img src="../images/friendfeed.png" width="22" height="22" alt="Share on FriendFeed" border="0" align="absmiddle" />
145 <a href="http://www.stumbleupon.com/submit?url=http://www.rgraph.net" target="_blank" title="Share on StumbleUpon" >
146 <img src="../images/stumble.png" alt="Stumble! this site" width="22" height="22" border="0" align="absmiddle" />
151 <!-- /Social networking buttons -->
153 <div id="breadcrumb">
154 <a href="../index.html">RGraph: HTML5 canvas graph library</a>
156 <a href="index.html">Documentation</a>
158 Annotating your graphs
161 <h1>RGraph: HTML5 canvas graph library - Annotating your graphs</h1>
164 if (RGraph.isIE8()) {
165 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>');
169 <div style="float: right">
170 <canvas id="myBar" width="400" height="200">[No canvas support]</canvas><br />
174 The annotations feature brings presentation style functionality to RGraph graphs. You can use this feature
175 for highlighting your graphs if you need to.
179 <li><a href="#how">How do annotations work?</a></li>
180 <li><a href="#browser">Browser support</a></li>
181 <li><a href="#what">What can I use annotations for?</a></li>
182 <li><a href="#persistent">Are annotations persistent?</a></li>
183 <li><a href="#palette">How do I show the mini-palette?</a></li>
184 <li><a href="#clear">How can I clear the annotations?</a></li>
185 <li><a href="#replay">Replaying annotations when they're off</a></li>
189 <h4>How do annotations work?</h4>
192 Enabling annotations is a very simple affair, and consists of doing the following:
195 <pre class="code" style="width: 55%">myGraph.Set('chart.annotatable', true);</pre>
197 <a name="browser"></a>
198 <h4>Browser support</h4>
201 Annotations are supported in all browsers that RGraph works with - Firefox 3.5+, Chrome 2+, Safari 4+, Opera 10.5+ and
202 MSIE/Google Chrome Frame. They DO NOT however work with MSIE 8/ExCanvas.
206 <h4>What can I use annotations for?</h4>
209 As mentioned you can use it for presentations, highlighting things to yourself or others or just to have fun drawing (!).
212 <a name="persistent"></a>
213 <h4>Are annotations persistent?</h4>
216 That depends on which browser you're using. The annotation data is stored in the users web browser (not on the web server),
217 meaning currently (21st March 2010) browser support is limited to Firefox 3.5+, Safari 4+,
218 Chrome 4+ and Opera 10.5+. MSIE 8 also has the required storage capabilities, but since it doesn't yet support canvas, the point is moot.
219 The user does not have to
220 confirm anything for storage to be allowed - try it out on this page by drawing on the graph and then refreshing the page.
223 <a name="palette"></a>
224 <h4>How do I show the mini-palette?</h4>
228 You can show the palette by using the <i>RGraph.Showpalette</i> function shown below as a context menu item:
232 myObj.Set('chart.contextmenu', [
233 ['Show palette', RGraph.Showpalette],
234 ['Clear', function () {RGraph.Clear(myObj.canvas); myObj.Draw();}]
239 This code will result in the same context menu as the graph above.
243 <h4>How can I clear the annotations?</h4>
245 You can simply clear the graph and redraw it:
247 <pre class="code">RGraph.Clear(myGraph.canvas); // Clear the graph
248 myGraph.Draw(); // Redraw it</pre>
251 In the graph above, there is a context menu that allows you to both clear the graph and also demonstrates the mini-palette
252 feature available to you.
255 <a name="replay"></a>
256 <h4>Replaying annotations when they're off</h4>
259 When annotations are not enabled, any prior annotations that may have been made are not displayed. To show them you need
260 to use the API function <i>RGraph.ReplayAnnotations(object)</i> after the call to .Draw().