Pie chart
- Example
- The angles (coordinates) properties
- Properties
- Methods
- Data properties that are used on the segments
- Events
- Effects
Example
<script> data = [280,45,133,152,278,221,56]; new RGraph.SVG.Pie({ id: 'chart-container', data: data, options: { labels: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'], shadow: true, colorsStroke: 'rgba(0,0,0,1)', linewidth: 0, exploded: [,,25], colors: ['#f66','pink','orange','gray','#fcc','green','#0f0'], tooltips: '%{key}', tooltipsFormattedKeyLabels: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'], tooltipsFormattedUnitsPost: '%', tooltipsCss: { backgroundColor: '#333', fontWeight: 'bold', fontSize: '14pt', opacity: 0.85 } } }).draw(); </script>
The angles property
The angles for the segments on the Pie chart
are held in the
obj.angles
array. Each element in this array is an
object that has the following properties:
start
- The start angle (measured inradians
)end
- The end angle (measured inradians
)angle
- The extent (the end minus the start) of the angle of the segment (measured inradians
)halfway
- The halfway point of the angle (measured inradians
)cx
- The centerx-axis
coordinate for the segmentcy
- The centery-axis
coordinate for the segmentradius
- Theradius
of the segment (in aPie chart
all the radii of the segments are the same)object>
- The RGraphPie chart
objectelement
- Thesvg
path
element
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
- Margin properties
- Color properties
- Other text properties
- Shadow properties
- Title properties
- Key properties
- Tooltip properties
- Highlight properties
- Other properties
Chart configuration properties
If required, you can position the
Pie chart
using this instead of the margins.Default: null
centery
If required, you can position the
Pie chart
using this instead of the margins.Default: null
radius
If required, you can size the
Pie chart
using this instead of the margins.Default: null
Margin properties
Property | Description | Default |
---|---|---|
marginLeft | The left margin of the chart. | 35 |
marginRight | The right margin of the chart. | 35 |
marginTop | The top margin of the chart. | 35 |
marginBottom | The bottom margin of the chart. | 35 |
The left margin of the chart.
Default: 35
marginRight
The right margin of the chart.
Default: 35
marginTop
The top margin of the chart.
Default: 35
marginBottom
The bottom margin of the chart.
Default: 35
Color properties
Colors to be used for the pie segments.
Default: ['#f66', '#6f6', '#66f', '#ff6', '#6ff', '#ccc', 'pink', 'orange', 'cyan', 'maroon', 'olive', 'teal']
colorsStroke
The color of the separating lines.
Default: rgba(0,0,0,0)
Other 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 labels for the chart. | [] |
labelsSticks | If true this will cause the labels to be laid out with more spacing. | true |
labelsSticksOffset | This allows you to set the horizontal offset of the labels. | 50 |
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) |
labelsIngraph | Whether the ingraph labels are displayed. By default, these are placed in the center of the segment. If you have small/narrow segments the labels will probably not fit. | false |
labelsIngraphHalign | The horizontal alignment of the labels. | center |
labelsIngraphValign | The vertical alignment of the labels. | center |
labelsIngraphFont | The font family used to render the text. | null |
labelsIngraphSize | The font size (in points) used to render the text. | null |
labelsIngraphItalic | Whether the text is italic or not. | null |
labelsIngraphBold | Whether the text is bold or not. | null |
labelsIngraphColor | The color used to render the text. | null |
labelsIngraphRadiusPos | This number is multiplied with the radius to get the radial distance that the text is placed at. The default, 0.5, will therefore put the text in the center of the segment. | 0.5 |
labelsIngraphSpecific | If you want to specify your own labels, you can with this property. null values are just skipped. | null |
labelsIngraphUnitsPre | Units that are prepended to the number. | [an empty string] |
labelsIngraphUnitsPost | Units that are appended to the number. | [an empty string] |
labelsIngraphPoint | The decimal point character. This can be multiple characters if required. | . |
labelsIngraphThousand | The thousand separator character. This can be multiple characters if required. | , |
labelsIngraphBackground | The background color of the labels. | null |
labelsIngraphFormatter | This can be a function that is passed an object that consists of two properties - object and number. It should return the fully formatted number. | null |
labelsIngraphDecimals | This can be used to specify how many decimal places are displayed in the formatted labels. | 0 |
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 labels for the chart.
Default: []
labelsSticks
If
true
this will cause the labels to be laid out with more spacing.Default: true
labelsSticksOffset
This allows you to set the horizontal offset of the labels.
Default: 50
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)
labelsIngraph
Whether the ingraph labels are displayed. By default, these are placed in the center of the segment. If you have small/narrow segments the labels will probably not fit.
Default: false
labelsIngraphHalign
The horizontal alignment of the labels.
Default: center
labelsIngraphValign
The vertical alignment of the labels.
Default: center
labelsIngraphFont
The font family used to render the text.
Default: null
labelsIngraphSize
The font size (in points) used to render the text.
Default: null
labelsIngraphItalic
Whether the text is italic or not.
Default: null
labelsIngraphBold
Whether the text is bold or not.
Default: null
labelsIngraphColor
The color used to render the text.
Default: null
labelsIngraphRadiusPos
This number is multiplied with the radius to get the radial distance that the text is placed at. The default, 0.5, will therefore put the text in the center of the segment.
Default: 0.5
labelsIngraphSpecific
If you want to specify your own labels, you can with this property.
null
values are just skipped.Default: null
labelsIngraphUnitsPre
Units that are prepended to the number.
Default: [an empty string]
labelsIngraphUnitsPost
Units that are appended to the number.
Default: [an empty string]
labelsIngraphPoint
The decimal point character. This can be multiple characters if required.
Default: .
labelsIngraphThousand
The thousand separator character. This can be multiple characters if required.
Default: ,
labelsIngraphBackground
The background color of the labels.
Default: null
labelsIngraphFormatter
This can be a function that is passed an object that consists of two properties - object and number. It should return the fully formatted number.
Default: null
labelsIngraphDecimals
This can be used to specify how many decimal places are displayed in the formatted labels.
Default: 0
Shadow properties
Whether or not the chart has a shadow or not.
Default: false
shadowOffsetx
The
x-axis
offset of the shadow.Default: 2
shadowOffsety
The
y-axis
offset of the shadow.Default: 2
shadowBlur
The blurring of the shadow.
Default: 2
shadowColor
The color of the shadow.
Default: rgba(0,0,0,0.25)
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 coordinate.
Default: 0
titleOffsety
An offset value that is added to the calculated Y coordinate.
Default: 0
titleHalign
The horizontal alignment of the title.
Default: center
titleColor
The color of the title.
Default: null
titleFont
The font used to render the title.
Default: null
titleSize
The size of the font used to render the title.
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.
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. 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. 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 |
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
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 parameters 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 Pie chart
have various data attributes added to them that hold various bits of information. These
are:
data-index
data-tooltip
data-value
data-start-angle
data-end-angle
data-radius
These can be retrieved by using standard dom
methods:
obj.angles[0].element.getAttribute('data-index');
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.Pie({ 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
These effects are available and can be used instead of thedraw
function.
- The
roundrobin
effect (demo available in the download archive)
<script> // // An optional callback function that's called when the effect is completed // function myCallback (obj) { // ... } var obj = new RGraph.SVG.Pie({ id: 'mySVG', data: [3,4,7,5,6,9,8], options: { } }).roundRobin({frames: 60}, myCallback); </script>