RGraph/docs/meter.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 - meter documentation</title>
  22
  23     <meta name="keywords" content="rgraph html5 canvas docs meter chart" />
  24     <meta name="description" content="RGraph: HTML5 canvas graph software - Documentation about the Meter chart" />
  25
  26     <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
  27     <link rel="icon" type="image/png" href="../images/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         Meter
 133     </div>
 134
 135     <h1>RGraph: HTML5 canvas graph library - Meter 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         This is the Meter chart. Similar to half the Odometer. The difference is purely visual, but may well be more suited to
 145         a control panel type application.
 146     </p>
 147
 148     <p>
 149         The example file is <a href="../examples/meter.html">here</a>.
 150     </p>
 151
 152     <pre class="code">
 153 &lt;script&gt;
 154     window.onload = function ()
 155     {
 156         var meter = new RGraph.Meter('myCanvas', 50, 100, 60);
 157         meter.Set('chart.contextmenu', [
 158                                         ['Show palette', RGraph.Showpalette],
 159                                         ['Clear annotations', function () {RGraph.Clear(meter.canvas); meter.Draw();}],
 160                                         null,
 161                                         ['Cancel', function () {}]
 162                                        ]);
 163         meter.Set('chart.annotatable', true);
 164         meter.Set('chart.label.position', 'inside');
 165         meter.Set('chart.title', 'A sample measurement');
 166         meter.Set('chart.title.vpos', 0.5);
 167         meter.Set('chart.units.post', 'k');
 168         meter.Set('chart.red.start', 0);
 169         meter.Set('chart.red.end', 3);
 170         meterSet('chart.yellow.start', 3);
 171         meter.Set('chart.yellow.end', 6);
 172         meter.Set('chart.green.start', 6);
 173         meter.Set('chart.green.end', 10);
 174         meter.Draw();
 175     }
 176 &lt;/script&gt;
 177 </pre>
 178     <h2>Properties</h2>
 179
 180     <p>
 181         You can use these properties to control how the Meter apears. You can set them by using the Set() method. Eg:
 182     </p>
 183
 184     <p>
 185         <b>myMeter.Set('name', 'value');</b>
 186     </p>
 187
 188     <ul>
 189         <li><a href="#margins">Margins</a></li>
 190         <li><a href="#colors">Colors</a></li>
 191         <li><a href="#labels and text">Labels and text</a></li>
 192         <li><a href="#titles">Titles</a></li>
 193         <li><a href="#scale">Scale</a></li>
 194         <li><a href="#interactive features">Interactive features</a></li>
 195         <li><a href="#shadow">Shadow</a></li>
 196         <li><a href="#zoom">Zoom</a></li>
 197         <li><a href="#miscellaneous">Miscellaneous</a></li>
 198     </ul>
 199
 200
 201 <a name="margins"></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">Margins</h3>            <a name="chart.gutter"></a>
 203 <b>chart.gutter</b><br />
 204             The gutter of the graph. <br /><i>Default: 25</i><br /><br />
 205 <a name="colors"></a>
 206 <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.border.color"></a>
 207 <b>chart.border.color</b><br />
 208             The color of the outline (including tickmarks).<br /><i>Default: black</i><br /><br />
 209             <a name="chart.green.start"></a>
 210 <b>chart.green.start</b><br />
 211             The value that the green area should begin at. <br /><i>Default: 35% of the maximum value</i><br /><br />
 212             <a name="chart.green.end"></a>
 213 <b>chart.green.end</b><br />
 214             The value that the green area should end at. <br /><i>Default: The maximum value</i><br /><br />
 215             <a name="chart.green.color"></a>
 216 <b>chart.green.color</b><br />
 217             The color of the green area, (can be any color).. <br /><i>Default: #207A20</i><br /><br />
 218             <a name="chart.yellow.start"></a>
 219 <b>chart.yellow.start</b><br />
 220             The value that the yellow area should begin at. <br /><i>Default: 10% of the maximum value</i><br /><br />
 221             <a name="chart.yellow.end"></a>
 222 <b>chart.yellow.end</b><br />
 223             The value that the yellow area should end at. <br /><i>Default: 35% of the maximum value</i><br /><br />
 224             <a name="chart.green.color"></a>
 225 <b>chart.green.color</b><br />
 226             The color of the yellow area, (can be any color).. <br /><i>Default: #D0AC41</i><br /><br />
 227             <a name="chart.red.start"></a>
 228 <b>chart.red.start</b><br />
 229             The value that the red area should begin at. <br /><i>Default: The minimum value</i><br /><br />
 230             <a name="chart.red.end"></a>
 231 <b>chart.red.end</b><br />
 232             The value that the red area should end at. <br /><i>Default: 10% of the maximum value</i><br /><br />
 233             <a name="chart.red.color"></a>
 234 <b>chart.red.color</b><br />
 235             The color of the red area, (can be any color).. <br /><i>Default: #9E1E1E</i><br /><br />
 236 <a name="labels and text"></a>
 237 <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.color"></a>
 238 <b>chart.text.color</b><br />
 239             The color of the labels. <br /><i>Default: black</i><br /><br />
 240             <a name="chart.text.size"></a>
 241 <b>chart.text.size</b><br />
 242             The size (in points) of the labels. <br /><i>Default: 10</i><br /><br />
 243             <a name="chart.text.font"></a>
 244 <b>chart.text.font</b><br />
 245             The font used to render the text.<br /><i>Default: Verdana</i><br /><br />
 246 <a name="titles"></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">Titles</h3>            <a name="chart.title"></a>
 248 <b>chart.title</b><br />
 249             The title of the graph, if any. <br /><i>Default: null</i><br /><br />
 250
 251 <a name="chart.title.background"></a>
 252 <b>chart.title.background</b><br />
 253 The background color (if any) for the title.<br />
 254 <i>Default: null</i><br /><br />
 255
 256             <a name="chart.title.color"></a>
 257 <b>chart.title.color</b><br />
 258             The color of the title.<br /> <i>Default: black</i><br /><br />
 259             <a name="chart.title.hpos"></a>
 260 <b>chart.title.hpos</b><br />
 261             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 />
 262             <a name="chart.title.vpos"></a>
 263 <b>chart.title.vpos</b><br />
 264             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 />
 265 <a name="scale"></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">Scale</h3>            <a name="chart.units.pre"></a>
 267 <b>chart.units.pre</b><br />
 268             The units that the labels are measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50".<br /><i>Default: none</i><br /><br />
 269             <a name="chart.units.post"></a>
 270 <b>chart.units.post</b><br />
 271             The units that the labels are measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms".<br /><i>Default: none</i><br /><br />
 272 <a name="interactive features"></a>
 273 <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>
 274 <b>chart.contextmenu</b><br />
 275             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 />
 276             <a name="chart.resizable"></a>
 277 <b>chart.resizable</b><br />
 278             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 />
 279             <a name="chart.annotatable"></a>
 280 <b>chart.annotatable</b><br />
 281             Whether annotations are enabled for the chart (ie you can draw on the chart interactively).<br /><i>Default: false</i><br /><br />
 282             <a name="chart.annotate.color"></a>
 283 <b>chart.annotate.color</b><br />
 284             If you do not allow the use of the palette, then this will be the only color allowed for annotations.<br /><i>Default: black</i><br /><br />
 285 <a name="shadow"></a>
 286 <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"></a>
 287 <b>chart.shadow</b><br />
 288             If true a shadow will be applied to the meter.<br /><i>Default: false</i><br /><br />
 289             <a name="chart.shadow.color"></a>
 290 <b>chart.shadow.color</b><br />
 291             The color of the shadow. <br /><i>Default: rgba(0,0,0,0.5)</i><br /><br />
 292             <a name="chart.shadow.offsetx"></a>
 293 <b>chart.shadow.offsetx</b><br />
 294             The X offset in pixels for the shadow.<br /><i>Default: 3</i><br /><br />
 295             <a name="chart.shadow.offsety"></a>
 296 <b>chart.shadow.offsety</b><br />
 297             The Y offset in pixels for the shadow.<br /><i>Default: 3</i><br /><br />
 298             <a name="chart.shadow.blur"></a>
 299 <b>chart.shadow.blur</b><br />
 300             The severity of the shadow blurring effect.<br /><i>Default: 3</i><br /><br />
 301 <a name="zoom"></a>
 302 <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>
 303 <b>chart.zoom.mode</b><br />
 304             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 />
 305             <a name="chart.zoom.factor"></a>
 306 <b>chart.zoom.factor</b><br />
 307             This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i><br /><br />
 308             <a name="chart.zoom.fade.in"></a>
 309 <b>chart.zoom.fade.in</b><br />
 310             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 />
 311             <a name="chart.zoom.fade.out"></a>
 312 <b>chart.zoom.fade.out</b><br />
 313             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 />
 314             <a name="chart.zoom.hdir"></a>
 315 <b>chart.zoom.hdir</b><br />
 316             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 />
 317             <a name="chart.zoom.vdir"></a>
 318 <b>chart.zoom.vdir</b><br />
 319             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 />
 320             <a name="chart.zoom.delay"></a>
 321 <b>chart.zoom.delay</b><br />
 322             The delay (in milliseconds) between frames.<br /><i>Default: 50</i><br /><br />
 323             <a name="chart.zoom.frames"></a>
 324 <b>chart.zoom.frames</b><br />
 325             The number of frames in the zoom animation.<br /><i>Default: 10</i><br /><br />
 326             <a name="chart.zoom.shadow"></a>
 327 <b>chart.zoom.shadow</b><br />
 328             Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i><br /><br />
 329             <a name="chart.zoom.thumbnail.width"></a>
 330 <b>chart.zoom.thumbnail.width</b><br />
 331             When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
 332             <a name="chart.zoom.thumbnail.height"></a>
 333 <b>chart.zoom.thumbnail.height</b><br />
 334             When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
 335             <a name="chart.zoom.background"></a>
 336 <b>chart.zoom.background</b><br />
 337             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 />
 338 <a name="miscellaneous"></a>
 339 <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.linewidth"></a>
 340 <b>chart.linewidth</b><br />
 341             The width of the outline of the Meter. <br /><i>Default: 2</i><br /><br />
 342 </div><!-- /DOCS --><br /><br />
 343 </body>
 344 </html>