Pie chart API reference

Summary: Documentation about the Pie chart including information about all of the options that are available to you. The Pie chart can show a single dataset and with the donut option it can show multiple datasets. Some people find them to be quite contentious though as comparing individual pieces of data can be tricky.

• Example
• Properties
• Methods
• Custom RGraph events that are available
• The Horseshoe Meter
• The Segmented Meter
• The Activity Meter
• Animation effects

Example

<script>
    labels = ['Fred','Rich','John','Paul','Jason','Hoolio','Kevin'];

    new RGraph.Pie({
        id: 'cvs',
        data: [564,155,499,611,322,568,389],
        options: {
            tooltips: 'Results:
%{key}',
            tooltipsFormattedKeyLabels: labels,
            labels: labels,
            linewidth: 2,
            colorsStroke: 'white',
            shadow: false,
            tooltipsCss: {
                fontSize: '16pt',
                backgroundColor: 'black',
                color:'white',
                textAlign: 'left'
            }
        }
    }).draw();
</script>

Properties

You can use these properties to control how the pie chart looks. You can set them by using the set() method. Eg:

obj.set('name', 'value');

• Chart configuration properties
• Margin properties
• Color properties
• Labels and text properties
• Title properties
• Shadow properties
• Interactive features properties
• Key properties
• Miscellaneous properties

Chart configuration properties

Margin properties

Color properties

Labels and text properties

<div style="margin-left: 50px; display: inline-block">
    <canvas id="cvs" width="650" height="250"></canvas>
</div>

<div style="margin-left: 50px; display: inline-block">
    <canvas id="cvs" width="650" height="250"></canvas>
</div>

Title properties

Shadow properties

Interactive features properties

tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt',
    backgroundColor: 'black',
    color: 'white'
}

tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt',
    backgroundColor: 'black',
    color: 'white'
}

Key properties

Miscellaneous properties

Methods

<script>
    pie.canvas.onclick = function (e)
    {
        RGraph.redraw();
    
        var canvas  = e.target,
            obj     = canvas.__object__,
            shape   = obj.getShape(e);

        if (shape) {
            
            var x      = shape.x,
                y      = shape.y,
                radius = shape.radius,
                start  = shape.angleStart,
                end    = shape.angleEnd;

            obj.path(
                'b m % % a % % % % % false c s black f red',
                x, y, x, y, radius, start, end
            );
        }
    }
</script>

The explode() function allows you to programmatically trigger the exploding (ie the highlighting of) a particular segment. The explode() method is used like so:

<script>
    pie = new RGraph.Pie({
        id: 'cvs',
        data: [8,9,4,6]
    }).draw();

    pie.explode(index, size);
</script>

The index argument is the zero-indexed segment to operate on (counting from the north axis). And the size is measured in pixels.

This method can be used to get an appropriate angle for a value using the "scale" of the Pie chart. So if your Pie chart is showing values that go from 0-100 and your requested value is 50, this method will return an angle for the bottom of the Pie chart (ie half way around).

This method can be used to set an event listener on an object. It operates in a similar way to the jQuery on() function. The first argument is the event that you wish to attach to and the second is the handler function. For example:

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

The function is useful if you use method chaining when creating your charts:

new RGraph.Pie({
    id: 'cvs',
    data: [4,5,3,8,6,3]
}).on('draw', function (obj)

    // Put your draw event code here

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

The exec function is documented here.

Custom RGraph events that are available

Custom RGraph events are events that RGraph fires when certain actions occur. There is a more comprehensive list of these events here . Here's some example code that show you how to add these events to your chart.

• click
• mousemove
• mouseover
• mouseout

There's more documentation about events available here: Summary of events documentation

<script>
    pie = new RGraph.Pie({
        id: 'cvs',
        data: [4,6,2,4,8,5,8],
        options: {
        }
    }).draw().on('click', function (e, shape)
    {
        // Add your click event listener code here

    }).on('mousemove', function (e, shape)
    {
        // Add your mousemove event listener code here

    }).on('mouseover', function (e, shape)
    {
        // Add your mouseover event listener code here

    }).on('mouseout', function (obj)
    {
        // Add your mouseout event listener code here
    });
</script>

The Horseshoe Meter

Prior to version 5.02 it was possible to get this type of meter but it involved a lot of code (which you could always have put in a library file).

But now there's a dedicated class for it so it becomes an awful lot easier to create these types of charts. The code looks like this:

<script>
    new RGraph.HorseshoeMeter({
        id: 'cvs_horseshoe',
        min: 0,
        max: 100,
        value: 65,
        options: {
        }
    }).roundRobin();
</script>

The Segmented Meter

Prior to version 5.2 it was possible to get this type of meter (there was a demo for it available in the demos folder) but it involved a lot of code so now there's a specialised class for it. The demo for it has been updated with the new code.

So it becomes an awful lot easier to create these types of charts. The code looks like this:

<script>
    segmented = new RGraph.SegmentedMeter({
        id: 'cvs_segmented',
        max: 100,
        value: 70,
        options: {
            //backgroundColor: 'black',
            //value: true,
            //valuePercentage: false,
            //valueUnitsPre: '',
            //valueDecimals: 1,
            //valueBold: null,
            //valueItalic: null,
            //valueFont: null,
            //colors: ['red','white']
            //variantDonutWidth: null,
            valueUnitsPost: '%',
            valueColor: '#aaa',
            valueSize: 50
        }
    }).roundRobin({frames: 60});
</script>

The Activity Meter

Prior to version 5.2 it was possible to get this type of meter (there was a demo for it available in the demos folder) but it involved a lot of code so now there's a specialised class for it. The demo for has been updated with the new code.

So it becomes an awful lot easier to create these types of charts. The code looks like this:

<script>
    // The definitions of the rings, their values, colors and radius.
    activity = new RGraph.ActivityMeter({
        id: 'cvs_activity',
        config: [
            {color: '#2B908F', value: 67, image: '/images/activityMeter-arrowright.png' , _label_: 'A' }, // You can have either a label or an image
            {color: '#90EE7E', value: 57, image: '/images/activityMeter-arrowup.png'   ,  _label_: 'B' }, // You can have either a label or an image
            {color: '#F45B5B', value: 46, image: '/images/activityMeter-arrowdown.png',   _label_: 'C' }  // You can have either a label or an image
        ],
        options: {
            variantDonutWidth: 30,
            marginTop: 5,
            marginBottom: 5,
            marginLeft: 5,
            marginRight: 5,
            labelColor: 'black',
            labelFont: 'Monospace',
            labelSize: 28,
            labelBold: true,
            labelItalic: true
        }
    }).draw();
</script>

Animation effects

• The Grow effect (effects-pie-grow.html in the download archive)
• The Explode effect (effects-pie-explode.html in the download archive)
• The RoundRobin effect (effects-pie-roundrobin.html in the download archive)

<script>
    /**
    * Optional callback function that's called when the effect is complete
    */
    function myCallback (obj)
    {
        // ...
    }

    new RGraph.Pie({
        id: 'cvs',
        data: [8,6,6,5,3,4,2],
        options: {
        }
    }).grow({frames: 60}, myCallback)
    // .implode({frames: 60}, myCallback)
    // .roundRobin({frames: 60}, myCallback)
</script>