Rose chart

Example

<script>
    data   = [10,5,8,3,9,4,6,10,5,3,6,8,4,9];
    labels = ['John','Richard','Paul','Pete','Lou','Olga','Neil','Ken','Luis','John','Gary','Paul','Fay','Will'];

    new RGraph.Rose({
        id: 'cvs',
        data: data,
        options: {
            colors: ['red'],
            backgroundGridRadialsCount: 0,
            labels: labels,
            tooltips: '%{key}',
            tooltipsFormattedUnitsPost: 'kg',
            tooltipsFormattedKeyLabels: labels,
            margin: 5,
            tooltipsCss: {
                fontSize: '20pt',
                boxShadow: '',
                textAlign: 'left'
            }
        }
    }).draw();
</script>
View example on CodePen

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
backgroundGridRadialsOffsetThe offset that is applied to the background grid radial lines (this is measured in radians). 0
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

backgroundGridRadialsOffset
The offset that is applied to the background grid radial lines (this is measured in radians).
Default: 0

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)).35
marginRightThe right margin of the chart, (the margin is where the labels and title are).35
marginTopThe top margin of the chart, (the margin is where the labels and title are).35
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).35
marginThis is the margin that is on 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: 35

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

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

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

margin
This is the margin that is on 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 sequentially 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 sequentially 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 a 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>
false
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. You can also give this option a string if you prefer and use formatted labels.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
labelsOffsetRadiusTo offset the labels either away from or towards the Rose chart then this is the property to use for that. 0
labelsFormattedDecimalsWhen using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. 0
labelsFormattedPointWhen using formatted labels this is the decimal point character that's used with the %{value_formatted} macro..
labelsFormattedThousandWhen using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.,
labelsFormattedUnitsPreWhen using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.(an empty string)
labelsFormattedUnitsPostWhen using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.(an empty string)
labelsClassThis property allows you to add your own CSS class to the labels which you can then use for styling purposes or to make retrieving the span tags easier (the DOM elements). If you inspect the labels in your browser's JavaScript console (you will first need to enable the textAccessiblePointerevents property) you will be able to see the other CSS classes that are assigned to the labels.[none]
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
labelsAxesOffsetxThis allows you finer-grained control in the horizontal direction over the positioning of the axes labels. 0
labelsAxesOffsetyThis allows you finer-grained control in the vertical direction over the positioning of the axes labels. 0
textThis allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.null
textAccessible
A new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for a 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: false

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. You can also give this option a string if you prefer and use formatted labels.
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

labelsOffsetRadius
To offset the labels either away from or towards the Rose chart then this is the property to use for that.
Default: 0

labelsFormattedDecimals
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default: 0

labelsFormattedPoint
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .

labelsFormattedThousand
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,

labelsFormattedUnitsPre
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)

labelsFormattedUnitsPost
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)

labelsClass
This property allows you to add your own CSS class to the labels which you can then use for styling purposes or to make retrieving the span tags easier (the DOM elements). If you inspect the labels in your browser's JavaScript console (you will first need to enable the textAccessiblePointerevents property) you will be able to see the other CSS classes that are assigned to the labels.
Default: [none]

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

labelsAxesOffsetx
This allows you finer-grained control in the horizontal direction over the positioning of the axes labels.
Default: 0

labelsAxesOffsety
This allows you finer-grained control in the vertical direction over the positioning of the axes labels.
Default: 0

text
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

Title properties

PropertyDescriptionDefault
titleThe title of the chart, if any.null
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 4pt bigger than the textSize setting.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleColorThe color of 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
titleHalignThe horizontal alignment of the title.center (can change depending on other options)
titleValignThe vertical alignment of the title.center (can change depending on other options)
titleOffsetxYou can use this property to adjust the positioning of the title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left). 0
titleOffsetyYou can use this property to adjust the positioning of the title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards). 0
titleSubtitleThe 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.null
titleSubtitleSizeThe size of the font used to render the subtitle.null
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleBoldWhether the subtitle is bold or not.null
titleSubtitleItalicWhether the subtitle is italic or not.null
titleSubtitleOffsetxUse this property to adjust the horizontal position of the subtitle. 0
titleSubtitleOffsetyUse this property to adjust the vertical position of the subtitle. 0
title
The title of the chart, if any.
Default: null

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 4pt bigger than the textSize setting.
Default: null

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

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

titleColor
The color of 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

titleHalign
The horizontal alignment of the title.
Default: center (can change depending on other options)

titleValign
The vertical alignment of the title.
Default: center (can change depending on other options)

titleOffsetx
You can use this property to adjust the positioning of the title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left).
Default: 0

titleOffsety
You can use this property to adjust the positioning of the title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards).
Default: 0

titleSubtitle
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: null

titleSubtitleSize
The size of the font used to render the subtitle.
Default: null

titleSubtitleColor
The color of the subtitle.
Default: #aaa

titleSubtitleFont
The font used to render the subtitle.
Default: null

titleSubtitleBold
Whether the subtitle is bold or not.
Default: null

titleSubtitleItalic
Whether the subtitle is italic or not.
Default: null

titleSubtitleOffsetx
Use this property to adjust the horizontal position of the subtitle.
Default: 0

titleSubtitleOffsety
Use this property to adjust the vertical position of the subtitle.
Default: 0

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 that's used as the decimal point..
scaleThousandThe character that's 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 that's used as the decimal point.
Default: .

scaleThousand
The character that's 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. Possible values are slide fade or none.slide
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
tooltipsFormattedPointWhen using formatted tooltip strings this is used as the point when using the %{value_formatted} option..
tooltipsFormattedThousandWhen using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.,
tooltipsFormattedDecimalsWhen using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option. 0
tooltipsFormattedUnitsPreWhen using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedUnitsPostWhen using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedKeyColorsWhen using formatted tooltip strings you can give specific colors for the %{key} option to use.null
tooltipsFormattedKeyColorsShapeThis is the shape that's used in the tooltip key. It can be square or circlesquare
tooltipsFormattedKeyColorsCss 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";
}
null
tooltipsFormattedKeyLabelsWhen using formatted tooltip strings these are the labels that are displayed.[] (an empty array)
tooltipsFormattedListTypeWith this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.ul
tooltipsFormattedListItemsThis 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;
}
null
tooltipsFormattedTableHeadersWhen 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.null
tooltipsFormattedTableDataThis 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, copy the code from it and then modify it suit. You'll create fewer bugs this way.null)
tooltipsPointerBy 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.true
tooltipsPointerCssIf 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:
tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}
null
tooltipsPositionStaticThe 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.true
tooltipsCssIf you want to specify some CSS that gets applied to all of the tooltips, but don't want to use the RGraph.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'
}
null
tooltipsCssClassThis is the name of the CSS class the chart uses.RGraph_tooltip
tooltipsOffsetxThis property allows you to shift the tooltips left or right. 0
tooltipsOffsetyThis property allows you to shift the tooltips up or down. 0
tooltipsHotspotIgnoreThis can be a number of things and can be used to ignore certain tooltip hotspots - which can allow charts to the rear to be clickable. There's an example of this in the download archive called pie-tooltipshotspotignore.html. You can use the transparent color to allow the rear chart to be seen in such a case. It can be:
  • A single boolean value (ie true or false) to enable or disable all of the hotspots - true means the hotspot will be ignored
  • A single number (the zero-indexed number corresponding to the hotspot to ignore)
  • An array of numbers (the numbers are the indexes of hotspots to ignore)
  • An array of boolean true or false values - the position of these values correspond to the index(es) of the segments to ignore (for example [false, false, true, false, false] - true means the corresponding hotspot will be ignored)
null
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. Possible values are slide fade or none.
Default: slide

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

tooltipsFormattedPoint
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .

tooltipsFormattedThousand
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,

tooltipsFormattedDecimals
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default: 0

tooltipsFormattedUnitsPre
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedUnitsPost
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedKeyColors
When using formatted tooltip strings you can give specific colors for the %{key} option to use.
Default: null

tooltipsFormattedKeyColorsShape
This is the shape that's used in the tooltip key. It can be square or circle
Default: square

tooltipsFormattedKeyColorsCss
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

tooltipsFormattedKeyLabels
When using formatted tooltip strings these are the labels that are displayed.
Default: [] (an empty array)

tooltipsFormattedListType
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.
Default: ul

tooltipsFormattedListItems
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

tooltipsFormattedTableHeaders
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

tooltipsFormattedTableData
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, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)

tooltipsPointer
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

tooltipsPointerCss
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:
tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

Default: null

tooltipsPositionStatic
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

tooltipsCss
If you want to specify some CSS that gets applied to all of the tooltips, but don't want to use the RGraph.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

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

tooltipsOffsetx
This property allows you to shift the tooltips left or right.
Default: 0

tooltipsOffsety
This property allows you to shift the tooltips up or down.
Default: 0

tooltipsHotspotIgnore
This can be a number of things and can be used to ignore certain tooltip hotspots - which can allow charts to the rear to be clickable. There's an example of this in the download archive called pie-tooltipshotspotignore.html. You can use the transparent color to allow the rear chart to be seen in such a case. It can be:
Default: null

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

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. As of version 5.23 you can also set this to invert as well. If you do this on a dark background you may find that you need to change the highlightFill color setting as well.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 your 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 that 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 clearing 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. As of version 5.23 you can also set this to invert as well. If you do this on a dark background you may find that you need to change the highlightFill color setting as well.
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 your 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 that 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 clearing 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)
This method makes it easy to get hold of which segment has been clicked on or hovered over. It returns an object which has the following indexes available:
object The chart object
x This is the center X coordinate for the segment.
y This is the center Y coordinate for the segment.
radiusStart This is the start radius of the segment. Because you can have stacked segments in a Rose chart this is necessary.
radiusEnd This is the end radius of the segment.
angleStart This is the start angle of the segment. It's measured in radians - not degrees. 1 radian = 57.29 degrees.
angleEnd This is the end angle of the segment. It's measured in radians - not degrees. 1 radian = 57.29 degrees.
dataset This is the group that the segment or part-segment belongs to. In a regular Rose chart, each segment has a distinct group number. On a stacked Rose chart, this identifies each stack of part-segments. In a non-equi-angular chart, this is always zero.
index The zero-indexed index of the segment on the chart. In a stacked Rose chart this is the index in a particular stack, whereas in a regular Rose chart this is the index of the segment in the whole dataset. Likewise for a non-equi-angular dataset.
sequentialIndex This is the zero-indexed sequential index of the segment on the chart. No matter what the type of Rose chart that you're showing this just starts at zero and counts up for each segment.
tooltip If a tooltip is associated with this segment this will be it. id: strings are expanded for you (where the tooltip text is retrieved from the HTML tag with the matching ID).
<script>
    rose.canvas.onclick = function (e)
    {
        RGraph.redraw();
    
        var canvas  = e.target,
            obj     = canvas.__object__,
            shape   = obj.getShape(e);

        if (shape) {
            
            var x           = shape.x,
                y           = shape.y,
                radiusStart = shape.radiusStart,
                radiusEnd   = shape.radiusEnd,
                angleStart  = shape.angleStart,
                angleEnd    = shape.angleEnd;

            // Path the outer edge of the segment
            obj.path(
                'b lw 3 a % % % % % false',
                x, y, radiusEnd, angleStart, angleEnd
            );

            // Path the inner edge of the segment - but going anti-clockwise!
            obj.path(
                'a % % % % % true c s black f red',
                x, y, radiusStart, angleEnd, angleStart
            );
        }
    }
</script>

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 similarly 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 your 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],
    options: {
    }
}).on('draw', function (obj)
{
    // Put your draw event code here

}).on('click', function (e, shape)
{
    // Put your click event code here
}).draw();

obj.exec(function)

The exec function is documented 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.

The responsive function is documented on its own page here.

Stacked Rose charts

Rose charts can now be stacked, much like stacked Bar charts. For examples of them, 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>

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.Rose({
    id: 'cvs',
    data: [4,8,6,3,5,8,9],
    options: {
    }
}).on('draw', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();

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>