RGraph/docs/bipolar.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 - Bi-polar chart documentation</title>
  22
  23     <meta name="keywords" content="rgraph html5 canvas graph docs bipolar chart" />
  24     <meta name="description" content="RGraph: HTML5 canvas graph software - Documentation about the Bipolar 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         Bi-polar chart
 133     </div>
 134
 135     <h1>RGraph: HTML5 canvas graph library - Bi-polar chart 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         The Bi-polar chart is good for comparing two things side by side. For example sales trends for two separate years, that you
 145         want to compare.
 146     </p>
 147
 148     <p>
 149         The example file is <a href="../examples/bipolar.html">here</a>.
 150     </p>
 151
 152     <pre class="code">
 153 &lt;script&gt;
 154     window.onload = function ()
 155     {
 156         var left  = [5,6,8,9,12,13,4,9];
 157         var right = [5,8,4,11,15,26,13,16];
 158
 159         var bipolar = new RGraph.Bipolar('myBipolar', left, right);
 160         bipolar.Set('chart.colors', ['#fff', '#eef', '#ddf', '#ccf', '#bbf', '#bbf', '#aaf', '#99f']);
 161         bipolar.Set('chart.margin', 3);
 162         bipolar.Set('chart.labels', ['Barry', 'John', 'Fred', 'George', 'Rich', 'Larry', 'John', 'Mike']);
 163         bipolar.Set('chart.title.left', '2007');
 164         bipolar.Set('chart.title.right', '2008');
 165         bipolar.Set('chart.gutter', 35);
 166         bipolar.Draw();
 167     }
 168 &lt;/script&gt;
 169 </pre>
 170
 171
 172     <h2>Properties</h2>
 173
 174     <p>
 175         You can use these properties to control how the chart apears. You can set them by using the Set() method. Eg:
 176     </p>
 177
 178     <p>
 179         <b>myBipolar.Set('name', 'value');</b>
 180     </p>
 181
 182     <ul>
 183         <li><a href="#margins">Margins</a></li>
 184         <li><a href="#titles">Titles</a></li>
 185         <li><a href="#colors">Colors</a></li>
 186         <li><a href="#labels, text and axes">Labels, text and axes</a></li>
 187         <li><a href="#scale">Scale</a></li>
 188         <li><a href="#interactive features">Interactive features</a></li>
 189         <li><a href="#shadow">Shadow</a></li>
 190         <li><a href="#zoom">Zoom</a></li>
 191     </ul>
 192
 193
 194
 195 <a name="margins"></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">Margins</h3>            <a name="chart.gutter"></a>
 197 <b>chart.gutter</b><br />
 198             The space given over to the labels. <br /><i>Default: 25</i><br /><br />
 199             <a name="chart.margin"></a>
 200 <b>chart.margin</b><br />
 201             The space above and below each bar. <br /><i>Default: 2</i><br /><br />
 202 <a name="titles"></a>
 203 <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>
 204
 205 <b>chart.title</b><br />
 206 The main title of the chart.<br />
 207 <i>Default: (An empty string)</i><br /><br />
 208
 209 <a name="chart.title.background"></a>
 210 <b>chart.title.background</b><br />
 211 The background color (if any) for the title.<br />
 212 <i>Default: null</i><br /><br />
 213
 214 <a name="chart.title.hpos"></a>
 215 <b>chart.title.hpos</b><br />
 216             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 />
 217             <a name="chart.title.vpos"></a>
 218 <b>chart.title.vpos</b><br />
 219             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 />
 220             <a name="chart.title.color"></a>
 221 <b>chart.title.color</b><br />
 222             The color of the title.<br /> <i>Default: black</i><br /><br />
 223             <a name="chart.title"></a>
 224             <a name="chart.title.left"></a>
 225 <b>chart.title.left</b><br />
 226             The left title. <br /><i>Default: An empty string</i><br /><br />
 227             <a name="chart.title.right"></a>
 228 <b>chart.title.right</b><br />
 229             The right title. <br /><i>Default: An empty string</i><br /><br />
 230 <a name="colors"></a>
 231
 232 <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>
 233
 234     <a name="chart.colors"></a>
 235     <b>chart.colors</b><br />
 236     An array of colors. These too can be gradients that you make if you wish. <br />
 237     <i>Default: ['#fcf', '#00f', '#f00', '#0f0', '#ff0', '#0ff', '#f0f', '#ff6101', '#b401ff', '#e4ff01', '#fb8195', '#ccc']</i><br /><br />
 238
 239     <a name="chart.strokestyle"></a>
 240     <b>chart.strokestyle</b><br />
 241     This is the color used as the stroke style. If you didn't want it, you could set this to <i>rgba(0,0,0,0)</i><br />
 242     <i>Default: #333</i><br /><br />
 243
 244 <a name="labels, text and axes"></a>
 245 <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, text and axes</h3>            <a name="chart.xtickinterval"></a>
 246 <b>chart.xtickinterval</b><br />
 247             The X tick mark interval. <br /><i>Default: null</i><br /><br />
 248             <a name="chart.axis.color"></a>
 249 <b>chart.axis.color</b><br />
 250             The color of the axes. <br /><i>Default: black</i><br /><br />
 251             <a name="chart.xmax"></a>
 252 <b>chart.xmax</b><br />
 253             This allows you to set the maximum X value that the chart uses, instead of it being auto-generated.<br><i>Default: null</i></br><br /><br />
 254             <a name="chart.scale.decimals"></a>
 255 <b>chart.scale.decimals</b><br />
 256             This allows you to set the precision of the X labels.<br /><i>Default: null</i><br /><br />
 257             <a name="chart.scale.point"></a>
 258 <b>chart.scale.point</b><br />
 259             The character used as the decimal point.<br /><i>Default: .</i><br /><br />
 260             <a name="chart.scale.thousand"></a>
 261 <b>chart.scale.thousand</b><br />
 262             The character used as the thousand separator<br /><i>Default: ,</i><br /><br />
 263             <a name="chart.labels"></a>
 264 <b>chart.labels</b><br />
 265             An array of the graphs labels (they go in the middle). <br /><i>Default: null</i><br /><br />
 266             <a name="chart.text.size"></a>
 267 <b>chart.text.size</b><br />
 268             The size of the text used (in points). <br /><i>Default: 10</i><br /><br />
 269             <a name="chart.text.font"></a>
 270 <b>chart.text.font</b><br />
 271             The font used to render the text.<br /><i>Default: Verdana</i><br /><br />
 272             <a name="chart.text.color"></a>
 273 <b>chart.text.color</b><br />
 274             The color of the labels. <br /><i>Default: black</i><br /><br />
 275 <a name="scale"></a>
 276 <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>
 277
 278
 279             <a name="chart.scale.round"></a>
 280             <b>chart.scale.round</b><br />
 281             Whether to round the maximum scale value up or not. This will produce slightly better scales in some instances.<br />
 282             <i>Default: null</i><br /><br />
 283
 284 <b>chart.units.pre</b><br />
 285             The units that are applied to the X axis labels (these are pre-pended to the number).<br /><i>Default: none</i><br /><br />
 286             <a name="chart.units.post"></a>
 287 <b>chart.units.post</b><br />
 288             The units that are applied to the X axis labels (these are appended to the number).<br /><i>Default: none</i><br /><br />
 289 <a name="interactive features"></a>
 290 <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.tooltips"></a>
 291 <b>chart.tooltips</b><br />
 292             A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.<br /><i>Default: An empty array</i><br /><br />
 293             <a name="chart.tooltips.effect"></a>
 294 <b>chart.tooltips.effect</b><br />
 295             The animated effect used for showing tooltips. Can be either <i>fade</i> or <i>expand</i>.<br /><i>Default: fade</i><br /><br />
 296             <a name="chart.tooltips.css.class"></a>
 297 <b>chart.tooltips.css.class</b><br />
 298             This is the name of the CSS class the graph uses.<br /><i>Default: RGraph_tooltip</i><br /><br />
 299             <a name="chart.tooltips.override"></a>
 300 <b>chart.tooltips.override</b><br />
 301             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 />
 302             <a name="chart.contextmenu"></a>
 303 <b>chart.contextmenu</b><br />
 304             An array of context menu items. Cannot be used in conjunction with tooltips.<br /><i>Default: [] (An empty array)</i><br /><br />
 305             <a name="chart.annotatable"></a>
 306 <b>chart.annotatable</b><br />
 307             Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i><br /><br />
 308             <a name="chart.annotate.color"></a>
 309 <b>chart.annotate.color</b><br />
 310             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 />
 311             <a name="chart.resizable"></a>
 312 <b>chart.resizable</b><br />
 313             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 />
 314 <a name="shadow"></a>
 315 <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>
 316 <b>chart.shadow</b><br />
 317             Turns the shadow on or off.<br /> <i>Default: false</i><br /><br />
 318             <a name="chart.shadow.color"></a>
 319 <b>chart.shadow.color</b><br />
 320             The color of the shadow.<br /> <i>Default: #666</i><br /><br />
 321             <a name="chart.shadow.offsetx"></a>
 322 <b>chart.shadow.offsetx</b><br />
 323             The horizontal offset of the shadow.<br /> <i>Default: 3</i><br /><br />
 324             <a name="chart.shadow.offsety"></a>
 325 <b>chart.shadow.offsety</b><br />
 326             The vertical offset of the shadow. <br /> <i>Default: 3</i><br /><br />
 327             <a name="chart.shadow.blur"></a>
 328 <b>chart.shadow.blur</b><br />
 329             How severe the blurring effect is for the shadow.<br /> <i>Default: 3</i><br /><br />
 330 <a name="zoom"></a>
 331 <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>
 332 <b>chart.zoom.mode</b><br />
 333             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 />
 334             <a name="chart.zoom.factor"></a>
 335 <b>chart.zoom.factor</b><br />
 336             This is the factor that the graph will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i><br /><br />
 337             <a name="chart.zoom.fade.in"></a>
 338 <b>chart.zoom.fade.in</b><br />
 339             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 />
 340             <a name="chart.zoom.fade.out"></a>
 341 <b>chart.zoom.fade.out</b><br />
 342             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 />
 343             <a name="chart.zoom.hdir"></a>
 344 <b>chart.zoom.hdir</b><br />
 345             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 />
 346             <a name="chart.zoom.vdir"></a>
 347 <b>chart.zoom.vdir</b><br />
 348             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 />
 349             <a name="chart.zoom.delay"></a>
 350 <b>chart.zoom.delay</b><br />
 351             The delay (in milliseconds) between frames.<br /><i>Default: 50</i><br /><br />
 352             <a name="chart.zoom.frames"></a>
 353 <b>chart.zoom.frames</b><br />
 354             The number of frames in the zoom animation.<br /><i>Default: 10</i><br /><br />
 355             <a name="chart.zoom.shadow"></a>
 356 <b>chart.zoom.shadow</b><br />
 357             Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i><br /><br />
 358             <a name="chart.zoom.thumbnail.width"></a>
 359 <b>chart.zoom.thumbnail.width</b><br />
 360             When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
 361             <a name="chart.zoom.thumbnail.height"></a>
 362 <b>chart.zoom.thumbnail.height</b><br />
 363             When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
 364             <a name="chart.zoom.background"></a>
 365 <b>chart.zoom.background</b><br />
 366             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 />
 367 </div><!-- /DOCS --><br /><br />
 368
 369 </body>
 370 </html>