1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
|
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<!--
/**
* o------------------------------------------------------------------------------o
* | This file is part of the RGraph package - you can learn more at: |
* | |
* | http://www.rgraph.net |
* | |
* | This package is licensed under the RGraph license. For all kinds of business |
* | purposes there is a small one-time licensing fee to pay and for non |
* | commercial purposes it is free to use. You can read the full license here: |
* | |
* | http://www.rgraph.net/LICENSE.txt |
* o------------------------------------------------------------------------------o
*/
-->
<title>RGraph: HTML5 Javascript charts library - bar charts documentation</title>
<meta name="keywords" content="rgraph html5 canvas docs bar charts" />
<meta name="description" content="RGraph: HTML5 Javascript charts library - Documentation about the Bar charts" />
<meta property="og:title" content="RGraph: HTML5 Javascript charts library" />
<meta property="og:description" content="A charts library based on the HTML5 canvas tag" />
<meta property="og:image" content="http://www.rgraph.net/images/logo.png"/>
<link rel="stylesheet" href="../css/website.css" type="text/css" media="screen" />
<link rel="icon" type="image/png" href="../images/favicon.png">
<!-- Place this tag in your head or just before your close body tag -->
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
<script>
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-54706-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<!-- Social networking buttons -->
<div id="social_icons" class="warning" style="border-radius: 10px; top: 1px; position: fixed; width: 120px; height: 20px">
<!-- <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%20javascript%20charts%20library%20supporting%20a%20wide%20range%20of%20different%20chart%20types&title=RGraph:%20Javascript%20charts%20%26%20graph%20library" target="_blank"><img src="../images/delicious.png" alt="Bookmark with delicious" width="22" height="22" border="0" style="position: relative; top: 1px" /></a> -->
<a href="http://twitter.com/home/?status=RGraph%3A%20Javascript+charts+library+http%3A%2F%2Fwww.rgraph.net+%23rgraph+%23html5+%23canvas+%23javascript+%23charts+@_rgraph" target="_blank" title="Mention RGraph on Twitter"><img src="../images/twitter.png" alt="Mention RGraph on Twitter"/></a>
<iframe src="http://www.facebook.com/plugins/like.php?app_id=253862424642173&href=http%3A%2F%2Fwww.rgraph.net&send=false&layout=button_count&width=450&show_faces=false&action=like&colorscheme=light&font=arial&height=21" scrolling="no" frameborder="0" style="width: 80px; height:21px; position: relative; top: 1px"></iframe>
</div>
<script>
// Opera fix
if (navigator.userAgent.indexOf('Opera') == -1) {
document.getElementById("social_icons").style.position = 'fixed';
}
</script>
<div id="google_plusone">
<!-- Place this tag where you want the +1 button to render -->
<g:plusone href="http://www.rgraph.net"></g:plusone>
</div>
<!-- Social networking buttons -->
<div id="breadcrumb">
<a href="../index.html">RGraph: HTML5 Javascript charts library</a>
>
<a href="index.html">Documentation</a>
>
Bar charts
</div>
<h1>RGraph: <span>HTML5 Javascript charts library</span> - Bar charts documentation</h1>
<script>
if (RGraph.isIE8()) {
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.</div>');
}
</script>
<p>
Bar charts, along with Line charts, are the most configurable of all the charts available,
because they're the most common of chart types.
</p>
<p>
The example file is <a href="../examples/bar.html">here</a>.
</p>
<ul>
<li><a href="#available.properties">Properties</a></li>
<li><a href="#available.methods">Methods</a></li>
</ul>
<pre class="code">
<script>
window.onload = function ()
{
var data = [280,45,133,166,84,259,266,960,219,311];
var bar = new RGraph.Bar('myCanvas', data);
bar.Set('chart.labels', ['Richard', 'Alex', 'Nick', 'Scott', 'Kjnell', 'Doug', 'Charles', 'Michelle', 'Mark', 'Alison']);
bar.Set('chart.gutter.left', 45);
bar.Set('chart.background.barcolor1', 'rgba(255,255,255,1)');
bar.Set('chart.background.barcolor2', 'rgba(255,255,255,1)');
bar.Set('chart.background.grid', true);
bar.Set('chart.colors', ['rgba(255,0,0,1)']);
bar.Draw();
}
</script>
</pre>
<a name="available.properties"></a>
<h2>Properties</h2>
<p>
You can use these properties to control how the bar chart apears. You can set them by using the Set() method. Eg:
</p>
<p>
<b>myBar.Set('name', 'value');</b>
</p>
<ul>
<li><a href="#background">Background</a></li>
<li><a href="#axes">Axes properties</a></li>
<li><a href="#colors">Colors</a></li>
<li><a href="#margins">Margins</a></li>
<li><a href="#labels and text">Labels and text</a></li>
<li><a href="#titles">Titles</a></li>
<li><a href="#shadow">Shadow</a></li>
<li><a href="#scale">Scale</a></li>
<li><a href="#key">Key</a></li>
<li><a href="#interactive features">Interactive features</a></li>
<li><a href="#zoom">Zoom</a></li>
<li><a href="#miscellaneous">Miscellaneous</a></li>
</ul>
<a name="background"></a>
<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">Background</h3> <a name="chart.background.barcolor1"></a>
<b>chart.background.barcolor1</b><br />
The color of the background bars, (1 of 2). <br /><i>Default: white</i><br /><br />
<a name="chart.background.barcolor2"></a>
<b>chart.background.barcolor2</b><br />
The color of the background bars, (2 of 2). <br /><i>Default: white</i><br /><br />
<a name="chart.background.grid"></a>
<b>chart.background.grid</b><br />
Whether to show the background grid or not. <br /><i>Default: true</i><br /><br />
<a name="chart.background.grid.color"></a>
<b>chart.background.grid.color</b><br />
The color of the background grid. <br /><i>Default: #ddd</i><br /><br />
<a name="chart.background.grid.hsize"></a>
<b>chart.background.grid.hsize</b><br />
The horizontal background grid size. <br /><i>Default: 40</i><br /><br />
<a name="chart.background.grid.vsize"></a>
<b>chart.background.grid.vsize</b><br />
The vertical background grid size. <br /><i>Default: 18</i><br /><br />
<a name="chart.background.grid.width"></a>
<b>chart.background.grid.width</b><br />
The width that the background grid lines are. Decimals (eg 0.5) are permitted.<br /><i>Default: 1</i><br /><br />
<a name="chart.background.grid.border"></a>
<b>chart.background.grid.border</b><br />
Determines whether a border line is drawn around the grid.<br /><i>Default: true</i><br /><br />
<a name="chart.background.grid.hlines"></a>
<b>chart.background.grid.hlines</b><br />
Determines whether to draw the horizontal grid lines.<br /><i>Default: true</i><br /><br />
<a name="chart.background.grid.vlines"></a>
<b>chart.background.grid.vlines</b><br />
Determines whether to draw the vertical grid lines.<br /><i>Default: true</i><br /><br />
<a name="chart.background.grid.autofit"></a>
<b>chart.background.grid.autofit</b><br />
Instead of specifying a pixel width/height for the background grid, you can use autofit and specify how many horizontal and vertical lines you want.<br />
<i>Default: true</i><br /><br />
<a name="chart.background.grid.autofit.numhlines"></a>
<b>chart.background.grid.autofit.numhlines</b><br />
When using autofit this allows you to specify how many horizontal grid lines you want. <br />
<i>Default: 5</i><br /><br />
<a name="chart.background.grid.autofit.numvlines"></a>
<b>chart.background.grid.autofit.numvlines</b><br />
When using autofit this allows you to specify how many vertical grid lines you want. <br />
<i>Default: 20</i><br /><br />
<a name="chart.background.grid.autofit.align"></a>
<b>chart.background.grid.autofit.align</b><br />
If you want to have your grid lines line up with the labels (both X and Y axes), you can set this to true and RGraph will
attempt to make the grid lines line up. If you have a <i>chart.hmargin</i> set then the alignment will be thrown out.<br />
<i>Default: false</i><br /><br />
<a name="chart.background.hbars"></a>
<b>chart.background.hbars</b><br />
An array of information stipulating horizontal coloured bars. You can use these to indicate limits. Eg: <i>myBar.Set('hbars', [[75, 10, 'yellow'], [85, 15, 'red']]);</i> This would give you two bars, one red and a lower yellow bar. The units correspond to your scale, and are the starting point and the height.<br /><i>Default: null</i><br /><br />
<a name="chart.background.image"></a>
<b>chart.background.image</b><br />
If you want to specify a background image to use on your chart, specify it with this property.<br />
<i>Default: null</i><br /><br />
<a name="axes"></a>
<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">Axes properties</h3>
<a name="chart.noaxes"></a>
<b>chart.noaxes</b><br />
Whether the axes are drawn<br />
<i>Default: false (the axes ARE drawn)</i><br /><br />
<a name="chart.noxaxis"></a>
<b>chart.noxaxis</b><br />
Whether the X axis is drawn<br />
<i>Default: false (the X axis IS drawn)</i><br /><br />
<a name="chart.noyaxis"></a>
<b>chart.noyaxis</b><br />
Whether the Y axis is drawn<br />
<i>Default: false (the Y axis IS drawn)</i><br /><br />
<a name="chart.noendxtick"></a>
<b>chart.noendxtick</b><br />
When you're combining the Bar and Line charts, you may want to use this property to stop the end X tick from
being drawn.<br />
<i>Default: false (the end tick IS drawn)</i><br /><br />
<a name="colors"></a>
<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.strokecolor"></a>
<b>chart.strokecolor</b><br />
The color of the outline of the bars. <br /><i>Default: #666</i><br /><br />
<a name="chart.colors"></a>
<b>chart.colors</b><br />
An array of the colors of the actual bars. <br />
<i>Default: An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']</i><br /><br />
<a name="chart.colors.sequential"></a>
<b>chart.colors.sequential</b><br />
If true, for regular bar charts, (not stacked or grouped), the colors that you specify will be used in a sequential
fashion.<br />
<i>Default: false</i><br /><br />
<a name="chart.colors.reverse"></a>
<b>chart.colors.reverse</b><br />
If true, for stacked bar charts only, the colors that you specify will be used in a reverse order to what they are
normally.<br />
<i>Default: false</i><br /><br />
<a name="margins"></a>
<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.hmargin"></a>
<b>chart.hmargin</b><br />
The horizontal margin (in pixels) of the chart. The horizontal margin is on the inside of the axes.<br />
<i>Default: 5</i><br /><br />
<a name="chart.gutter.left"></a>
<b>chart.gutter.left</b><br />
The left gutter of the chart, (the gutter is where the labels and title are)).<br />
<i>Default: 25</i><br /><br />
<a name="chart.gutter.right"></a>
<b>chart.gutter.right</b><br />
The right gutter of the chart, (the gutter is where the labels and title are).<br />
<i>Default: 25</i><br /><br />
<a name="chart.gutter.top"></a>
<b>chart.gutter.top</b><br />
The top gutter of the chart, (the gutter is where the labels and title are).<br />
<i>Default: 25</i><br /><br />
<a name="chart.gutter.bottom"></a>
<b>chart.gutter.bottom</b><br />
The bottom gutter of the chart, (the gutter is where the labels and title are).<br />
<i>Default: 25</i><br /><br />
<a name="labels and text"></a>
<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>
<b>chart.text.color</b><br />
The color of the labels. <br /><i>Default: black</i><br /><br />
<a name="chart.text.size"></a>
<b>chart.text.size</b><br />
The size (in points) of the labels. <br /><i>Default: 10</i><br /><br />
<a name="chart.text.angle"></a>
<b>chart.text.angle</b><br />
The angle of the horizontal text labels (at the bottom of the chart). This can be one of three values - 0, 45 or 90.<br /><i>Default: 0 (Horizontal)</i><br /><br />
<a name="chart.text.font"></a>
<b>chart.text.font</b><br />
The font used to render the text.<br /><i>Default: Verdana</i><br /><br />
<a name="chart.labels"></a>
<b>chart.labels</b><br />
An array of the labels to be used on the chart. <br /><i>Default: An empty array</i><br /><br />
<a name="chart.labels.above"></a>
<b>chart.labels.above</b><br />
If true, values will be shown above the bars. For regular and stacked bar charts units are included, whereas for
grouped bar charts they're not (usually there isn't enough space for them).
<br /><i>Default: false</i><br /><br />
<a name="chart.labels.above.decimals"></a>
<b>chart.labels.above.decimals</b><br />
This stipulates how many decimals are used in the above bar labels.
<br /><i>Default: 0</i><br /><br />
<a name="chart.labels.above.size"></a>
<b>chart.labels.above.size</b><br />
The font size of the above bar labels. Useful if you only have a few bars.
<br /><i>Default: false</i><br /><br />
<a name="chart.labels.above.angle"></a>
<b>chart.labels.above.angle</b><br />
You can use this to angle the text shown above the bars. It can be anything from -90 to 90 (degrees).
<br /><i>Default: null</i><br /><br />
<a name="chart.labels.ingraph"></a>
<b>chart.labels.ingraph</b><br />
An array of labels for the chart which are drawn "inside" the chart. If you have 5 data points then this should have a corresponding number of elements, though there is a <a href="misc.html#shorthand.ingraph.labels">shorthand available</a>.<br /><i>Default: null</i><br /><br />
<a name="chart.ylabels"></a>
<b>chart.ylabels</b><br />
Can be <i>true</i> or <i>false</i> and determines whether the chart has Y axis labels.<br />
<i>Default: true</i><br /><br />
<a name="chart.ylabels.count"></a>
<b>chart.ylabels.count</b><br />
A value that controls how many Y labels there are. Previously (prior to 8th August 2010) this could be 1,3,5.
Now it can be any number, but keep in mind that if you use this it may result in decimals.<br />
<i>Default: 5</i><br /><br />
<a name="chart.ylabels.specific"></a>
<b>chart.ylabels.specific</b><br />
You can use this option to give your own Y labels (eg ['Low', 'Medium', 'High'].<br />
<i>Default: null</i><br /><br />
<a name="chart.xlabels.offset"></a>
<b>chart.xlabels.offset</b><br />
This allows you finer grained control over the X label positioning if you need it.<br /><i>Default: 0</i><br /><br />
<a name="chart.numyticks"></a>
<b>chart.numyticks</b><br />
The number of Y tickmarks. If you have changed the number of Y labels, you may also want to change this to match. <br /><i>Default: 10</i><br /><br />
<a name="titles"></a>
<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>
<b>chart.title</b><br />
The title of the chart, if any. <br />
<i>Default: null</i><br /><br />
<a name="chart.title.font"></a>
<b>chart.title.font</b><br />
The font that the title is rendered in. If not specified the chart.text.font setting is used (usually Verdana)<br />
<i>Default: null</i><br /><br />
<a name="chart.title.size"></a>
<b>chart.title.size</b><br />
The size of the title. If not specified the size is usually 2pt bigger than the chart.text.size setting.<br />
<i>Default: null</i><br /><br />
<a name="chart.title.bold"></a>
<b>chart.title.bold</b><br />
Whather the title is bold or not.<br />
<i>Default: true</i><br /><br />
<a name="chart.title.background"></a>
<b>chart.title.background</b><br />
The background color (if any) for the title.<br />
<i>Default: null</i><br /><br />
<a name="chart.title.color"></a>
<b>chart.title.color</b><br />
The color of the title.<br /> <i>Default: black</i><br /><br />
<a name="chart.title.hpos"></a>
<b>chart.title.hpos</b><br />
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 />
<a name="chart.title.vpos"></a>
<b>chart.title.vpos</b><br />
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 />
<a name="chart.title.xaxis"></a>
<b>chart.title.xaxis</b><br />
This allows to specify a title for the X axis.<br /><i>Default: none</i><br /><br />
<a name="chart.title.yaxis"></a>
<a name="chart.title.xaxis.size"></a>
<b>chart.title.xaxis.size</b><br />
This allows you to specify a size for the X axis title.<br />
<i>Default: null</i><br /><br />
<a name="chart.title.xaxis.font"></a>
<b>chart.title.xaxis.font</b><br />
This allows to specify a font for the X axis title.<br />
<i>Default: null</i><br /><br />
<a name="chart.title.xaxis.bold"></a>
<b>chart.title.xaxis.bold</b><br />
This controls whether the X axis title is bold or not.<br />
<i>Default: true</i><br /><br />
<a name="chart.title.yaxis"></a>
<b>chart.title.yaxis</b><br />
This allows to specify a title for the Y axis.<br />
<i>Default: none</i><br /><br />
<a name="chart.title.yaxis.size"></a>
<b>chart.title.yaxis.size</b><br />
This allows you to specify a size for the Y axis title.<br />
<i>Default: null</i><br /><br />
<a name="chart.title.yaxis.font"></a>
<b>chart.title.yaxis.font</b><br />
This allows to specify a font for the Y axis title.<br />
<i>Default: null</i><br /><br />
<a name="chart.title.yaxis.bold"></a>
<b>chart.title.yaxis.bold</b><br />
This controls whether the Y axis title is bold or not.<br />
<i>Default: true</i><br /><br />
<a name="chart.title.xaxis.pos"></a>
<b>chart.title.xaxis.pos</b><br />
This is multiplied with the gutter to give the position of the X axis title.<br /><i>Default: 0.25</i><br /><br />
<a name="chart.title.yaxis.pos"></a>
<b>chart.title.yaxis.pos</b><br />
This is multiplied with the gutter to give the position of the Y axis title.<br /><i>Default: 0.25</i><br /><br />
<!--
<a name="chart.title.yaxis.position"></a>
<b>chart.title.yaxis.align</b><br />
Instead of using the option above you can instead use this option, specifying <i>left</i> or <i>right</i>.<br />
<i>Default: left</i><br /><br />
-->
<a name="shadow"></a>
<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>
<b>chart.shadow</b><br />
Whether a drop shadow is applied. <br /><i>Default: false</i><br /><br />
<a name="chart.shadow.color"></a>
<b>chart.shadow.color</b><br />
The color of the shadow. <br /><i>Default: #666</i><br /><br />
<a name="chart.shadow.offsetx"></a>
<b>chart.shadow.offsetx</b><br />
The X offset of the shadow. <br /><i>Default: 3</i><br /><br />
<a name="chart.shadow.offsety"></a>
<b>chart.shadow.offsety</b><br />
The Y offset of the shadow. <br /><i>Default: 3</i><br /><br />
<a name="chart.shadow.blur"></a>
<b>chart.shadow.blur</b><br />
The severity of the shadow blurring effect. <br /><i>Default: 3</i><br /><br />
<a name="scale"></a>
<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.scale.formatter"></a>
<b>chart.scale.formatter</b><br />
To allow thoroughly custom formats of numbers in the scale, you can use this option to
specify a function that is used by RGraph to format numbers. This function should
handle ALL of the formatting. Eg:<br /><br />
<pre class="code">
function myFormatter(obj, num)
{
return num + 'F'; // An example of formatting
}
myGraph.Set('chart.scale.formatter', myFormatter);
</pre>
<br /><i>Default: null</i><br /><br />
<a name="chart.scale.decimals"></a>
<b>chart.scale.decimals</b><br />
The number of decimal places to display for the Y scale.
<br /><i>Default: 0</i><br /><br />
<a name="chart.scale.point"></a>
<b>chart.scale.point</b><br />
The character used as the decimal point.<br /><i>Default: .</i><br /><br />
<a name="chart.units.pre"></a>
<b>chart.units.pre</b><br />
The units that the Y axis is 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 />
<a name="chart.units.post"></a>
<b>chart.units.post</b><br />
The units that the Y axis is 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 />
<a name="chart.ymax"></a>
<b>chart.ymax</b><br />
The optional maximum Y scale value. If not specified then it will be calculated.<br /><i>Default: null (It's calculated)</i><br /><br />
<a name="chart.ymin"></a>
<b>chart.ymin</b><br />
The optional minimum Y scale value. If not specified then it will be 0.<br /><i>Default: 0</i><br /><br />
<a name="key"></a>
<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">Key</h3>
<a name="chart.key"></a>
<b>chart.key</b><br />
An array of key information. <br />
<i>Default: [] (An empty array)</i><br /><br />
<a name="chart.key.background"></a>
<b>chart.key.background</b><br />
The color of the key background. Typically white, you could set this to something like rgba(255,255,255,0.7) to allow people to see things behind it.<br>
<i>Default: white</i><br /><br />
<a name="chart.key.halign"></a>
<b>chart.key.halign</b><br />
Instead of specifying the exact x/y coordinates, you can use this property to simply specify whether the key hould be
aligned <i>left</i> or <i>right</i>.<br />
<i>Default: right</i><br /><br />
<a name="chart.key.position"></a>
<b>chart.key.position</b><br />
Determines the position of the key.Either <b>graph</b> (default), or <b>gutter</b>.<br />
<i>Default: graph</i><br /><br />
<b>chart.key.position.x</b><br />
This allows you to specify a specific X coordinate for the key.<br />
<i>Default: null</i><br /><br />
<b>chart.key.position.y</b><br />
This allows you to specify a specific Y coordinate for the key.<br />
<i>Default: null</i><br /><br />
<b>chart.key.position.gutter.boxed</b><br />
If you have the key in gutter mode (ie horizontal), this allows you to give a background color.<br />
<i>Default: true</i><br /><br />
<a name="chart.key.shadow"></a>
<b>chart.key.shadow</b><br />
Whether a small drop shadow is applied to the key.<br />
<i>Default: false</i><br /><br />
<a name="chart.key.shadow.color"></a>
<b>chart.key.shadow.color</b><br />
The color of the shadow.<br />
<i>Default: #666</i><br /><br />
<a name="chart.key.shadow.blur"></a>
<b>chart.key.shadow.blur</b><br />
The extent of the blurring effect used on the shadow.<br />
<i>Default: 3</i><br /><br />
<a name="chart.key.shadow.offsetx"></a>
<b>chart.key.shadow.offsetx</b><br />
The X offset of the shadow.<br />
<i>Default: 2</i><br /><br />
<a name="chart.key.shadow.offsety"></a>
<b>chart.key.shadow.offsety</b><br />
The Y offset of the shadow.<br />
<i>Default: 2</i><br /><br />
<b>chart.key.rounded</b><br />
This controls whether the corners of the key (in graph mode) are curved. If the key is gutter mode, this has no effect.<br />
<i>Default: false</i><br /><br />
<b>chart.key.color.shape</b><br />
This can be <i>square</i>, <i>circle</i> or <i>line</i> and controls how the color indicators in the key appear.<br />
<i>Default: square</i><br /><br />
<b>chart.key.linewidth</b><br />
The line width of the surrounding border on the key.<br />
<i>Default: 1</i><br /><br />
<a name="interactive features"></a>
<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>
<b>chart.contextmenu</b><br />
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 />
<a name="chart.tooltips"></a>
<b>chart.tooltips</b><br />
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.<br /><i>Default: null</i><br /><br />
<a name="chart.tooltips.effect"></a>
<b>chart.tooltips.effect</b><br />
The animated effect used for showing tooltips. Can be either <i>fade</i> or <i>expand</i>.<br /><i>Default: fade</i><br /><br />
<a name="chart.tooltips.event"></a>
<b>chart.tooltips.event</b><br />
This is the event that triggers the tooltips. It can be either <i>onclick</i> or <i>onmousemove</i>.<br />
<i>Default: onclick</i><br /><br />
<a name="chart.tooltips.css.class"></a>
<b>chart.tooltips.css.class</b><br />
This is the name of the CSS class the chart uses.<br /><i>Default: RGraph_tooltip</i><br /><br />
<a name="chart.tooltips.override"></a>
<b>chart.tooltips.override</b><br />
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 />
<a name="chart.tooltips.highlight"></a>
<b>chart.tooltips.highlight</b><br />
When combining chartss you will need to set this option to fase.<br />
<i>Default: true</i><br /><br />
<a name="chart.crosshairs"></a>
<b>chart.crosshairs</b><br />
If true, you will get a crosshair centering on the current mouse position.<br /><i>Default: false</i><br /><br />
<a name="chart.crosshairs.linewidth"></a>
<b>chart.crosshairs.linewidth</b><br />
This controls the linewidth of the crosshairs.<br /><i>Default: 1</i><br /><br />
<a name="chart.crosshairs.color"></a>
<b>chart.crosshairs.color</b><br />
The color of the crosshairs.<br /><i>Default: #333</i><br /><br />
<a name="chart.crosshairs.hlines"></a>
<b>chart.crosshairs.hlines</b><br />
This determines whether the horizontal crosshair is shown.<br />
<i>Default: true</i><br /><br />
<a name="chart.crosshairs.vlines"></a>
<b>chart.crosshairs.vlines</b><br />
This determines whether the vertical crosshair is shown.<br />
<i>Default: true</i><br /><br />
<a name="chart.annotatable"></a>
<b>chart.annotatable</b><br />
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.<br /><i>Default: false</i><br /><br />
<a name="chart.annotate.color"></a>
<b>chart.annotate.color</b><br />
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 />
<a name="chart.resizable"></a>
<b>chart.resizable</b><br />
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 />
<i>Default: false</i><br /><br />
<a name="chart.resize.handle.background"></a>
<b>chart.resize.handle.background</b><br />
With this you can specify the background color for the resize handle. If you're adjusting the position of the
handle then you may need this to make the handle stand out more.<br />
<i>Default: null</i><br /><br />
<a name="chart.adjustable"></a>
<b>chart.adjustable</b><br />
Defaulting to false, this determines whether your bar chart will be adjustable. <br /><i>Default: false</i><br /><br />
<a name="zoom"></a>
<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>
<b>chart.zoom.mode</b><br />
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 />
<a name="chart.zoom.factor"></a>
<b>chart.zoom.factor</b><br />
This is the factor that the chart will be zoomed by (bigger values means more zoom)<br /><i>Default: 1.5</i><br /><br />
<a name="chart.zoom.fade.in"></a>
<b>chart.zoom.fade.in</b><br />
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 />
<a name="chart.zoom.fade.out"></a>
<b>chart.zoom.fade.out</b><br />
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 />
<a name="chart.zoom.hdir"></a>
<b>chart.zoom.hdir</b><br />
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 />
<a name="chart.zoom.vdir"></a>
<b>chart.zoom.vdir</b><br />
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 />
<a name="chart.zoom.delay"></a>
<b>chart.zoom.delay</b><br />
The delay (in milliseconds) between frames.<br /><i>Default: 50</i><br /><br />
<a name="chart.zoom.frames"></a>
<b>chart.zoom.frames</b><br />
The number of frames in the zoom animation.<br /><i>Default: 10</i><br /><br />
<a name="chart.zoom.shadow"></a>
<b>chart.zoom.shadow</b><br />
Whether or not the zoomed canvas has a shadow or not.<br /><i>Default: true</i><br /><br />
<a name="chart.zoom.thumbnail.width"></a>
<b>chart.zoom.thumbnail.width</b><br />
When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
<a name="chart.zoom.thumbnail.height"></a>
<b>chart.zoom.thumbnail.height</b><br />
When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.<br /><i>Default: 75</i><br /><br />
<a name="chart.zoom.background"></a>
<b>chart.zoom.background</b><br />
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 />
<a name="miscellaneous"></a>
<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.highlight.stroke"></a>
<b>chart.highlight.stroke</b><br />
If you use tooltips, this controls the colour of the highlight stroke.
<br /><i>Default: black</i><br /><br />
<a name="chart.highlight.fill"></a>
<b>chart.highlight.fill</b><br />
If you use tooltips, this controls the colour of the highlight fill.
<br /><i>Default: rgba(255,255,255,0.5)</i><br /><br />
<a name="chart.line"></a>
<b>chart.line</b><br />
Formerly a boolean, this now stipulates a line chart object which is to be drawn on top of the bar chart. You can see an example <a href="combine.html">here</a>.<br /><i>Default: null</i><br /><br />
<a name="chart.variant"></a>
<b>chart.variant</b><br />
This simply stipulates whether you want a regular bar chart, a dot chart, a pyramid chart a 3D chart, a sketch or a glassy chart. Possible values are:<ul><li>bar</li><li>dot</li><li>pyramid</li><li>arrow</li><li>3d</li><li>sketch</li><li>glass</li></ul>The pyramid, dot, arrow, sketch and glass variants are only effective for regular bar charts - not grouped or stacked charts.<br /><i>Default: bar</i><br /><br />
<a name="chart.xaxispos"></a>
<b>chart.xaxispos</b><br />
The position of the X axis. This can be <i>bottom</i>, <i>center</i> or <i>top</i>. <br />
<i>Default: bottom</i><br /><br />
<a name="chart.axis.color"></a>
<b>chart.axis.color</b><br />
The color of the axes.<br /><i>Default: black</i><br /><br />
<a name="chart.grouping"></a>
<b>chart.grouping</b><br />
How the bars are grouped, and it should be one of: <b>grouped</b> or <b>stacked</b><br /><i>Default: grouped</i><br /><br />
</div>
<a name="available.methods"></a>
<br /> <br />
<h2>Methods</h2>
<a name="getbar"></a>
<b>obj.getBar()</b><br /><br />
This method makes it easier to get hold of which bar has been clicked on, or hovered over. It returns an array of:
<ul>
<li>The chart object</li>
<li>The X coordinate</li>
<li>The Y coordinate</li>
<li>The width of the bar</li>
<li>The height of the bar</li>
<li>The numerical index of the bar. This corresponds (for example) to the tooltips array, and the coordinates array</li>
</ul>
An example usage is:
<pre class="code">
<canvas id="cvs" width="600" height="250">[No canvas support]</canvas>
<script src="RGraph.common.core.js"></script>
<script src="RGraph.bar.js"></script>
<script>
myGraph = new RGraph.Bar('myCanvas', [1.2, 1.3, 1.4, 1.5,6,1.9,2,2.1,2.5]);
myGraph.Set('chart.labels', ['John', 'Barry', 'Rich', 'Craig', 'Tom', 'Frank', 'Helen', 'Joyce', 'Fred'])
myGraph.Draw();
RGraph.Register(myGraph);
myGraph.canvas.onclick = function (e)
{
RGraph.Redraw();
var canvas = e.target;
var context = canvas.getContext('2d');
var obj = canvas.__object__;
<span style="color: green">var coords = obj.getBar(e);</span>
if (coords) {
var top = coords[1];
var left = coords[2];
var width = coords[3];
var height = coords[4];
context.beginPath();
context.strokeStyle = 'black';
context.fillStyle = 'rgba(255,255,255,0.5)';
context.strokeRect(top, left, width, height);
context.fillRect(top, left, width, height);
context.stroke();
context.fill();
}
}
</script>
</pre>
</body>
</html>
|
