Radial Scatter chart API reference

Documentation about the Radial scatter chart including information about all of the options that are available to you. A Radial Scatter chart is just like a regular Scatter chart but displayed in a circular fashion instead of a rectangular one.

• Example
• Properties
• Methods
• Events

Example

<script>
    tooltip = '%{key}';

    new RGraph.RScatter({
        id: 'cvs',
        data: [
            [ [15,53,'red',tooltip], [45,63,'red',tooltip], [48,45,'red',tooltip], [52,38,'red',tooltip], [51,61,'red',tooltip] ],
            [ [270,45, 'blue',tooltip], [270,55, 'red',tooltip] ]
        ],
        options: {
            tooltipsFormattedKeyLabels: ['John','Molly','Pete','Olga','Luis','Kevin','Julie'],
            tooltipsCss: {
                fontSize: '16pt',
                boxShadow: '',
                textAlign: 'left'
            },
            labels: ['NE','E','SE','S','SW','W','NW','N'],
            labelsPosition: 'edge',
            marginLeft: 35,
            marginRight: 35,
            labelsAxesSize: 8
        }
    }).draw();
</script>

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 is shown above.

• Chart configuration properties
• Background properties
• Margin properties
• Color properties
• Tickmark properties
• Labels and text properties
• Title properties
• Key properties
• Scale properties
• Interactive features properties
• Axes properties
• Line properties
• Miscellaneous properties

Chart configuration properties

Background properties

Margin properties

Color properties

Tickmark 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

Key properties

Scale properties

Interactive features properties

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;
}

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

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

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;
}

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

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

Axes properties

Line properties

Miscellaneous properties

Methods

<script>
    rscatter.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;

            // Path a circle that indicates the point
            obj.path(
                'b a % % 5 0 6.29 false s red f red',
                x, y
            );
        }
    }
</script>

This method can be used to get an appropriate radius of a point based on the scale. This is useful when working out how far away from the center a point should be. In a set of coordinates, the first value is the rotational value in degrees - it can be 0-360.

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:

obj.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.RScatter({
    id: 'cvs',
    data: [[45,36],[48,68],[66,56],[95,35],[120,45],[155,65]]
}).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.

The responsive() function is documented on its own page here.

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.Radar({
    id: 'cvs',
    data: [4,8,6,3,5,8,9],
    options: {
    }
}).on('draw', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();