Rose chart API reference

Summary: Documentation about the Rose chart including information about all of the options that are available to you. The Rose chart may be more familiar to you as a Wind Rose chart. It can be regular, stacked or non-equi-angular in appearance. The SVG Rose chart can also show non-equi-angular stacked charts too.

• Example
• The data_seq peroperty
• Properties
• Methods
• Custom RGraph events that are available
• Stacked Rose charts
• Non-equi-angular Rose charts
• Animation effects

Example

<script>
    data = [41,37,32,35,36];

    new RGraph.Rose({
        id: 'cvs',
        data: data,
        options: {
            labels: ['MSIE 7 (41%)', 'MSIE 6 (37%)', 'Firefox (16%)', 'Safari (3%)', 'Other (3%)'],
            margin: 3,
            textSize: 16
        }
    }).draw()
</script>

The data_seq property

If your data is a multi-dimensional array (ie on a stacked Rose chart) then one member variable may be of interest to you - the obj.data_seq variable. This is a flattened view of the array of data that you pass to the Rose chart that may be useful in some circumstances. One of the demos shows this variable being used to get the value of the relevant piece of data.

This variable isn't really necessary for non-equi-angular or regular non-stacked charts.

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
• Axes properties
• Margin properties
• Color properties
• Shadow properties
• Labels and text properties
• Title properties
• Scale properties
• Key properties
• Interactive features properties
• Miscellaneous properties

Chart configuration properties

Background properties

Axes properties

Margin properties

Color properties

Shadow 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

Scale properties

Key properties

Interactive features properties

Miscellaneous properties

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [8,5,4,8,6,7,2,3,5,8],
    options: {
        // variant: '3d'
    }
}).draw();

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [[2,6],[2,4],[1,5],[4,3],[7,5],[8,3],[4,5],[3,4],[2,6],[4,5]],
    options: {
        variant: 'stacked'
        // variant: 'stacked3d'
    }
}).draw();

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [[45,23],[45,23],[5,26],[78,4],[49,12],[49,21],[40,18],[48,12],[43,23],[45,12]],
    options: {
        variant: 'non-equi-angular'
        //variant: 'non-equi-angular3d'
    }
}).draw();

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [8,5,4,8,6,7,2,3,5,8],
    options: {
        // variant: '3d'
    }
}).draw();

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [[2,6],[2,4],[1,5],[4,3],[7,5],[8,3],[4,5],[3,4],[2,6],[4,5]],
    options: {
        variant: 'stacked'
        // variant: 'stacked3d'
    }
}).draw();

var rose = new RGraph.Rose({
    id: 'cvs',
    data: [[45,23],[45,23],[5,26],[78,4],[49,12],[49,21],[40,18],[48,12],[43,23],[45,12]],
    options: {
        variant: 'non-equi-angular'
        //variant: 'non-equi-angular3d'
    }
}).draw();

Methods

<script>
    rose.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,
                radiusStart = shape.radiusStart,
                radiusEnd   = shape.radiusEnd,
                angleStart  = shape.angleStart,
                angleEnd    = shape.angleEnd;

            // Path the outer edge of the segment
            RGraph.path({
                object: obj,
                  path: 'b lw 3 a % % % % % false',
                  args: [x, y, radiusEnd, angleStart, angleEnd]
            });

            // Path the inner edge of the segment - but going anti-clockwise!
            RGraph.path({
                object: obj,
                  path: 'a % % % % % true c s black f red',
                  args: [x, y, radiusStart, angleEnd, angleStart]
            });
        }
    }
</script>

This method can be used to get the relevant radius for a given scale value.

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:

var obj = new RGraph.Rose({
    id: 'cvs',
    data: [4,8,6,3,5,8,4,6]
}).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>
    rose = new RGraph.Rose({
        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>

Stacked Rose charts

Rose charts can now be stacked, much like stacked Bar charts. For examples see the Rose chart example pages in the download archive. The data for a stacked Rose chart should be supplied in the same format as a stacked Bar chart:

<script>
    new RGraph.Rose({
        id: 'cvs',
        data: [[4,6,2],[8,4,7],[4,3,6],[1,5,6]],
        options: {
        }
    }).draw();
</script>

Non-equi-angular Rose charts

Rose charts can be displayed in a non-equi-angular mode. For an example see this Rose chart demo page in the download archive: rose-non-equi-angular.html. Instead of a plain array of values (as with a regular Rose chart), each data point should itself be a two element array consisting of the magnitude value and also a relative circular size. This second value is not the size of the angle - this is calculated. For example:

<script>
    new RGraph.Rose({
        id: 'cvs',
        data: [[47,6],[48,2],[40,4],[43,5],[45,6]],
        options: {
            variant: 'non-equi-angular'
        }
    }).draw();
</script>

Animation effects

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

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

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