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

More »

 

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

More »

 

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

More »

Pie chart API reference

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:

Properties

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

Chart configuration properties

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

Margin properties

Name: marginLeft
Description: 
The left margin of the chart.
Default: 35
Name: marginRight
Description: 
The right margin of the chart.
Default: 35
Name: marginTop
Description: 
The top margin of the chart.
Default: 35
Name: marginBottom
Description: 
The bottom margin of the chart.
Default: 35

Color properties

Name: colors
Description: 
Colors to be used for the pie segments.
Default: ['#f66', '#6f6', '#66f', '#ff6', '#6ff', '#ccc', 'pink', 'orange', 'cyan', 'maroon', 'olive', 'teal']
Name: colorsStroke
Description: 
The color of the separating lines.
Default: rgba(0,0,0,0)

Other text properties

Name: textSize
Description: 
The size of the text.
Default: 12
Name: textFont
Description: 
The font used to render the text.
Default: Arial, Verdana, sans-serif
Name: textColor
Description: 
The color of the labels.
Default: black
Name: textItalic
Description: 
Whether the labels are italic or not.
Default: false
Name: textBold
Description: 
Whether the labels are bold or not.
Default: false
Name: text
Description: 
This allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.
Default: null
Name: labels
Description: 
An array of labels for the chart.
Default: []
Name: labelsSticks
Description: 
If true this will cause the labels to be laid out with more spacing.
Default: true
Name: labelsSticksOffset
Description: 
This allows you to set the horizontal offset of the labels.
Default: 50
Name: labelsFormattedDecimals
Description: 
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default:  0
Name: labelsFormattedPoint
Description: 
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .
Name: labelsFormattedThousand
Description: 
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,
Name: labelsFormattedUnitsPre
Description: 
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: labelsFormattedUnitsPost
Description: 
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: labelsIngraph
Description: 
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
Name: labelsIngraphHalign
Description: 
The horizontal alignment of the labels.
Default: center
Name: labelsIngraphValign
Description: 
The vertical alignment of the labels.
Default: center
Name: labelsIngraphFont
Description: 
The font family used to render the text.
Default: null
Name: labelsIngraphSize
Description: 
The font size (in points) used to render the text.
Default: null
Name: labelsIngraphItalic
Description: 
Whether the text is italic or not.
Default: null
Name: labelsIngraphBold
Description: 
Whether the text is bold or not.
Default: null
Name: labelsIngraphColor
Description: 
The color used to render the text.
Default: null
Name: labelsIngraphRadiusPos
Description: 
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
Name: labelsIngraphSpecific
Description: 
If you want to specify your own labels, you can with this property. null values are just skipped.
Default: null
Name: labelsIngraphUnitsPre
Description: 
Units that are prepended to the number.
Default: [an empty string]
Name: labelsIngraphUnitsPost
Description: 
Units that are appended to the number.
Default: [an empty string]
Name: labelsIngraphPoint
Description: 
The decimal point character. This can be multiple characters if required.
Default: .
Name: labelsIngraphThousand
Description: 
The thousand separator character. This can be multiple characters if required.
Default: ,
Name: labelsIngraphBackground
Description: 
The background color of the labels.
Default: null
Name: labelsIngraphFormatter
Description: 
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
Name: labelsIngraphDecimals
Description: 
This can be used to specify how many decimal places are displayed in the formatted labels.
Default:  0

Shadow properties

Name: shadow
Description: 
Whether or not the chart has a shadow or not.
Default: false
Name: shadowOffsetx
Description: 
The x-axis offset of the shadow.
Default: 2
Name: shadowOffsety
Description: 
The y-axis offset of the shadow.
Default: 2
Name: shadowBlur
Description: 
The blurring of the shadow.
Default: 2
Name: shadowColor
Description: 
The color of the shadow.
Default: rgba(0,0,0,0.25)

Title properties

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

Key properties

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

Tooltip properties

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

Highlight properties

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

Other properties

Name: linewidth
Description: 
The linewidth of the separating lines.
Default: 1
Name: exploded
Description: 
This can either be a number or an array and controls by how much the segments are exploded.
Default:  0
Name: responsive
Description: 
This option is new to the July 2023 release (v6.13) and allows you to inline the responsive configuration instead of appending it on to the end of the object it as a function. The documentation and demo pages have been updated to use this new option. You can read more about the responsive feature by reading the responsive configuration page.
Default: null

Methods

obj.get(name)

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

obj.set(name, value)

This can be used to set properties if necessary. It's normally used after the chart is drawn if you need to set additional 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:

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:

For example:
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 the draw function.
<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>