# RGraph: HTML5 canvas graph library - Rose chart 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>

- Margins
- Colors
- Labels and text
- Titles
- Axis properties
- Key
- Interactive features
- Zoom

## Available 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
The gutter used on the chart
Default: 25

### Colors

chart.colors
An array of colors to be used by the chart.
Default: ['rgb(255,0,0)', 'rgb(0,255,255)', 'rgb(0,255,0)', 'rgb(127,127,127)', 'rgb(0,0,255)', 'rgb(255,128,255)']
chart.colors.alpha
Instead of using rgba(), you can use color definitions such as red along with this setting to add transparency.
Default: null

### 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 graph.
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.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 graph libraries.
Default: null

### Key

chart.key
The key for the chart.
Default: null
chart.key.shadow
Whether a small drop shadow is applied to the key.
Default: false
chart.key.background
The background color of the key.
Default: white
chart.key.position
The position of the key. With this graph type, it makes sense for it to remain at graph.
Default: graph

### Interactive features

chart.tooltips
An array of tooltips. You can use HTML if you so wish.
Default: [] (An empty array)
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 graph 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 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).
Default: false
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 graph 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