Rose chart
- Example
- Types of Rose charts
- The angles and angles2 properties
- Properties
- Methods
- Data properties that are used on the segments
- Events
- Effects
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 basic Rose chart:
The basicRose chart
is simply a set of segments representing values - similar to aPie chart
except that the values are represented using the radius of each segment and the angle of each segment is equal.
-
The stacked Rose chart:
Similar to the basicRose chart
but with each segment representing a set of values instead of one. Similar in concept to a regularBar chart
vs a stackedBar chart
.
-
The non-equi-angular Rose chart:
In the above two types ofRose chart
the angle used for each segment is constant - what varies is the radius. In anon-equi-angular
Rose chart
though the angle used by each segment can be different too. Thus enabling you to represent two values per segment instead of just one.
-
The stacked non-equi-angular Rose chart:
Similar to how the regularRose chart
has a stacked variation the non-equi-angular chart segments can be stacked too.
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:
data-tooltip
The tooltip for the element.data-index
The index of the segment (or the group)data-centerx
The centerx-axis
coordinatedata-centery
The centery-axis
coordinatedata-group
The group for the segmentdata-subindex
The subindex (within any group) of the segmentdata-value
The value that the segment representsdata-start-angle
The start-angle of the segmentdata-end-angle
The end-angle of the segmentdata-radius
The radius of the segment.data-radius-inner
If this is part of a stack this is the inner radius valuedata-sequential-index
The sequential index of the segment
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:
obj.coords[0]
obj.coords[1]
obj.coords[2]
obj.coords[3]
obj.coords[4]
obj.coords[5]
obj.coords[6]
obj.coords[7]
obj.coords[8]
obj.coords[9]
obj.coords[10]
obj.coords[11]
The coordinates are appended to the array. The
obj.coords2
on the other hand is arranged two
dimensionally:
obj.coords2[0][0]
obj.coords2[0][1]
obj.coords2[0][2]
obj.coords2[0][3]
obj.coords2[1][0]
obj.coords2[1][1]
obj.coords2[1][2]
obj.coords2[1][3]
obj.coords2[2][0]
obj.coords2[2][1]
obj.coords2[2][2]
obj.coords2[2][3]
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
- Background properties
- Margin properties
- Color properties
- Labels and text properties
- Title properties
- Key properties
- Tooltip properties
- Highlight properties
- Other properties
Chart configuration properties
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
Background properties
Whether the background grid is displayed or not.
Default: true
backgroundGridColor
The color of the background grid.
Default: #ddd
backgroundGridRadialsCount
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
backgroundGridConcentricsCount
The number of concentric background grid circles that are displayed.
Default: 5
backgroundGridLinewidth
The
linewidth
of the background grid lines.Default: 1
backgroundGridRadialsAngleOffset
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
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
marginInner
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
Colors to be used for the Rose segments.
Default: ['red', 'black', 'orange', 'green', '#6ff', '#ccc', 'pink', 'orange', 'cyan', 'maroon', 'olive', 'teal']
colorsSequential
Normal color use is per stack/group but if you want the colors used sequentially then set this to true.
Default: false
colorsOpacity
This is the
opacity
value that's applied to the colors of the segments.Default: 1
colorsStroke
The color of the separating lines.
Default: white
Labels and text properties
Property | Description | Default |
---|---|---|
textSize | The size of the text. | 12 |
textFont | The font used to render the text. | Arial, Verdana, sans-serif |
textColor | The color of the labels. | black |
textItalic | Whether the labels are italic or not. | false |
textBold | Whether the labels are bold or not. | false |
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. | null |
labels | An array of the labels that are arranged in a circle around the Rose chart . | [] (an empty array) |
labelsFont | The font that the circular labels use. | null |
labelsSize | The size of the circular labels. | null |
labelsColor | The color of the circular labels. | null |
labelsBold | Whether the circular labels are bold or not. | null |
labelsItalic | Whether the circular labels are italic or not. | null |
labelsRadialMargin | The extra distance that, in addition to the radius, the labels are positioned. | 10 |
labelsAnglesOffset | 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 . | 0 |
labelsFormattedDecimals | When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. | 0 |
labelsFormattedPoint | When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro. | . |
labelsFormattedThousand | When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro. | , |
labelsFormattedUnitsPre | When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro. | (an empty string) |
labelsFormattedUnitsPost | When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro. | (an empty string) |
scaleVisible | Whether the scale is visible or not. | true |
scaleMax | The maximum scale value. By default, it's calculated for you. | null |
scaleFont | The font used to render the text in. | null |
scaleSize | The size of the scale text. | null |
scaleBold | Whether the scale text is bold or not. | null |
scaleItalic | Whether the scale text is italic or not. | null |
scaleColor | The color of the scale labels. | null |
scaleUnitsPre | The units that are added before each label. | (an empty string) |
scaleUnitsPost | The units that are added after each label. | (an empty string) |
scalePoint | The character(s) that are used as the decimal point. | . |
scaleThousand | The character(s) that are used as the thousand separator. | , |
scaleDecimals | The number of decimals that are shown on the scale. | 0 |
scaleLabelsCount | The number of labels that are shown on the scale (not including the zero label). | 5 |
scaleFormatter | 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) { }, | null |
The size of the text.
Default: 12
textFont
The font used to render the text.
Default: Arial, Verdana, sans-serif
textColor
The color of the labels.
Default: black
textItalic
Whether the labels are italic or not.
Default: false
textBold
Whether the labels are bold or not.
Default: false
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
labels
An array of the labels that are arranged in a circle around the
Rose chart
.Default: [] (an empty array)
labelsFont
The font that the circular labels use.
Default: null
labelsSize
The size of the circular labels.
Default: null
labelsColor
The color of the circular labels.
Default: null
labelsBold
Whether the circular labels are bold or not.
Default: null
labelsItalic
Whether the circular labels are italic or not.
Default: null
labelsRadialMargin
The extra distance that, in addition to the radius, the labels are positioned.
Default: 10
labelsAnglesOffset
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
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)
scaleVisible
Whether the scale is visible or not.
Default: true
scaleMax
The maximum scale value. By default, it's calculated for you.
Default: null
scaleFont
The font used to render the text in.
Default: null
scaleSize
The size of the scale text.
Default: null
scaleBold
Whether the scale text is bold or not.
Default: null
scaleItalic
Whether the scale text is italic or not.
Default: null
scaleColor
The color of the scale labels.
Default: null
scaleUnitsPre
The units that are added before each label.
Default: (an empty string)
scaleUnitsPost
The units that are added after each label.
Default: (an empty string)
scalePoint
The character(s) that are used as the decimal point.
Default: .
scaleThousand
The character(s) that are used as the thousand separator.
Default: ,
scaleDecimals
The number of decimals that are shown on the scale.
Default: 0
scaleLabelsCount
The number of labels that are shown on the scale (not including the zero label).
Default: 5
scaleFormatter
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
The title of the chart.
Default: (An empty string)
titleX
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
titleY
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
titleOffsetx
An offset value that is added to the calculated
x-axis
coordinate.Default: 0
titleOffsety
An offset value that is added to the calculated
y-axis
coordinate.Default: 0
titleHalign
The horizontal alignment of the title.
Default: center
titleColor
The color of the title. It defaults to be the same as the
textColor
property.Default: null
titleFont
The font used to render the title.
Default: null
titleSize
The size of the font used to render the title. It defaults to be a little larger than the
textSize
property.Default: null
titleBold
Whether the title is bold or not.
Default: null
titleItalic
Whether the title is italic or not.
Default: null
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: (An empty string)
titleSubtitleColor
The color of the subtitle.
Default: #aaa
titleSubtitleFont
The font used to render the subtitle.
Default: null
titleSubtitleSize
The size of the font used to render the subtitle. It defaults to be slightly smaller than the
textSize
setting.Default: null
titleSubtitleBold
Whether the subtitle is bold or not.
Default: null
titleSubtitleItalic
Whether the subtitle is italic or not.
Default: null
Key properties
An array of the labels that appear on the key.
Default: null
keyColors
An array of colors to be shown on the key. If not specified then the
colors
option will be used instead.Default: null
keyLabelsColor
The color of the text in the key.
Default: null
keyLabelsBold
Whether the key text is bold or not.
Default: null
keyLabelsFont
The font to use for the key text.
Default: null
keyLabelsSize
The size to use for the key text.
Default: null
ketLabelsItalic
Whether the key text is italic or not.
Default: null
keyLabelsOffsetx
The horizontal pixel offset of the key text (just the text).
Default: 0
keyLabelsOffsety
The vertical pixel offset of the key text (just the text).
Default: -1
keyOffsetx
The horizontal pixel offset of the entire key.
Default: 0
keyOffsety
The horizontal pixel offset of the entire key.
Default: 0
keyColorShape
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
Property | Description | Default |
---|---|---|
tooltips | 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. | null |
tooltipsOverride | 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:
| null |
tooltipsEvent | The event used for tooltips (either click or mousemove . | click |
tooltipsFormattedPoint | When using formatted tooltip strings this is used as the point when using the %{value_formatted} option. | . |
tooltipsFormattedThousand | When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option. | , |
tooltipsFormattedDecimals | When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option. | 0 |
tooltipsFormattedUnitsPre | When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option. | (an empty string) |
tooltipsFormattedUnitsPost | When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option. | (an empty string) |
tooltipsFormattedKeyLabels | The labels that are used in the formatted tooltip key. | [] (an empty array) |
tooltipsFormattedKeyColors | 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. | null |
tooltipsFormattedKeyColorsShape | This is the shape that's used in the tooltip key. It can be square or circle | 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"; } | null |
tooltipsFormattedListType | With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol . | 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; } | 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. | 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 in the canvas documentation, copy the code from it and then modify it suit. You'll create fewer bugs this way. | 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. | 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: tooltips: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' } | null |
tooltipsPointerOffsetx | This allows you to adjust the horizontal position of the tooltips pointer. | 0 |
tooltipsPointerOffsety | This allows you to adjust the vertical position of the tooltips pointer. | 0 |
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. | 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.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' } | null |
tooltipsCssClass | The css class that's applied to the tooltip div . | RGraph_tooltip |
tooltipsOffsetx | This property allows you to shift the tooltips left or right. | 0 |
tooltipsOffsety | This property allows you to shift the tooltips up or down. | 0 |
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
tooltipsOverride
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 containhtml
(or whatever else you may have specified).event
The event object (either aclick
ormousemove
event).
Default: null
tooltipsEvent
The event used for tooltips (either
click
or mousemove
.Default: click
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)
tooltipsFormattedKeyLabels
The labels that are used in the formatted tooltip key.
Default: [] (an empty array)
tooltipsFormattedKeyColors
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
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
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 in the
canvas
documentation, 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: tooltips: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' }
Default: null
tooltipsPointerOffsetx
This allows you to adjust the horizontal position of the tooltips pointer.
Default: 0
tooltipsPointerOffsety
This allows you to adjust the vertical position of the tooltips pointer.
Default: 0
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.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
tooltipsCssClass
The
css
class that's applied to the tooltip div
.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
Highlight properties
The color of the stroke of the highlight.
Default: rgba(0,0,0,0)
highlightFill
The color of the fill of the highlight.
Default: rgba(255,255,255,0.7)
highlightLinewidth
The
linewidth
of the stroke of the highlight.Default: 1
Other properties
Property | Description | Default |
---|---|---|
linewidth | The linewidth of the separating lines. | 1 |
exploded | This can either be a number or an array and controls by how much the segments are exploded. | 0 |
segmentsAngleOffset | This is the angular offset that affects the segments. It's measured in radians . | 0 |
variant | 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. | regular |
responsive | 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. | null |
The
linewidth
of the separating lines.Default: 1
exploded
This can either be a number or an array and controls by how much the segments are exploded.
Default: 0
segmentsAngleOffset
This is the angular offset that affects the segments. It's measured in
radians
.Default: 0
variant
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
responsive
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:
data-group
(stacked)data-subindex
(stacked, non-equi-angular stacked)data-index
(regular, stacked, non-equi-angular, non-equi-angular stacked)data-sequential
(regular, non-equi-angular, non-equi-angular stacked)data-sequential-index
(stacked)data-tooltip
(regular, stacked, non-equi-angular, non-equi-angular stacked)data-value
(regular, stacked, non-equi-angular, non-equi-angular stacked)data-centerx
(regular, stacked, non-equi-angular, non-equi-angular stacked)data-centery
(regular, stacked, non-equi-angular, non-equi-angular stacked)data-start-angle
(regular, stacked, non-equi-angular, non-equi-angular stacked)data-end-angle
(regular, stacked, non-equi-angular, non-equi-angular stacked)data-radius
(regular, stacked, non-equi-angular, non-equi-angular stacked)data-radius-inner
(stacked, non-equi-angular stacked)
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:
beforedraw
This event fires at the start of thedraw
method before anything has been done.draw
This event fires at the end of thedraw
function.firstdraw
This event fires at the end of thedraw
function - but only the first time and so it fires only once after the firstdraw
call.beforetooltip
This event fires at the start of the tooltip showing process.tooltip
This event fires after a tooltip has been shown.
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:
- Regular
Rose charts
- Regular stacked
Rose charts
- Non-equi-angular
Rose charts
- Non-equi-angular stacked
Rose charts
The demo pages are:
- The
grow
effect (demo available in the download archive) - The
roundrobin
effect (demo available in the download archive)