Rose chart API reference

Summary: Documentation about the Rose chart including information about all of the options that are available to you. The Rose chart may be more familiar to you as a Wind Rose chart. It can be regular, stacked or non-equi-angular in appearance. The SVG Rose chart can also show non-equi-angular stacked charts too.

Example

<script>
    data = [41,37,32,35,36];

    new RGraph.Rose({
        id: 'cvs',
        data: data,
        options: {
            labels: ['MSIE 7 (41%)', 'MSIE 6 (37%)', 'Firefox (16%)', 'Safari (3%)', 'Other (3%)'],
            margin: 3,
            textSize: 16
        }
    }).draw()
</script>

The data_seq property

If your data is a multi-dimensional array (ie on a stacked Rose chart) then one member variable may be of interest to you - the obj.data_seq variable. This is a flattened view of the array of data that you pass to the Rose chart that may be useful in some circumstances. One of the demos shows this variable being used to get the value of the relevant piece of data.

This variable isn't really necessary for non-equi-angular or regular non-stacked charts.

Properties

You can use these properties to control how the chart appears. You can set them by including them in the options section of the configuration as shown above.

Chart configuration properties

PropertyDescriptionDefault
centerxIf required, you can position the Rose chart using this instead of the margins.null
centeryIf required, you can position the Rose chart using this instead of the margins.null
radiusIf required, you can size the Rose chart using this instead of the margins.null
anglesStartIf you want the chart to start at an angle other than the north axis - you can use this (keep in mind that this is specified in radians).0
centerx
If required, you can position the Rose chart using this instead of the margins.
Default: null

centery
If required, you can position the Rose chart using this instead of the margins.
Default: null

radius
If required, you can size the Rose chart using this instead of the margins.
Default: null

anglesStart
If you want the chart to start at an angle other than the north axis - you can use this (keep in mind that this is specified in radians).
Default: 0

Background properties

PropertyDescriptionDefault
backgroundGridRadialsCountTo control the number of "spokes" that the background grid has you can use this property.null
backgroundGridCirclesCountUsing this option you can specify the exact number of background circles.null
backgroundGridColorThe color of the background grid.#ccc
backgroundGridRadialsCount
To control the number of "spokes" that the background grid has you can use this property.
Default: null

backgroundGridCirclesCount
Using this option you can specify the exact number of background circles.
Default: null

backgroundGridColor
The color of the background grid.
Default: #ccc

Axes properties

PropertyDescriptionDefault
axesWhether the axes should be shown or not.false
axesColorThe color of the axes.black
axesLinewidthThe linewidth of the axes.1
axesTickmarksWhether the axes have tickmarks or not.true
axes
Whether the axes should be shown or not.
Default: false

axesColor
The color of the axes.
Default: black

axesLinewidth
The linewidth of the axes.
Default: 1

axesTickmarks
Whether the axes have tickmarks or not.
Default: true

Margin properties

PropertyDescriptionDefault
marginLeftThe left margin of the chart, (the margin is where the labels and title are)).25
marginRightThe right margin of the chart, (the margin is where the labels and title are).25
marginTopThe top margin of the chart, (the margin is where the labels and title are).25
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).25
marginThis 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.5
marginLeft
The left margin of the chart, (the margin is where the labels and title are)).
Default: 25

marginRight
The right margin of the chart, (the margin is where the labels and title are).
Default: 25

marginTop
The top margin of the chart, (the margin is where the labels and title are).
Default: 25

marginBottom
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 25

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: 5

Color properties

PropertyDescriptionDefault
colorsAn array of colors to be used by the chart.['red', 'rgb(0,255,255)', 'rgb(0,255,0)', 'gray', 'blue', 'rgb(255,128,255)','green', 'pink', 'gray', 'aqua']
colorsAlphaInstead of using rgba(), you can use color definitions such as red along with this setting to add transparency.null
colorsSequentialBecause 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.false
colorsStrokeThis is the color of the stroke (the outline) used when drawing the segments.rgba(0,0,0,0)
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']

colorsAlpha
Instead of using rgba(), you can use color definitions such as red along with this setting to add transparency.
Default: null

colorsSequential
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

colorsStroke
This is the color of the stroke (the outline) used when drawing the segments.
Default: rgba(0,0,0,0)

Shadow properties

PropertyDescriptionDefault
shadowWhether the shadow is enabled or not.false
shadowColorThe color of the shadow.#aaa
shadowOffsetxThe X offset of the shadow.0
shadowOffsetyThe Y offset of the shadow.0
shadowBlurThe magnitude of the shadow blurring effect.15
shadow
Whether the shadow is enabled or not.
Default: false

shadowColor
The color of the shadow.
Default: #aaa

shadowOffsetx
The X offset of the shadow.
Default: 0

shadowOffsety
The Y offset of the shadow.
Default: 0

shadowBlur
The magnitude of the shadow blurring effect.
Default: 15

Labels and text properties

PropertyDescriptionDefault
textAccessibleA new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:
<div style="margin-left: 50px; display: inline-block">
<canvas id="cvs" width="650" height="250"></canvas>
</div>
true
textAccessibleOverflowThis can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish.visible
textAccessiblePointereventsThis controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).true
textBoldWhether the text is bold or not.false
textItalicWhether the text is italic or not.false
textFontThe font used to render the text.Arial, Verdana, sans-serif
textColorThe color of the labels.black
textSizeThe size of the text.12
labelsThe labels, if any, for the chart.none
labelsColorThe color of the labels.null
labelsFontThe font used to render the labels.null
labelsSizeThe size of the labels.null
labelsBoldWhether the labels are bold or not.null
labelsItalicWhether the labels are italic or not.null
labelsPositionThis can be either center or edge and determines the position of the labels.center
labelsAxesThis controls the axes that show the scale labels. Each letter stands for the appropriate axis (North, South, East and West).n
labelsAxesCountThis determines the number of labels that are displayed on the axes.5
labelsAxesFontThe font used by the axes labels.null
labelsAxesSizeThe size of the axes labels.null
labelsAxesColorThe color of the axes labels.null
labelsAxesBoldWhether the labels are bold or not.null
labelsAxesItalicWhether the labels are italic or not.null
textAccessible
A new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:
<div style="margin-left: 50px; display: inline-block">
<canvas id="cvs" width="650" height="250"></canvas>
</div>

Default: true

textAccessibleOverflow
This can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish.
Default: visible

textAccessiblePointerevents
This controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).
Default: true

textBold
Whether the text is bold or not.
Default: false

textItalic
Whether the text is italic or not.
Default: false

textFont
The font used to render the text.
Default: Arial, Verdana, sans-serif

textColor
The color of the labels.
Default: black

textSize
The size of the text.
Default: 12

labels
The labels, if any, for the chart.
Default: none

labelsColor
The color of the labels.
Default: null

labelsFont
The font used to render the labels.
Default: null

labelsSize
The size of the labels.
Default: null

labelsBold
Whether the labels are bold or not.
Default: null

labelsItalic
Whether the labels are italic or not.
Default: null

labelsPosition
This can be either center or edge and determines the position of the labels.
Default: center

labelsAxes
This controls the axes that show the scale labels. Each letter stands for the appropriate axis (North, South, East and West).
Default: n

labelsAxesCount
This determines the number of labels that are displayed on the axes.
Default: 5

labelsAxesFont
The font used by the axes labels.
Default: null

labelsAxesSize
The size of the axes labels.
Default: null

labelsAxesColor
The color of the axes labels.
Default: null

labelsAxesBold
Whether the labels are bold or not.
Default: null

labelsAxesItalic
Whether the labels are italic or not.
Default: null

Title properties

PropertyDescriptionDefault
titleThe title of the chart.none
titleFontThe font that the title is rendered in. If not specified the textFont setting is used (usually Arial).null
titleSizeThe size of the title. If not specified the size is usually 2pt bigger than the textSize setting.null
titleBoldWhether the title is bold or not.true
titleItalicWhether the title is italic or not.false
titleColorThe color of the title.black
titleBackgroundThe background color (if any) for the title.null
titleXTo give the exact X coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null
titleYTo give the exact Y coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null
title
The title of the chart.
Default: none

titleFont
The font that the title is rendered in. If not specified the textFont setting is used (usually Arial).
Default: null

titleSize
The size of the title. If not specified the size is usually 2pt bigger than the textSize setting.
Default: null

titleBold
Whether the title is bold or not.
Default: true

titleItalic
Whether the title is italic or not.
Default: false

titleColor
The color of the title.
Default: black

titleBackground
The background color (if any) for the title.
Default: null

titleX
To give the exact X coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.
Default: null

titleY
To give the exact Y coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.
Default: null

Scale properties

PropertyDescriptionDefault
scaleMaxThis 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.null
scaleRoundWhether to round the maximum scale value up or not. This will produce slightly better scales in some instances.null
scalePointThe character used as the decimal point..
scaleThousandThe character used as the thousand separator.,
scaleDecimalsThis stipulates how many decimal places there are.0
scaleUnitsPreThe units that are prepended to the scale labels.none
scaleUnitsPostThe units that are appended to the scale labels.none
scaleMax
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

scaleRound
Whether to round the maximum scale value up or not. This will produce slightly better scales in some instances.
Default: null

scalePoint
The character used as the decimal point.
Default: .

scaleThousand
The character used as the thousand separator.
Default: ,

scaleDecimals
This stipulates how many decimal places there are.
Default: 0

scaleUnitsPre
The units that are prepended to the scale labels.
Default: none

scaleUnitsPost
The units that are appended to the scale labels.
Default: none

Key properties

The key properties are documented on the key documentation page.

Interactive features properties

PropertyDescriptionDefault
tooltipsA numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.An empty array
tooltipsEventThis is the event that triggers the tooltips. It can be either click or mousemove.click
tooltipsEffectThe effect used for showing tooltips. Can be either fade or none.fade
tooltipsCssClassThis is the name of the CSS class the chart uses.RGraph_tooltip
tooltipsOverrideIf 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.null
tooltipsNohideonclearNot an option that you'll need particularly often if at all. Setting this to true means that when you call the RGraph.clear() API function tooltips do not get hidden.false
contextmenuAn array of context menu items. More information about context menus is here.[] (An empty array)
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotatableColorIf you do not allow the use of the palette, then this will be the only color allowed for annotations.black
annotatableLinewidthThis is the linewidth of the annotations.1
tooltips
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.
Default: An empty array

tooltipsEvent
This is the event that triggers the tooltips. It can be either click or mousemove.
Default: click

tooltipsEffect
The effect used for showing tooltips. Can be either fade or none.
Default: fade

tooltipsCssClass
This is the name of the CSS class the chart uses.
Default: RGraph_tooltip

tooltipsOverride
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

tooltipsNohideonclear
Not an option that you'll need particularly often if at all. Setting this to true means that when you call the RGraph.clear() API function tooltips do not get hidden.
Default: false

contextmenu
An array of context menu items. More information about context menus is here.
Default: [] (An empty array)

annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false

annotatableColor
If you do not allow the use of the palette, then this will be the only color allowed for annotations.
Default: black

annotatableLinewidth
This is the linewidth of the annotations.
Default: 1

Event properties

PropertyDescriptionDefault
eventsClickIf you want to add your own click function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own mousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own mouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own mouseout function you can do so by assigning it to this property. See here for details.null
eventsClick
If you want to add your own click function you can do so by assigning it to this property. See here for details.
Default: null

eventsMousemove
If you want to add your own mousemove function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseover
If you want to add your own mouseover function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseout
If you want to add your own mouseout function you can do so by assigning it to this property. See here for details.
Default: null

Miscellaneous properties

PropertyDescriptionDefault
highlightStyleBy default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument.null
highlightStrokeIf you use tooltips, this controls the color of the highlight stroke.black
highlightFillIf you use tooltips, this controls the color of the highlight fill.rgba(255,255,255,0.5)
variantThis option can be either stacked (the default) or non-equi-angular. Just because this option is set to stacked does not automatically mean your chart is stacked. If you don't supply the appropriate data you chart may well appear as a regular Rose chart. Examples of appropriate data:

A regular Rose chart

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [8,5,4,8,6,7,2,3,5,8],
    options: {
        // variant: '3d'
    }
}).draw();

A stacked Rose chart

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [[2,6],[2,4],[1,5],[4,3],[7,5],[8,3],[4,5],[3,4],[2,6],[4,5]],
    options: {
        variant: 'stacked'
        // variant: 'stacked3d'
    }
}).draw();

A non-equi-angular Rose chart

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [[45,23],[45,23],[5,26],[78,4],[49,12],[49,21],[40,18],[48,12],[43,23],[45,12]],
    options: {
        variant: 'non-equi-angular'
        //variant: 'non-equi-angular3d'
    }
}).draw();

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.

.
stacked
variantThreedDepthThis is the depth/thickness of the Rose chart when in 3D mode. Using larger depths can make the labels be drawn over the labels.10
explodedThis stipulates the exploded value for a segment. It can either be a number which is applied to all segments, or an array of separate values (eg [15,0,20,25]). The values are the distance from the center that the segment is.0
cleartoThis is used in animations and effects as the default color to use when the canvas.null
segmentHighlightIf you wish you can have segments of the chart highlight as you move the mouse around.false
segmentHighlightCountThe number of segments by default corresponds to the number of "radials" that the background grid has but using this property you can set it explicitly.null
segmentHighlightFillThe fill color of the highlight.rgba(0,255,0,0.5)
segmentHighlightStrokeThe stroke color of the highlight.rgba(0,0,0,0)
highlightStyle
By default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument.
Default: null

highlightStroke
If you use tooltips, this controls the color of the highlight stroke.
Default: black

highlightFill
If you use tooltips, this controls the color of the highlight fill.
Default: rgba(255,255,255,0.5)

variant
This option can be either stacked (the default) or non-equi-angular. Just because this option is set to stacked does not automatically mean your chart is stacked. If you don't supply the appropriate data you chart may well appear as a regular Rose chart. Examples of appropriate data:

A regular Rose chart

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [8,5,4,8,6,7,2,3,5,8],
    options: {
        // variant: '3d'
    }
}).draw();

A stacked Rose chart

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [[2,6],[2,4],[1,5],[4,3],[7,5],[8,3],[4,5],[3,4],[2,6],[4,5]],
    options: {
        variant: 'stacked'
        // variant: 'stacked3d'
    }
}).draw();

A non-equi-angular Rose chart

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [[45,23],[45,23],[5,26],[78,4],[49,12],[49,21],[40,18],[48,12],[43,23],[45,12]],
    options: {
        variant: 'non-equi-angular'
        //variant: 'non-equi-angular3d'
    }
}).draw();

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

variantThreedDepth
This is the depth/thickness of the Rose chart when in 3D mode. Using larger depths can make the labels be drawn over the labels.
Default: 10

exploded
This stipulates the exploded value for a segment. It can either be a number which is applied to all segments, or an array of separate values (eg [15,0,20,25]). The values are the distance from the center that the segment is.
Default: 0

clearto
This is used in animations and effects as the default color to use when the canvas.
Default: null

segmentHighlight
If you wish you can have segments of the chart highlight as you move the mouse around.
Default: false

segmentHighlightCount
The number of segments by default corresponds to the number of "radials" that the background grid has but using this property you can set it explicitly.
Default: null

segmentHighlightFill
The fill color of the highlight.
Default: rgba(0,255,0,0.5)

segmentHighlightStroke
The stroke color of the highlight.
Default: rgba(0,0,0,0)

Methods

obj.get(name)
An accessor that you can use to retrieve the values of properties.

obj.set(name, value)
An accessor that you can use to set the values of properties.

obj.getShape(event)

obj.getShape() makes it easy to determine which segment of the Rose chart was clicked on. It provides:

The shape also includes textual indexes like this: shape['object'] And they are:

<script>
    RGraph.register(myGraph);
    
    myGraph.canvas.onclick = function (e)
    {
        RGraph.fixEventObject(e);
        RGraph.redraw();

        var ca  = e.target;
        var co  = ca.getContext('2d');
        var obj = ca.__object__;
        var segment = obj.getShape(e);
        
        if (segment) {
            co.fillStyle = 'rgba(255,255,255,0.5)';
            co.beginPath();            
                co.moveTo(segment[0], segment[1]);
                co.arc(segment[0], segment[1], segment[3], segment[4], segment[5], 0);
                co.arc(segment[0], segment[1], segment[2], segment[5], segment[4], true);
            co.stroke();
            co.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.

obj.getRadius(value)

This method can be used to get the relevant radius for a given scale value.

obj.on(event, function)

This method can be used to set an event listener on an object. It operates in a similar way to the jQuery on() function. The first argument is the event that you wish to attach to and the second is the handler function. For example:

.on('draw', function (obj)
{
    // Put event code here
});

The function is useful if you use method chaining when creating your charts:

var obj = new RGraph.Rose({
    id: 'cvs',
    data: [4,8,6,3,5,8,4,6]
}).on('draw', function (e, shape)
{
    // Put ondraw code here
}).on('click', function (e, shape)
{
    // Handle click event
}).draw();
The exec option and method

The exec function is documented here.

Stacked Rose charts

Rose charts can now be stacked, much like stacked Bar charts. For examples see the Rose chart example pages in the download archive. The data for a stacked Rose chart should be supplied in the same format as a stacked Bar chart:

<script>
    new RGraph.Rose({
        id: 'cvs',
        data: [[4,6,2],[8,4,7],[4,3,6],[1,5,6]],
        options: {
        }
    }).draw();
</script>

Non-equi-angular Rose charts

Rose charts can be displayed in a non-equi-angular mode. For an example see this Rose chart demo page in the download archive: rose-non-equi-angular.html. 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 size of the angle - this is calculated. For example:

<script>
    new RGraph.Rose({
        id: 'cvs',
        data: [[47,6],[48,2],[40,4],[43,5],[45,6]],
        options: {
            variant: 'non-equi-angular'
        }
    }).draw();
</script>

Animation effects

These effects are available and can be used instead of the draw() function. There are also generic effects available which you can see here: Generic effects and transitions
<script>
    // Optional callback function that's called when the effect is complete
    function myCallback (obj)
    {
        // ...
    }

    new RGraph.Rose({
        id: 'cvs',
        data: [8,6,3,5,2,4,8],
        options: {
            marginLeft: 35
        }
    }).grow({frames: 60}, myCallback)
    // .roundRobin({frames: 60}, myCallback)
    // .implode({frames: 60}, myCallback)
    // .explode({frames: 60}, myCallback)
</script>