source: Dev/branches/jQueryUI/client/RGraph/docs/bipolar.html @ 249

Last change on this file since 249 was 249, checked in by hendrikvanantwerpen, 13 years ago

This one's for Subversion, because it's so close...

First widget (stripped down sequencer).
Seperated client and server code in two direcotry trees.

File size: 20.2 KB
Line 
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: Javascript charts and graph library - Bi-polar charts documentation</title>
22   
23    <meta name="keywords" content="rgraph html5 canvas chart docs bipolar charts" />
24    <meta name="description" content="RGraph: Javascript charts and graph library - Documentation about Bipolar charts" />
25   
26    <meta property="og:title" content="RGraph: Javascript charts and graph library" />
27    <meta property="og:description" content="A chart library based on the HTML5 canvas tag" />
28    <meta property="og:image" content="http://www.rgraph.net/images/logo.png"/>
29
30    <link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
31    <link rel="icon" type="image/png" href="../images/favicon.png">
32
33
34    <script>
35      var _gaq = _gaq || [];
36      _gaq.push(['_setAccount', 'UA-54706-2']);
37      _gaq.push(['_trackPageview']);
38   
39      (function() {
40        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
41        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
42        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
43      })();
44    </script>
45</head>
46<body>
47
48   
49    <!-- Social networking buttons -->
50        <div id="social_icons" class="warning" style="border-radius: 10px; top: 1px; position: fixed">
51            <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%20javascript%20charts%20library%20supporting%20a%20wide%20range%20of%20different%20charts%20types&title=RGraph:Javascript%20charts%20and%20graphs%20library" target="_blank"><img src="../images/delicious.png" alt="Bookmark with delicious" width="22" height="22" border="0" align="absmiddle" /></a>
52            <a href="http://twitter.com/home/?status=RGraph%3A%20Javascript+charts+and+graph+library+http%3A%2F%2Fwww.rgraph.net+%23rgraph+%23html5+%23canvas+%23javascript+%23charts+@_rgraph" target="_blank"><img src="../images/twitter.png" id="twitter_icon" alt="tweet this site" width="22" height="22" border="0" align="absmiddle" /></a>
53        </div>
54
55        <script>
56            // Opera fix
57            if (navigator.userAgent.indexOf('Opera') == -1) {
58              document.getElementById("social_icons").style.position = 'fixed';
59            }
60        </script>
61    <!-- Social networking buttons -->
62
63    <div id="breadcrumb">
64        <a href="../index.html">RGraph: Javascript charts and graph library</a>
65        >
66        <a href="index.html">Documentation</a>
67        >
68        Bi-polar charts
69    </div>
70
71    <h1>RGraph: <span>Javascript charts and graph library</span> - Bi-polar charts documentation</h1>
72
73    <script>
74        if (RGraph.isIE8()) {
75            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 charts, 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://support.rgraph.net/message/rgraph-in-internet-explorer-9.html" target="_blank">here</a> to see some screenshots.</div>');
76        }
77    </script>
78
79    <p>
80        Bi-polar charts are good for comparing two sets of data side by side. For example sales trends for two separate years, that you
81        want to compare.
82    </p>
83   
84    <p>
85        The example file is <a href="../examples/bipolar.html">here</a>.
86    </p>
87   
88    <pre class="code">
89&lt;script&gt;
90    window.onload = function ()
91    {
92        var left  = [5,6,8,9,12,13,4,9];
93        var right = [5,8,4,11,15,26,13,16];
94   
95        var bipolar = new RGraph.Bipolar('myBipolar', left, right);
96        bipolar.Set('chart.colors', ['#fff', '#eef', '#ddf', '#ccf', '#bbf', '#bbf', '#aaf', '#99f']);
97        bipolar.Set('chart.margin', 3);
98        bipolar.Set('chart.labels', ['Barry', 'John', 'Fred', 'George', 'Rich', 'Larry', 'John', 'Mike']);
99        bipolar.Set('chart.title.left', '2007');
100        bipolar.Set('chart.title.right', '2008');
101        bipolar.Set('chart.gutter.bottom', 45);
102        bipolar.Draw();
103    }
104&lt;/script&gt;
105</pre>
106
107
108    <h2>Properties</h2>
109   
110    <p>
111        You can use these properties to control how the chart apears. You can set them by using the Set() method. Eg:
112    </p>
113   
114    <p>
115        <b>myBipolar.Set('name', 'value');</b>
116    </p>
117   
118    <ul>
119        <li><a href="#margins">Margins</a></li>
120        <li><a href="#titles">Titles</a></li>
121        <li><a href="#colors">Colors</a></li>
122        <li><a href="#labels, text and axes">Labels, text and axes</a></li>
123        <li><a href="#scale">Scale</a></li>
124        <li><a href="#interactive features">Interactive features</a></li>
125        <li><a href="#shadow">Shadow</a></li>
126        <li><a href="#zoom">Zoom</a></li>
127        <li><a href="#miscellaneous">Miscellaneous</a></li>
128    </ul>
129
130<a name="margins"></a>
131<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>
132
133
134
135            <a name="chart.gutter.left"></a>
136            <b>chart.gutter.left</b><br />
137            The left gutter of the chart, (the gutter is where the labels and title are)).<br />
138            <i>Default: 25</i><br /><br />
139
140            <a name="chart.gutter.right"></a>
141            <b>chart.gutter.right</b><br />
142            The right gutter of the chart, (the gutter is where the labels and title are).<br />
143            <i>Default: 25</i><br /><br />
144
145            <a name="chart.gutter.top"></a>
146            <b>chart.gutter.top</b><br />
147            The top gutter of the chart, (the gutter is where the labels and title are).<br />
148            <i>Default: 25</i><br /><br />
149
150            <a name="chart.gutter.bottom"></a>
151            <b>chart.gutter.bottom</b><br />
152            The bottom gutter of the chart, (the gutter is where the labels and title are).<br />
153            <i>Default: 25</i><br /><br />
154
155            <a name="chart.margin"></a>
156<b>chart.margin</b><br />
157            The space above and below each bar. <br /><i>Default: 2</i><br /><br />
158<a name="titles"></a>
159<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>
160
161<b>chart.title</b><br />
162The main title of the chart.<br />
163<i>Default: (An empty string)</i><br /><br />
164
165<a name="chart.title.background"></a>
166<b>chart.title.background</b><br />
167The background color (if any) for the title.<br />
168<i>Default: null</i><br /><br />
169
170<a name="chart.title.hpos"></a>
171<b>chart.title.hpos</b><br />
172            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 />
173            <a name="chart.title.vpos"></a>
174<b>chart.title.vpos</b><br />
175            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 />
176            <a name="chart.title.color"></a>
177<b>chart.title.color</b><br />
178            The color of the title.<br /> <i>Default: black</i><br /><br />
179            <a name="chart.title"></a>
180            <a name="chart.title.left"></a>
181<b>chart.title.left</b><br />
182            The left title. <br /><i>Default: An empty string</i><br /><br />
183            <a name="chart.title.right"></a>
184<b>chart.title.right</b><br />
185            The right title. <br /><i>Default: An empty string</i><br /><br />
186<a name="colors"></a>
187
188<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>
189
190    <a name="chart.colors"></a>
191    <b>chart.colors</b><br />
192    An array of colors. These too can be gradients that you make if you wish. <br />
193    <i>Default: ['#fcf', '#00f', '#f00', '#0f0', '#ff0', '#0ff', '#f0f', '#ff6101', '#b401ff', '#e4ff01', '#fb8195', '#ccc']</i><br /><br />
194   
195    <a name="chart.strokestyle"></a>
196    <b>chart.strokestyle</b><br />
197    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 />
198    <i>Default: #333</i><br /><br />
199
200<a name="labels, text and axes"></a>
201<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>
202<b>chart.xtickinterval</b><br />
203            The X tick mark interval. <br /><i>Default: null</i><br /><br />
204            <a name="chart.axis.color"></a>
205<b>chart.axis.color</b><br />
206            The color of the axes. <br /><i>Default: black</i><br /><br />
207            <a name="chart.xmax"></a>
208<b>chart.xmax</b><br />
209            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 />
210
211<a name="chart.scale.formatter"></a>
212            <b>chart.scale.formatter</b><br />
213            To allow thoroughly custom formats of numbers in the scale, you can use this option to
214            specify a function that is used by RGraph to format numbers. This function should
215            handle ALL of the formatting. Eg:<br /><br />
216            <pre class="code">
217function myFormatter(obj, num)
218{
219    return num + 'F'; // An example of formatting
220}
221myGraph.Set('chart.scale.formatter', myFormatter);
222</pre>
223            <br /><i>Default: null</i><br /><br />
224
225            <a name="chart.scale.decimals"></a>
226<b>chart.scale.decimals</b><br />
227            This allows you to set the precision of the X labels.<br /><i>Default: null</i><br /><br />
228            <a name="chart.scale.point"></a>
229<b>chart.scale.point</b><br />
230            The character used as the decimal point.<br /><i>Default: .</i><br /><br />
231            <a name="chart.scale.thousand"></a>
232<b>chart.scale.thousand</b><br />
233            The character used as the thousand separator<br /><i>Default: ,</i><br /><br />
234            <a name="chart.labels"></a>
235<b>chart.labels</b><br />
236            An array of the charts labels (they go in the middle). <br /><i>Default: null</i><br /><br />
237            <a name="chart.text.size"></a>
238<b>chart.text.size</b><br />
239            The size of the text used (in points). <br /><i>Default: 10</i><br /><br />
240            <a name="chart.text.font"></a>
241<b>chart.text.font</b><br />
242            The font used to render the text.<br /><i>Default: Verdana</i><br /><br />
243            <a name="chart.text.color"></a>
244<b>chart.text.color</b><br />
245            The color of the labels. <br /><i>Default: black</i><br /><br />
246<a name="scale"></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">Scale</h3>            <a name="chart.units.pre"></a>
248
249           
250            <a name="chart.scale.round"></a>
251            <b>chart.scale.round</b><br />
252            Whether to round the maximum scale value up or not. This will produce slightly better scales in some instances.<br />
253            <i>Default: null</i><br /><br />
254
255<b>chart.units.pre</b><br />
256            The units that are applied to the X axis labels (these are pre-pended to the number).<br /><i>Default: none</i><br /><br />
257            <a name="chart.units.post"></a>
258<b>chart.units.post</b><br />
259            The units that are applied to the X axis labels (these are appended to the number).<br /><i>Default: none</i><br /><br />
260<a name="interactive features"></a>
261<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>
262<b>chart.tooltips</b><br />
263            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 />
264            <a name="chart.tooltips.effect"></a>
265<b>chart.tooltips.effect</b><br />
266            The animated effect used for showing tooltips. Can be either <i>fade</i> or <i>expand</i>.<br /><i>Default: fade</i><br /><br />
267            <a name="chart.tooltips.css.class"></a>
268<b>chart.tooltips.css.class</b><br />
269            This is the name of the CSS class the chart uses.<br /><i>Default: RGraph_tooltip</i><br /><br />
270            <a name="chart.tooltips.override"></a>
271<b>chart.tooltips.override</b><br />
272            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 />
273            <a name="chart.contextmenu"></a>
274<b>chart.contextmenu</b><br />
275            An array of context menu items. Cannot be used in conjunction with tooltips.<br /><i>Default: [] (An empty array)</i><br /><br />
276            <a name="chart.annotatable"></a>
277<b>chart.annotatable</b><br />
278            Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i><br /><br />
279            <a name="chart.annotate.color"></a>
280<b>chart.annotate.color</b><br />
281            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 />
282
283
284            <a name="chart.resizable"></a>
285            <b>chart.resizable</b><br />
286            Defaulting to false, this determines whether your chart 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 />
287            <i>Default: false</i><br /><br />
288
289            <a name="chart.resize.handle.background"></a>
290            <b>chart.resize.handle.background</b><br />
291            With this you can specify the background color for the resize handle. If you're adjusting the position of the
292            handle then you may need this to make the handle stand out more.<br />
293            <i>Default: null</i><br /><br />
294
295
296<a name="shadow"></a>
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">Shadow</h3>            <a name="chart.shadow"></a>
298<b>chart.shadow</b><br />
299            Turns the shadow on or off.<br /> <i>Default: false</i><br /><br />
300            <a name="chart.shadow.color"></a>
301<b>chart.shadow.color</b><br />
302            The color of the shadow.<br /> <i>Default: #666</i><br /><br />
303            <a name="chart.shadow.offsetx"></a>
304<b>chart.shadow.offsetx</b><br />
305            The horizontal offset of the shadow.<br /> <i>Default: 3</i><br /><br />
306            <a name="chart.shadow.offsety"></a>
307<b>chart.shadow.offsety</b><br />
308            The vertical offset of the shadow. <br /> <i>Default: 3</i><br /><br />
309            <a name="chart.shadow.blur"></a>
310<b>chart.shadow.blur</b><br />
311            How severe the blurring effect is for the shadow.<br /> <i>Default: 3</i><br /><br />
312<a name="zoom"></a>
313<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>
314<b>chart.zoom.mode</b><br />
315            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 />
316            <a name="chart.zoom.factor"></a>
317<b>chart.zoom.factor</b><br />
318            This is the factor that the chart will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i><br /><br />
319            <a name="chart.zoom.fade.in"></a>
320<b>chart.zoom.fade.in</b><br />
321            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 />
322            <a name="chart.zoom.fade.out"></a>
323<b>chart.zoom.fade.out</b><br />
324            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 />
325            <a name="chart.zoom.hdir"></a>
326<b>chart.zoom.hdir</b><br />
327            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 />
328            <a name="chart.zoom.vdir"></a>
329<b>chart.zoom.vdir</b><br />
330            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 />
331            <a name="chart.zoom.delay"></a>
332<b>chart.zoom.delay</b><br />
333            The delay (in milliseconds) between frames.<br /><i>Default: 50</i><br /><br />
334            <a name="chart.zoom.frames"></a>
335<b>chart.zoom.frames</b><br />
336            The number of frames in the zoom animation.<br /><i>Default: 10</i><br /><br />
337            <a name="chart.zoom.shadow"></a>
338<b>chart.zoom.shadow</b><br />
339            Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i><br /><br />
340            <a name="chart.zoom.thumbnail.width"></a>
341<b>chart.zoom.thumbnail.width</b><br />
342            When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
343            <a name="chart.zoom.thumbnail.height"></a>
344<b>chart.zoom.thumbnail.height</b><br />
345            When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
346            <a name="chart.zoom.background"></a>
347<b>chart.zoom.background</b><br />
348            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 />
349
350
351    <a name="miscellaneous"></a>
352    <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>
353
354        <a name="chart.highlight.stroke"></a>
355        <b>chart.highlight.stroke</b><br />
356        If you use tooltips, this controls the colour of the highlight stroke.
357        <br /><i>Default: black</i><br /><br />
358
359        <a name="chart.highlight.fill"></a>
360        <b>chart.highlight.fill</b><br />
361        If you use tooltips, this controls the colour of the highlight fill.
362        <br /><i>Default: rgba(255,255,255,0.5)</i><br /><br />
363
364</div><!-- /DOCS --><br /><br />
365
366</body>
367</html>
Note: See TracBrowser for help on using the repository browser.