Rose chart API reference

• Example
• The data_seq property
• Properties
• Methods
• Stacked Rose charts
• Non-equi-angular Rose charts
• The coordinates properties
• Events
• Effects

Example

<script>
    data   = [10,5,8,3,9,4,6,10,5,3,6,8,4,9];
    labels = ['John','Richard','Paul','Pete','Lou','Olga','Neil','Ken','Luis','John','Gary','Paul','Fay','Will'];

    new RGraph.Rose({
        id: 'cvs',
        data: data,
        options: {
            colors: ['red'],
            backgroundGridRadialsCount: 0,
            labels: labels,
            tooltips: '%{key}',
            tooltipsFormattedUnitsPost: 'kg',
            tooltipsFormattedKeyLabels: labels,
            margin: 5,
            tooltipsCss: {
                fontSize: '20pt',
                boxShadow: '',
                textAlign: 'left'
            },
            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 Rose 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

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

tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}

tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]

.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}

tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}

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
            obj.path(
                'b lw 3 a % % % % % false',
                x, y, radiusEnd, angleStart, angleEnd
            );

            // Path the inner edge of the segment - but going anti-clockwise!
            obj.path(
                'a % % % % % true c s black f red',
                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 similarly 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],
    options: {
    }
}).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.

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.

Stacked Rose charts

Rose charts can now be stacked, much like stacked Bar charts. For examples of them, 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>

The coordinates properties

• obj.angles This holds the information about the segments that make up the Rose chart. The properties that each entry holds are:
  • start angle (measured in radians)
  • end angle (measured in radians)
  • start radius
  • radius
  • center x coordinate
  • center y coordinate
  • stroke color
  • fill color
• obj.angles2 This is similar to the above array but is indexed differently - first by group and then by iindex. Each entry holds the following information:
  • start angle (measured in radians)
  • end angle (measured in radians)
  • start radius
  • radius
  • center x coordinate
  • center y coordinate
  • stroke color
  • fill color
• obj.coordsText This holds the coordinates of all of the text that has been added to the chart. Even if the text is blank (ie no text) then the coordinates will be added to this variable.

Events

RGraph supports custom events that allow you to easily add interactivity to your charts if required. The following events are available:

• annotatebegin This event fires at the start of annotating - like the standard mousedown event.
• annotate This event fires (repeatedly) during annotating - like the standard mousemove event.
• annotateend This event fires at the end of annotating - like the standard mouseup event.
• annotateclear This event fires at the end of the RGraph.clearAnnotations function.
• beforeclear This event fires at the start of the RGraph.clear function.
• clear This event fires at the end of the RGraph.clear function.
• click This is similar to the standard canvas click event but this only fires when you click on a bar - not the whole canvas.
• beforecontextmenu This event fires when you have the contextmenu enabled and it is about to appear.
• contextmenu This event fires when you have the contextmenu enabled and it has been displayed.
• beforedraw This event fires at the start of the draw method before anything has been done.
• firstdraw This event fires at the end of the draw function - but only the first time that the draw function is called.
• draw This event fires at the end of the draw function.
• beforeinteractivekey When you're using the interactive key this event fires just before the key and chart are highlighted.
• afterinteractivekey When you're using the interactive key this event fires just after the key and chart are highlighted.
• keyclick This event fires when you click on the key - you don't have to be using the interactive key however.
• mousemove This event is similar to the standard mousemove event but only fires when you move the mouse over a bar on the chart.
• mouseover This event is similar to the standard mouseover event but only fires when you move the mouse over a bar on the chart.
• mouseout This event is similar to the standard mouseout event but only fires when you move the mouse away from a bar on the chart that you've previously hovered over.
• beforetooltip This event fires at the start of the tooltip showing process.
• tooltip This event fires after a tooltip has been shown.

new RGraph.Rose({
    id: 'cvs',
    data: [4,8,6,3,5,8,9],
    options: {
    }
}).on('draw', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();

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>