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 - Odometer documentation</title>
23 <meta name="keywords" content="rgraph html5 canvas docs odometer chart" />
24 <meta name="description" content="RGraph: HTML5 canvas graph software - Documentation about the Odometer chart" />
26 <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
27 <link rel="icon" type="image/png" href="/favicon.png">
29 <script src="../libraries/RGraph.common.core.js" ></script>
33 <!-- Social networking buttons -->
34 <script src="../libraries/RGraph.common.core.js" ></script>
37 function HideTwitterDIV ()
39 document.getElementById("twitter_div").style.opacity = 0;
40 document.getElementById("twitter_div").style.display = 'none';
44 function ShowTwitterDIV (e)
46 var e = RGraph.FixEventObject(document.all ? event : e);
47 var div = document.getElementById("twitter_div");
48 var img = document.getElementById("twitter_icon");
50 div.style.display = 'block';
51 div.style.left = (RGraph.getCanvasXY(img)[0] + img.offsetWidth - div.offsetWidth + 110) + 'px';
52 div.style.top = (RGraph.getCanvasXY(img)[1] - 1) + 'px';
57 setTimeout('document.getElementById("twitter_div").style.opacity = 0.2;', 25);
58 setTimeout('document.getElementById("twitter_div").style.opacity = 0.4;', 50);
59 setTimeout('document.getElementById("twitter_div").style.opacity = 0.6;', 100);
60 setTimeout('document.getElementById("twitter_div").style.opacity = 0.8;', 125);
61 setTimeout('document.getElementById("twitter_div").style.opacity = 1.0;', 150);
69 * This code installs the event handler that hides the Twitter DIV
72 window.attachEvent('onload', function () {document.body.attachEvent('onclick', HideTwitterDIV);});
74 window.addEventListener('click', HideTwitterDIV, false);
78 <!-- The twitter DIV -->
79 <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;">
80 <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>
81 <a href="http://twitter.com/_rgraph" style="text-decoration: none" rel="nofollow" target="_blank">Follow for HTML5 news</a>
84 <div id="social_icons" class="warning" style="top: 0; left: 5px; position: absolute">
87 if (navigator.userAgent.indexOf('Opera') == -1) {
88 document.getElementById("social_icons").style.position = 'fixed';
89 document.getElementById("twitter_div").style.position = 'fixed';
94 <b style="display: inline-block; position: relative; top: 1px">Bookmark and share:</b>
98 <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">
99 <img src="../images/delicious.png" alt="Bookmark with delicious" width="22" height="22" border="0" align="absmiddle" />
102 <a href="" target="_blank" onmouseover="if (document.getElementById('twitter_div').style.display == 'none') ShowTwitterDIV(event);" onclick="event.stopPropagation(); event.cancelBubble = true; return false">
103 <img src="../images/twitter.png" id="twitter_icon" alt="tweet this site" width="22" height="22" border="0" align="absmiddle" />
108 <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">
109 <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"/>
113 <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">
114 <img src="../images/facebook.png" width="22" height="22" alt="Post to Facebook" align="absmiddle" style="position: relative; top: -2px; border: 0" border="0"/>
117 <a href="mailto:share@friendfeed.com" title="Share on FriendFeed">
118 <img src="../images/friendfeed.png" width="22" height="22" alt="Share on FriendFeed" border="0" align="absmiddle" />
121 <a href="http://www.stumbleupon.com/submit?url=http://www.rgraph.net" target="_blank" title="Share on StumbleUpon" >
122 <img src="../images/stumble.png" alt="Stumble! this site" width="22" height="22" border="0" align="absmiddle" />
127 <!-- /Social networking buttons -->
129 <div id="breadcrumb">
130 <a href="../index.html">RGraph: HTML5 canvas graph library</a>
132 <a href="index.html">Documentation</a>
137 <h1>RGraph: HTML5 canvas graph library - Odometer documentation</h1>
140 if (RGraph.isIE8()) {
141 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>');
146 The example file is <a href="../examples/odo.html">here</a>.
151 window.onload = function ()
153 // ID, MINIMUM, MAXIMUM, INDICATED VALUE
154 var odo = new RGraph.Odometer('myOdo', 0, 100, 18);
156 odo.Set('chart.green.max', 75);
157 odo.Set('chart.red.min', 90);
158 odo.Set('chart.label.area', 50);
159 odo.Set('chart.needle.thickness', 2);
167 <div class="warning">
169 As of 20th March 2010, how you specify the start and end values has changed. The chart.green.start, chart.green.end, chart.yellow.start,
170 chart.yellow.end, chart.red.start and chart.red.end have all been replaced by chart.green.max and chart.red.min. Now the
171 green area always starts at zero and goes to chart.green.max, and the red area starts (by default - you can customise this by using
172 chart.red.min) at 90% of the maximum value and goes to the maximum value. The yellow area is between the two.
179 You can use these properties to control how the bar graph apears. You can set these properties using the <b>Set()</b> method.
183 <li><a href="#chart configuration">Chart configuration</a></li>
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="#needle">Needle</a></li>
188 <li><a href="#title">Title</a></li>
189 <li><a href="#shadow">Shadow</a></li>
190 <li><a href="#interactive features">Interactive features</a></li>
191 <li><a href="#zoom">Zoom</a></li><li><a href="#scale">Scale</a></li>
195 <a name="chart configuration"></a>
196 <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">Chart configuration</h3> <a name="chart.value.text"></a>
197 <b>chart.value.text</b><br />
198 Controls whether the value is indicated as a text label in the center of the dial.<br /><i>Default: false</i><br /><br />
199 <a name="chart.value.units.pre"></a>
200 <b>chart.value.units.pre</b><br />
201 The pre units used on the textual value.<br /><i>Default: nothing (An empty string)</i><br /><br />
202 <a name="chart.value.units.post"></a>
203 <b>chart.value.units.post</b><br />
204 The post units used on the textual value.<br /><i>Default: nothing (An empty string)</i><br /><br />
205 <a name="chart.border"></a>
206 <b>chart.border</b><br />
207 This controls the gray border of the Odometer.<br /><i>Default: false</i><br /><br />
208 <a name="chart.tickmarks.highlighted"></a>
209 <b>chart.tickmarks.highlighted</b><br />
210 This controls whether the tickmarks are highlighted in red/yellow/green.<br /><i>Default: false</i><br /><br />
211 <a name="chart.zerostart"></a>
212 <b>chart.zerostart</b><br />
213 If you want the top value on your chart to be zero instead of the maximum value, set this to true.<br /><i>Default: false</i><br /><br />
214 <a name="margins"></a>
215 <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>
216 <b>chart.gutter</b><br />
217 The width of the area outside the odometer. <br /><i>Default: 25</i><br /><br />
218 <a name="colors"></a>
219 <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.green.max"></a>
220 <b>chart.green.max</b><br />
221 This is the point at which the green area ends.<br /><i>Default: 75% of the maximum value</i><br /><br />
222 <a name="chart.red.min"></a>
223 <b>chart.red.min</b><br />
224 This is the point at which the red area starts. The yellow area is between the green and red areas.<br /> <i>Default: 90% of the maximum value</i><br /><br />
225 <a name="labels and text"></a>
226 <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>
227 <b>chart.labels</b><br />
228 Instead of using computed numbers, which uses the maximum value, you can specify the Odometer to use textual labels instead, with this option.<br /> <i>Default: null</i><br /><br />
229 <a name="chart.label.area"></a>
230 <b>chart.label.area</b><br />
231 The width of the area that labels are put in. <br /><i>Default: 35</i><br /><br />
232 <a name="chart.text.size"></a>
233 <b>chart.text.size</b><br />
234 The size of the text (in points). <br /><i>Default: 10</i><br /><br />
235 <a name="chart.text.font"></a>
236 <b>chart.text.font</b><br />
237 The font used to render the text.<br /><i>Default: Verdana</i><br /><br />
238 <a name="chart.text.color"></a>
239 <b>chart.text.color</b><br />
240 The color of the labels. <br /><i>Default: black</i><br /><br />
241 <a name="needle"></a>
242 <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">Needle</h3> <a name="chart.needle.width"></a>
243 <b>chart.needle.width</b><br />
244 How thick the needle is. <br /><i>Default: 2</i><br /><br />
245 <a name="chart.needle.color"></a>
246 <b>chart.needle.color</b><br />
247 The color that is applied to the needle. <br /><i>Default: black</i><br /><br />
248 <a name="chart.needle.head"></a>
249 <b>chart.needle.head</b><br />
250 This controls whether the arrow head on the end of the needle is displayed. <br /><i>Default: true</i><br /><br />
251 <a name="chart.needle.type"></a>
252 <b>chart.needle.type</b><br />
253 This determines which type of needle is used. It can be <i>pointer</i> or <i>triangle</i>. <br /><i>Default: pointer</i><br /><br />
254 <a name="chart.needle.extra"></a>
255 <b>chart.needle.extra</b><br />
256 With this you can specify a number of extra pointers that will be drawn on the Odometer. An example would be a meter that's used to show upload and download data. An example use:<pre class="code">odo.Set('chart.needle.extra', [[16, 'red'], [24, 'blue']]);</pre><br /><i>Default: [] (An empty array)</i><br /><br />
258 <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>
259 <b>chart.title</b><br />
260 The title text. <br /><i>Default: no title set</i><br /><br />
262 <a name="chart.title.background"></a>
263 <b>chart.title.background</b><br />
264 The background color (if any) for the title.<br />
265 <i>Default: null</i><br /><br />
267 <a name="chart.title.color"></a>
268 <b>chart.title.color</b><br />
269 The color of the title.<br /> <i>Default: black</i><br /><br />
270 <a name="chart.title.hpos"></a>
271 <b>chart.title.hpos</b><br />
272 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 />
273 <a name="chart.title.vpos"></a>
274 <b>chart.title.vpos</b><br />
275 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 />
276 <a name="shadow"></a>
277 <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">Shadow</h3> <a name="chart.shadow.inner"></a>
278 <b>chart.shadow.inner</b><br />
279 Whether a drop shadow is applied to the inner circle of the Odometer<br /><i>Default: false</i><br /><br />
280 <a name="chart.shadow.outer"></a>
281 <b>chart.shadow.outer</b><br />
282 Whether a drop shadow is applied to the whole Odometer.<br /><i>Default: false</i><br /><br />
283 <a name="interactive features"></a>
284 <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>
285 <b>chart.contextmenu</b><br />
286 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 />
287 <a name="chart.annotatable"></a>
288 <b>chart.annotatable</b><br />
289 Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i><br /><br />
290 <a name="chart.annotate.color"></a>
291 <b>chart.annotate.color</b><br />
292 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 />
293 <a name="chart.resizable"></a>
294 <b>chart.resizable</b><br />
295 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 />
297 <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>
298 <b>chart.zoom.mode</b><br />
299 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 />
300 <a name="chart.zoom.factor"></a>
301 <b>chart.zoom.factor</b><br />
302 This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i><br /><br />
303 <a name="chart.zoom.fade.in"></a>
304 <b>chart.zoom.fade.in</b><br />
305 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 />
306 <a name="chart.zoom.fade.out"></a>
307 <b>chart.zoom.fade.out</b><br />
308 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 />
309 <a name="chart.zoom.hdir"></a>
310 <b>chart.zoom.hdir</b><br />
311 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 />
312 <a name="chart.zoom.vdir"></a>
313 <b>chart.zoom.vdir</b><br />
314 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 />
315 <a name="chart.zoom.delay"></a>
316 <b>chart.zoom.delay</b><br />
317 The delay (in milliseconds) between frames.<br /><i>Default: 50</i><br /><br />
318 <a name="chart.zoom.frames"></a>
319 <b>chart.zoom.frames</b><br />
320 The number of frames in the zoom animation.<br /><i>Default: 10</i><br /><br />
321 <a name="chart.zoom.shadow"></a>
322 <b>chart.zoom.shadow</b><br />
323 Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i><br /><br />
324 <a name="chart.zoom.thumbnail.width"></a>
325 <b>chart.zoom.thumbnail.width</b><br />
326 When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
327 <a name="chart.zoom.thumbnail.height"></a>
328 <b>chart.zoom.thumbnail.height</b><br />
329 When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
330 <a name="chart.zoom.background"></a>
331 <b>chart.zoom.background</b><br />
332 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 />
334 <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>
335 <b>chart.units.pre</b><br />
336 The units that the value is measured in. This string is displayed BEFORE the actual value, allowing you to specify values such as "$50".<br /><i>Default: none</i><br /><br />
337 <a name="chart.units.post"></a>
338 <b>chart.units.post</b><br />
339 The units that the value is measured in. This string is displayed AFTER the actual value, allowing you to specify values such as "50ms".<br /><i>Default: none</i><br /><br />
340 <a name="chart.scale.decimals"></a>
341 <b>chart.scale.decimals</b><br />
342 The number of decimal places to display for the labels.<br /><i>Default: 0</i><br /><br />
343 </div><!-- /DOCS --><br /><br />