SVG Pie charts API reference

Summary: Documentation about the SVG Pie chart including information about all the options and methods that are available to you.

 

Example

The code below produces a chart like this:

<script>
    // Some data that's to be shown on the Pie chart. For multiple
    lines it can also be an array of arrays
    var 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: [,,15],
            colors: ['#f66','pink','orange','gray','#fcc','green','#0f0']
        }
    }).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

PropertyDescriptionDefault
centerxIf required, you can position the Pie chart using this instead of the margins.null
centeryIf required, you can position the Pie chart using this instead of the margins.null
radiusIf required, you can size the Pie chart using this instead of the margins.null
centerx
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

PropertyDescriptionDefault
marginLeftThe left margin of the chart.35
marginRightThe right margin of the chart.35
marginTopThe top margin of the chart.35
marginBottomThe bottom margin of the chart.35
marginLeft
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

PropertyDescriptionDefault
colorsColors to be used for the pie segments.['#f66', '#6f6', '#66f', '#ff6', '#6ff', '#ccc', 'pink', 'orange', 'cyan', 'maroon', 'olive', 'teal']
colorsStrokeThe color of the separating lines.rgba(0,0,0,0)
colors
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

PropertyDescriptionDefault
textSizeThe size of the text.12
textFontThe font used to render the text.Arial, Verdana, sans-serif
textColorThe color of the labels.black
textItalicWhether the labels are italic or not.false
textBoldWhether the labels are bold or not.false
labelsAn array of labels for the chart.[]
labelsSticksIf true this will cause the labels to be laid out with more spacing.true
labelsIngraphWhether 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
labelsIngraphHalignThe horizontal alignment of the labels.center
labelsIngraphValignThe vertical alignment of the labels.center
labelsIngraphFontThe font family used to render the text.null
labelsIngraphSizeThe font size (in points) used to render the text.null
labelsIngraphItalicWhether the text is italic or not.null
labelsIngraphBoldWhether the text is bold or not.null
labelsIngraphColorThe color used to render the text.null
labelsIngraphRadiusPosThis 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
labelsIngraphSpecificIf you want to specify your own labels, you can with this property. Null values are just skipped.null
labelsIngraphUnitsPreUnits that are prepended to the number.[an empty string]
labelsIngraphUnitsPostUnits that are appended to the number.[an empty string]
labelsIngraphPointThe decimal point character. This can be multiple characters if required..
labelsIngraphThousandThe thousand separator character. This can be multiple characters if required.,
labelsIngraphBackgroundThe background color of the labels.null
labelsIngraphFormatterThis 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
labelsIngraphDecimalsThis can be used to specify how many decimal places are displayed in the formatted labels.0
textSize
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

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

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

PropertyDescriptionDefault
shadowWhether or not the chart has a shadow or not.false
shadowOffsetxThe X offset of the shadow.2
shadowOffsetyThe Y offset of the shadow.2
shadowBlurThe blurring of the shadow.2
shadowOpacityThe opacity of the shadow color.0.25
shadow
Whether or not the chart has a shadow or not.
Default: false

shadowOffsetx
The X offset of the shadow.
Default: 2

shadowOffsety
The Y offset of the shadow.
Default: 2

shadowBlur
The blurring of the shadow.
Default: 2

shadowOpacity
The opacity of the shadow color.
Default: 0.25

Title properties

PropertyDescriptionDefault
titleThe title of the chart.(An empty string)
titleXThe specific X 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.null
titleYThe specific Y 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.null
titleHalignThe horizontal alignment of the title.center
titleColorThe color of the title.null
titleFontThe font used to render the title.null
titleSizeThe size of the font used to render the title.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
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.(An empty string)
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleSizeThe size of the font used to render the subtitle. null
titleSubtitleBoldWhether the subtitle is bold or not.null
titleSubtitleItalicWhether the subtitle is italic or not.null
title
The title of the chart.
Default: (An empty string)

titleX
The specific X 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 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

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

PropertyDescriptionDefault
keyAn array of the labels that appear on the key.null
keyColorsAn array of colors to be shown on the key. If not specified then the colors option will be used instead.null
keyLabelsColorThe color of the text in the key.null
keyLabelsBoldWhether the key text is bold or not.null
keyLabelsFontThe font to use for the key text.null
keyLabelsSizeThe size to use for the key text.null
ketLabelsItalicWhether the key text is italic or not.null
keyLabelsOffsetxThe horizontal pixel offset of the key text (just the text).0
keyLabelsOffsetyThe vertical pixel offset of the key text (just the text).-1
keyOffsetxThe horizontal pixel offset of the entire key.0
keyOffsetyThe horizontal pixel offset of the entire key.0
keyColorShapeThis 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 rectdotrect
key
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

PropertyDescriptionDefault
tooltipsAn array of tooltips for the chart. This array should NOT be multidimensional - even for stacked or grouped charts.null
tooltipsOverrideIf required, this can be a function that totally 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).
null
tooltipsCssClassThe CSS class that's applied to the tooltip DIV.RGraph_tooltip
tooltipsEventThe event used for tooltips (either click or mousemove.click
tooltips
An array of tooltips for the chart. This array should NOT be multidimensional - even for stacked or grouped charts.
Default: null

tooltipsOverride
If required, this can be a function that totally 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:
Default: null

tooltipsCssClass
The CSS class that's applied to the tooltip DIV.
Default: RGraph_tooltip

tooltipsEvent
The event used for tooltips (either click or mousemove.
Default: click

Highlight properties

PropertyDescriptionDefault
highlightStrokeThe color of the stroke of the highlight.rgba(0,0,0,0)
highlightFillThe color of the fill of the highlight.rgba(255,255,255,0.7)
highlightLinewidthThe linewidth of the stroke of the highlight.1
highlightStroke
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

PropertyDescriptionDefault
linewidthThe linewidth of the separating lines.1
explodedThis can either be a number or an array and controls by how much the segments are exploded.0
linewidth
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

Methods

 

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.

 

obj.exec(func)

This function executes the function that you give it (there and then - not on any particular event)

 

Animation 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>