RGraph: HTML5 Javascript charts library - Rose charts documentation
The example file is here.
<script>
window.onload = function ()
{
var data = [41,37,16,3,3];
var rose = new RGraph.Rose('myRose', data);
rose.Set('chart.labels', ['MSIE 7 (41%)',
'MSIE 6 (37%)',
'Firefox (16%)',
'Safari (3%)',
'Other (3%)']);
rose.Draw();
}
</script>
Properties
You can use these properties to control how the Rose chart appears. You can set them by using the Set() method. Eg:
myRose.Set('name', 'value');
Margins
chart.gutter.left
The left gutter of the chart, (the gutter is where the labels and title are)).
Default: 25
chart.gutter.right
The right gutter of the chart, (the gutter is where the labels and title are).
Default: 25
chart.gutter.top
The top gutter of the chart, (the gutter is where the labels and title are).
Default: 25
chart.gutter.bottom
The bottom gutter of the chart, (the gutter is where the labels and title are).
Default: 25
chart.margin
This is the margin that is either side of each segment. This allows you to have a gap between each segment. It is the size
of the gap in degrees. It doesn't apply to non-equi-angular Rose charts - only regular and stacked charts.
Default: 0
Colors
chart.colors
An array of colors to be used by the chart.
Default: ['red', 'rgb(0,255,255)', 'rgb(0,255,0)', 'gray', 'blue', 'rgb(255,128,255)','green', 'pink', 'gray', 'aqua']
chart.colors.alpha
Instead of using rgba(), you can use color definitions such as red along with this setting to add
transparency.
Default: null
chart.colors.sequential
Because of the new (as of July 2011) support for grouped Rose charts, the way colors are used has changed. So to have them
used in a sequential fashion as before the change, you will need to set this option to true.
Default: false
Labels and text
chart.text.font
The font used to render the text.
Default: Verdana
chart.text.color
The color of the labels.
Default: black
chart.text.size
The size of the text (in points).
Default: 10
chart.labels
The labels, if any, for the chart.
Default: none
chart.labels.axes
This controls the axes that show the scale labels. Each letter stands for the appropriate axis (North, South, East and West)
Default: nsew
chart.labels.position
This can be either center or edge and determines the position of the labels.
Default: center
Titles
chart.title
The title of the chart.
Default: none
chart.title.font
The font that the title is rendered in. If not specified the chart.text.font setting is used (usually Verdana)
Default: null
chart.title.size
The size of the title. If not specified the size is usually 2pt bigger than the chart.text.size setting.
Default: null
chart.title.bold
Whather the title is bold or not.
Default: true
chart.title.background
The background color (if any) for the title.
Default: null
chart.title.color
The color of the title.
Default: black
chart.title.hpos
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.
Default: null
chart.title.vpos
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.
Default: null
Axis properties
chart.ymax
This can be set to control the maximum value of the scale. It's so called to maintain a degree of API compatibility across chart libraries.
Default: null
Scale
chart.scale.round
Whether to round the maximum scale value up or not. This will produce slightly better scales in some instances.
Default: null
Key
chart.key
An array of key information.
Default: [] (An empty array)
chart.key.background
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.
Default: white
chart.key.halign
Instead of specifying the exact x/y coordinates, you can use this property to simply specify whether the key hould be
aligned left or right.
Default: right
chart.key.position
Determines the position of the key.Either graph (default), or gutter.
Default: graph
chart.key.position.x
This allows you to specify a specific X coordinate for the key.
Default: null
chart.key.position.y
This allows you to specify a specific Y coordinate for the key.
Default: null
chart.key.position.gutter.boxed
If you have the key in gutter mode (ie horizontal), this allows you to give a background color.
Default: true
chart.key.shadow
Whether a small drop shadow is applied to the key.
Default: false
chart.key.shadow.color
The color of the shadow.
Default: #666
chart.key.shadow.blur
The extent of the blurring effect used on the shadow.
Default: 3
chart.key.shadow.offsetx
The X offset of the shadow.
Default: 2
chart.key.shadow.offsety
The Y offset of the shadow.
Default: 2
chart.key.rounded
This controls whether the corners of the key (in graph mode) are curved. If the key is gutter mode, this has no effect.
Default: false
chart.key.color.shape
This can be square, circle or line and controls how the color indicators in the key appear.
Default: square
chart.key.linewidth
The line width of the surrounding border on the key.
Default: 1
Interactive features
chart.tooltips
An array of tooltips. You can use HTML if you so wish.
Default: [] (An empty array)
chart.tooltips.event
This is the event that triggers the tooltips. It can be either onclick or onmousemove.
Default: onclick
chart.tooltips.effect
The tooltip effect used. Can be either fade or expand.
Default: fade
chart.tooltips.css.class
This is the name of the CSS class the chart uses.
Default: RGraph_tooltip
chart.tooltips.override
If you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more
information on the tooltips documentation page
Default: null
chart.contextmenu
An array of context menu items. More information on context menus is here.
Default: [] (An empty array)
chart.annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false
chart.annotate.color
If you do not allow the use of the palette, then this will be the only colour allowed for annotations.
Default: black
chart.resizable
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).
Default: false
chart.resize.handle.background
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.
Default: null
chart.adjustable
Defaulting to false, this determines whether your rose chart will be adjustable (click the edge of a segment and drag to adjust it).
Default: false
Zoom
chart.zoom.mode
Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: thumbnail and canvas.
Default: canvas
chart.zoom.factor
This is the factor that the chart will be zoomed by (bigger values means more zoom)
Default: 1.5
chart.zoom.fade.in
Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true
chart.zoom.fade.out
Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true
chart.zoom.hdir
The horizontal direction of the zoom. Possible values are: left, center, right
Default: right
chart.zoom.vdir
The vertical direction of the zoom. Possible values are: up, center, down
Default: down
chart.zoom.delay
The delay (in milliseconds) between frames.
Default: 50
chart.zoom.frames
The number of frames in the zoom animation.
Default: 10
chart.zoom.shadow
Whether or not the zoomed canvas has a shadow or not.
Default: true
chart.zoom.thumbnail.width
When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.
Default: 75
chart.zoom.thumbnail.height
When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.
Default: 75
chart.zoom.background
Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.
Default: true
Miscellaneous
chart.highlight.stroke
If you use tooltips, this controls the colour of the highlight stroke.
Default: black
chart.highlight.fill
If you use tooltips, this controls the colour of the highlight fill.
Default: rgba(255,255,255,0.5)
chart.variant
This option can be either stacked (the default) or non-equi-angular. Just because his option is set to
stacked does not automatically mean your chart is stacked. If you don't suppy the appropriate data you chart
may well appear as a regular Rose chart. Examples of appropriate data:
A regular Rose chart
myRose = new RGraph.Rose('myCanvas', [8,5,4,8,6,7,2,3,5,8]);
A stacked Rose chart
myRose = new RGraph.Rose('myCanvas', [[2,6],[2,4],[1,5],[4,3],[7,5],[8,3],[4,5],[3,4],[2,6],[4,5]]);
A non-equi-angular Rose chart
myRose = new RGraph.Rose('myCanvas', [[45,23],[45,23],[5,26],[78,4],[49,12],[49,21],[40,18],[48,12],[43,23],[45,12]]);
myRose.Set('chart.variant', 'non-equi-angular');
It is important to note that with a non-equi-angular each "value" is actually an array consisting of two values,
as shown. The first value represents the magnitude of the segment (ie how far the segment extends outwards),
and the second value represents the size of the segment. The second value is relative to all the other second
values - it is not the absolute angle used. The angle is calculated for you.
Default: stacked
Methods
obj.getSegment()
obj.getSegment() makes it easy to determine which segment of the Rose chart was clicked on. It provides:
- Originating X coordinate
- Originating Y coordinate
- The starting radius of the segment
- The ending radius of the segment
- The starting angle (in degrees)
- The ending angle (in degrees)
- The numerical index of the segment
<script>
RGraph.Register(myGraph);
myGraph.canvas.onclick = function (e)
{
RGraph.FixEventObject(e);
RGraph.Redraw();
var canvas = e.target;
var context = canvas.getContext('2d');
var obj = canvas.__object__;
var segment = obj.getSegment(e);
if (segment) {
context.fillStyle = 'rgba(255,255,255,0.5)';
context.beginPath();
// Angles are provided in degrees, so convert them to radians
segment[4] /= 57.29;
segment[5] /= 57.29;
context.moveTo(segment[0], segment[1]);
context.arc(segment[0], segment[1], segment[3], segment[4], segment[5], 0);
context.arc(segment[0], segment[1], segment[2], segment[5], segment[4], true);
context.stroke();
context.fill();
e.stopPropagation();
}
}
window.onclick = function (e)
{
RGraph.Redraw();
}
</script>
Important Note
This method was formerly a common object method, called RGraph.getSegment(e), but has now (6th March 2011) been
moved to be part of the Rose chart object.
Stacked Rose charts
Rose charts can now be stacked, much like stacked Bar charts. For an example see the Rose
chart example page. The data should be supplied in the same format as a stacked Bar chart:
myRose = new RGraph.Rose('myCanvas', [[4,6,2],[8,4,7],[4,3,6],[1,5,6]]);
Non-equi-angular Rose charts
Rose charts can be displayed in a non-equi-angular mode. For an example see the
Rose chart example page. Instead of a plain array of values (as with a regular
Rose chart), each data point should itself be a two element array consisting of the magnitude value and also a relative
circular size. This second value is not the actual degrees used - these are calculated. For example:
<script>
myRose = new RGraph.Rose('myCanvas', [[47,6],[48,2],[40,4],[43,5],[45,6]]);
myRose.Set('chart.variant', 'non-equi-angular');
myRose.Draw();
</script>
Rose chart specific animations
There is a Rose chart Grow() animation, which can be used with regular and stacked Rose charts (not non-equi-angular charts). You
can see an example of it on the effects page.