About
RGraph is a JavaScript charts library based on HTML5 SVG and canvas. RGraph is mature (over 15 years old) and has a wealth of features making it an ideal choice to show charts on your website.

More »

 

Download
Get the latest version of RGraph (version 6.17) from the download page. There's also older versions available, minified files and links to cdnjs.com hosted libraries.

More »

 

License
RGraph can be used for free under the GPL or if that doesn't suit your situation there's an inexpensive (£129) commercial license available.

More »

Rose chart API reference

Example

<script>
    // This is the data for the Rose chart
    data = [
        [8,6,9], [4,8,5], [6,2,11], [8,5,3],
        [2,4,3], [8,6,4], [4,4,9], [4,8,9],
        [7,3,2], [8,4,6], [4,8,6], [7,5,9]
    ];

    rose = new RGraph.SVG.Rose({
        id: 'chart-container',
        data: data,
        options: {
            scaleUnitsPost: 'j',
            backgroundGridColor: '#aaa',
            backgroundGridRadialsCount: 0,
            names: ['Richard','Fred','Gloria'],
            tooltips: '%{property:names[%{index}]}:<br /><span style="font-size: 20pt">%{value_formatted}</span>',
            tooltipsFormattedUnitsPost: 'kg',
            tooltipsCss: {
                backgroundColor: '#333',
                fontWeight: 'bold',
                fontSize: '14pt',
                opacity: 0.85
            },
            marginTop: 70,
            colors: ['#faa', '#afa', '#aaf'],
            colorsOpacity: 0.75,
            colorsStroke: 'rgba(0,0,0,0)',
            labels: ['Jan','Feb', 'Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec'],
            labelsRadialMargin: 20,
            exploded: 5
        }
    }).draw();
</script>

Types of Rose charts

There are four main types of Rose charts available:

The angles and angles2 properties

Formerly this array contained details of the segment. However, as of version 5, this has now changed so that the only element is one called element. This is a reference to the svg path element which has various data attributes set on it which can give you the details of the segment. These data attributes are:

The difference between the angles and angles2 arrays is how they're indexed. So with a stacked chart that has four stacks and 3 segments per stack the obj.coords array would be arranged like this:

The coordinates are appended to the array. The obj.coords2 on the other hand is arranged two dimensionally:

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

Name: centerx
Description: 
If required, you can position the Rose chart using this instead of the margins. As well as a number, that gives the exact coordinate of the center position of the chart, this can also be a string like this: centerx: '+25' or this: centerx: '-40' which is then used to adjust the calculated coordinate.
Default: null
Name: centery
Description: 
If required, you can position the Rose chart using this instead of the margins. As well as a number, that gives the exact coordinate of the center position of the chart, this can also be a string like this: centery: '+25' or this: centery: '-40' which is then used to adjust the calculated coordinate.
Default: null
Name: radius
Description: 
If required, you can size the Rose chart using this instead of the margins. As well as a number, that gives the exact coordinate of the center position of the chart, this can also be a string like this: radius: '+25' or this: radius: '-40' which is then used to adjust the calculated coordinate.
Default: null

Background properties

Name: backgroundGrid
Description: 
Whether the background grid is displayed or not.
Default: true
Name: backgroundGridColor
Description: 
The color of the background grid.
Default: #ddd
Name: backgroundGridRadialsCount
Description: 
The number of lines that emanate from the center outwards. Set this to zero to disable them. By default, the amount is matched to the number of data pieces that you have.
Default: null
Name: backgroundGridConcentricsCount
Description: 
The number of concentric background grid circles that are displayed.
Default: 5
Name: backgroundGridLinewidth
Description: 
The linewidth of the background grid lines.
Default: 1
Name: backgroundGridRadialsAngleOffset
Description: 
This is the angular offset that's applied to the background grid radials (that emanate from the center outwards). It's measured in radians.
Default:  0

Margin properties

Name: marginLeft
Description: 
The left margin of the chart, (the margin is where the labels and title are)).
Default: 35
Name: marginRight
Description: 
The right margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginTop
Description: 
The top margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginBottom
Description: 
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginInner
Description: 
This is the margin that's applied to each segment. So by increasing this value it results in making each segment thinner. It can be a number - in which case it's measured using radians (so use 0.1 for example) or it can be a string like this: 5deg in which case it's measured in degrees - so a setting of 5deg would usually be adequate.
Default: 3deg

Color properties

Name: colors
Description: 
Colors to be used for the Rose segments.
Default: ['red', 'black', 'orange', 'green', '#6ff', '#ccc', 'pink', 'orange', 'cyan', 'maroon', 'olive', 'teal']
Name: colorsSequential
Description: 
Normal color use is per stack/group but if you want the colors used sequentially then set this to true.
Default: false
Name: colorsOpacity
Description: 
This is the opacity value that's applied to the colors of the segments.
Default: 1
Name: colorsStroke
Description: 
The color of the separating lines.
Default: white

Labels and text properties

Name: textSize
Description: 
The size of the text.
Default: 12
Name: textFont
Description: 
The font used to render the text.
Default: Arial, Verdana, sans-serif
Name: textColor
Description: 
The color of the labels.
Default: black
Name: textItalic
Description: 
Whether the labels are italic or not.
Default: false
Name: textBold
Description: 
Whether the labels are bold or not.
Default: false
Name: text
Description: 
This allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.
Default: null
Name: labels
Description: 
An array of the labels that are arranged in a circle around the Rose chart.
Default: [] (an empty array)
Name: labelsFont
Description: 
The font that the circular labels use.
Default: null
Name: labelsSize
Description: 
The size of the circular labels.
Default: null
Name: labelsColor
Description: 
The color of the circular labels.
Default: null
Name: labelsBold
Description: 
Whether the circular labels are bold or not.
Default: null
Name: labelsItalic
Description: 
Whether the circular labels are italic or not.
Default: null
Name: labelsRadialMargin
Description: 
The extra distance that, in addition to the radius, the labels are positioned.
Default: 10
Name: labelsAnglesOffset
Description: 
If you want to specify an offset angle for the labels (so you can move the labels around the chart) then this is the option to use. It's measured in radians.
Default:  0
Name: labelsFormattedDecimals
Description: 
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default:  0
Name: labelsFormattedPoint
Description: 
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .
Name: labelsFormattedThousand
Description: 
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,
Name: labelsFormattedUnitsPre
Description: 
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: labelsFormattedUnitsPost
Description: 
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: scaleVisible
Description: 
Whether the scale is visible or not.
Default: true
Name: scaleMax
Description: 
The maximum scale value. By default, it's calculated for you.
Default: null
Name: scaleFont
Description: 
The font used to render the text in.
Default: null
Name: scaleSize
Description: 
The size of the scale text.
Default: null
Name: scaleBold
Description: 
Whether the scale text is bold or not.
Default: null
Name: scaleItalic
Description: 
Whether the scale text is italic or not.
Default: null
Name: scaleColor
Description: 
The color of the scale labels.
Default: null
Name: scaleUnitsPre
Description: 
The units that are added before each label.
Default: (an empty string)
Name: scaleUnitsPost
Description: 
The units that are added after each label.
Default: (an empty string)
Name: scalePoint
Description: 
The character(s) that are used as the decimal point.
Default: .
Name: scaleThousand
Description: 
The character(s) that are used as the thousand separator.
Default: ,
Name: scaleDecimals
Description: 
The number of decimals that are shown on the scale.
Default:  0
Name: scaleLabelsCount
Description: 
The number of labels that are shown on the scale (not including the zero label).
Default: 5
Name: scaleFormatter
Description: 
This can be a function that is passed the object and number as the arguments and should return the formatted number. This allows you to completely control the formatting used on the scale. For example:
scaleFormatter: function (obj, num)
{
},
Default: null

Title properties

Name: title
Description: 
The title of the chart.
Default: (An empty string)
Name: titleX
Description: 
The specific x-axis coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null
Name: titleY
Description: 
The specific y-axis coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null
Name: titleOffsetx
Description: 
An offset value that is added to the calculated x-axis coordinate.
Default:  0
Name: titleOffsety
Description: 
An offset value that is added to the calculated y-axis coordinate.
Default:  0
Name: titleHalign
Description: 
The horizontal alignment of the title.
Default: center
Name: titleColor
Description: 
The color of the title. It defaults to be the same as the textColor property.
Default: null
Name: titleFont
Description: 
The font used to render the title.
Default: null
Name: titleSize
Description: 
The size of the font used to render the title. It defaults to be a little larger than the textSize property.
Default: null
Name: titleBold
Description: 
Whether the title is bold or not.
Default: null
Name: titleItalic
Description: 
Whether the title is italic or not.
Default: null
Name: titleSubtitle
Description: 
The subtitle of the chart. If a subtitle is specified the title is moved up to accommodate it. As such you might need to give a larger marginTop value.
Default: (An empty string)
Name: titleSubtitleColor
Description: 
The color of the subtitle.
Default: #aaa
Name: titleSubtitleFont
Description: 
The font used to render the subtitle.
Default: null
Name: titleSubtitleSize
Description: 
The size of the font used to render the subtitle. It defaults to be slightly smaller than the textSize setting.
Default: null
Name: titleSubtitleBold
Description: 
Whether the subtitle is bold or not.
Default: null
Name: titleSubtitleItalic
Description: 
Whether the subtitle is italic or not.
Default: null

Key properties

Name: key
Description: 
An array of the labels that appear on the key.
Default: null
Name: keyColors
Description: 
An array of colors to be shown on the key. If not specified then the colors option will be used instead.
Default: null
Name: keyLabelsColor
Description: 
The color of the text in the key.
Default: null
Name: keyLabelsBold
Description: 
Whether the key text is bold or not.
Default: null
Name: keyLabelsFont
Description: 
The font to use for the key text.
Default: null
Name: keyLabelsSize
Description: 
The size to use for the key text.
Default: null
Name: ketLabelsItalic
Description: 
Whether the key text is italic or not.
Default: null
Name: keyLabelsOffsetx
Description: 
The horizontal pixel offset of the key text (just the text).
Default:  0
Name: keyLabelsOffsety
Description: 
The vertical pixel offset of the key text (just the text).
Default: -1
Name: keyOffsetx
Description: 
The horizontal pixel offset of the entire key.
Default:  0
Name: keyOffsety
Description: 
The horizontal pixel offset of the entire key.
Default:  0
Name: keyColorShape
Description: 
This controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are: rect circle triangle line dot rectdot
Default: rect

Tooltip properties

Name: tooltips
Description: 
An array of tooltips for the chart. This array should NOT be multidimensional - even for stacked charts. You can also check the canvas tooltips documentation for more information.
Default: null
Name: tooltipsOverride
Description: 
This can be a function that handles the tooltip showing instead of the default RGraph tooltips. It should look like this:
tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}
The opt is an argument that contains these items:
  • object The chart object.
  • index The index of the element (that triggered the tooltip).
  • sequentialIndex The sequential index of the element that was clicked.
  • text The text to be used as the tooltip. Remember that this may contain html (or whatever else you may have specified).
  • event The event object (either a click or mousemove event).
Default: null
Name: tooltipsEvent
Description: 
The event used for tooltips (either click or mousemove.
Default: click
Name: tooltipsFormattedPoint
Description: 
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .
Name: tooltipsFormattedThousand
Description: 
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,
Name: tooltipsFormattedDecimals
Description: 
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default:  0
Name: tooltipsFormattedUnitsPre
Description: 
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)
Name: tooltipsFormattedUnitsPost
Description: 
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)
Name: tooltipsFormattedKeyLabels
Description: 
The labels that are used in the formatted tooltip key.
Default: [] (an empty array)
Name: tooltipsFormattedKeyColors
Description: 
The colors that are used in the formatted tooltip key. Normally these are automatically taken from the colors on the chart but can be specified differently using this property.
Default: null
Name: tooltipsFormattedKeyColorsShape
Description: 
This is the shape that's used in the tooltip key. It can be square or circle
Default: square
Name: tooltipsFormattedKeyColorsCss
Description: 
By using this property you can add css values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of css properties like this:
tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}
Default: null
Name: tooltipsFormattedListType
Description: 
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.
Default: ul
Name: tooltipsFormattedListItems
Description: 
This should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]
You can use css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}
Default: null
Name: tooltipsFormattedTableHeaders
Description: 
When showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.
Default: null
Name: tooltipsFormattedTableData
Description: 
This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example in the canvas documentation, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)
Name: tooltipsPointer
Description: 
By default, the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.
Default: true
Name: tooltipsPointerCss
Description: 
If you want any css values applied to the tooltips pointer (a css border, for example) then specify an object containing those values to this property. For example:
tooltips: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}
Default: null
Name: tooltipsPointerOffsetx
Description: 
This allows you to adjust the horizontal position of the tooltips pointer.
Default:  0
Name: tooltipsPointerOffsety
Description: 
This allows you to adjust the vertical position of the tooltips pointer.
Default:  0
Name: tooltipsPositionStatic
Description: 
The new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.
Default: true
Name: tooltipsCss
Description: 
If you want to specify some css that gets applied to all of the tooltips, but don't want to use the RGraph.SVG.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object css for the tooltips. These are css styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}
Default: null
Name: tooltipsCssClass
Description: 
The css class that's applied to the tooltip div.
Default: RGraph_tooltip
Name: tooltipsOffsetx
Description: 
This property allows you to shift the tooltips left or right.
Default:  0
Name: tooltipsOffsety
Description: 
This property allows you to shift the tooltips up or down.
Default:  0

Highlight properties

Name: highlightStroke
Description: 
The color of the stroke of the highlight.
Default: rgba(0,0,0,0)
Name: highlightFill
Description: 
The color of the fill of the highlight.
Default: rgba(255,255,255,0.7)
Name: highlightLinewidth
Description: 
The linewidth of the stroke of the highlight.
Default: 1

Other properties

Name: linewidth
Description: 
The linewidth of the separating lines.
Default: 1
Name: exploded
Description: 
This can either be a number or an array and controls by how much the segments are exploded.
Default:  0
Name: segmentsAngleOffset
Description: 
This is the angular offset that affects the segments. It's measured in radians.
Default:  0
Name: variant
Description: 
This can be normal or non-equi-angular and determines what type of chart will be shown. The stacked variations of each type are triggered by using arrays of numbers instead of just regular numbers.
Default: regular
Name: responsive
Description: 
This option is new to the July 2023 release (v6.13) and allows you to inline the responsive configuration instead of appending it on to the end of the object it as a function. The documentation and demo pages have been updated to use this new option. You can read more about the responsive feature by reading the responsive configuration page.
Default: null

Methods

obj.get(name)

This can be used to get properties if necessary. It's normally used after the chart is drawn if you need to get parameters (if you're doing custom coding for example).

obj.set(name, value)

This can be used to set properties if necessary. It's normally used after the chart is drawn if you need to set additional configuration properties or change them.

obj.on(event, handler)

This function adds an event listener (such as beforedraw or draw) to the chart object. For example:

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

This function can be used to execute a function (immediately). It's not event-based (ie it doesn't run when something happens) - it just runs immediately - and only once. You might use it when you need to get something from the chart when it's drawn and then call the redraw function. Because this function only runs once the RGraph.SVG.redraw function would not cause a loop - which would happen if you used the draw event.

obj.exec(function (obj)
{
    // Put your code here
});
obj.responsive(configuration)

The responsive function helps your charts respond to different browser window sizes and screen resolutions. For example, for smaller screens, you might want to have angled labels or show shorter versions of them completely.

Update: There is now the responsive configuration option available to you and this is now the preferred method of configuration.

The responsive function and configuration option are documented on their own page here.

Data properties that are used on the segments

The svg path elements that represent the segments on the Rose chart have various data attributes added to them that hold various bits of information. These are:

These can be retrieved by using standard dom methods:

obj.angles[0].element.getAttribute('data-radius');

Events

RGraph supports custom events that allow you to easily add interactivity to your charts if required. The following events are available:

For example:
new RGraph.SVG.Rose({
    id: 'chart-container',
    data: [4,8,6,3,5,8,9],
    options: {
    }
}).on('tooltip', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();

Effects

Two effects are available to you. These effects work with all of the modes of operation that the Rose chart has:

The demo pages are: