home

download

svg

canvas

examples

support

blog

donate

• HOME
• DOWNLOAD
• EXAMPLES
• SVG CHARTS
• CANVAS CHARTS
• SUPPORT
• BLOG
• DONATE


• SHARE ON FACEBOOK
• SHARE ON TWITTER

Canvas Bipolar chart API reference

Summary
Documentation about the Bipolar chart including details about all the available options. The Bipolar chart is an easy way to represent two sets of data and present them side-by-side. The SVG Bipolar chart also supports stacked and grouped variations.

• Example
• Properties
• Methods
• Coordinates
• Effects

Example

<script>
    // The Bipolar chart takes two arrays of data - one for the left side and one for the right.
    var left  = [5,6,8,9,12,13,4,9];
    var right = [5,8,4,11,15,26,13,16];
    
    var bipolar = new RGraph.Bipolar({
        id: 'cvs',
        left: left,
        right: right,
        options: {
            colors: ['red'],
            hmargin: 3,
            labels: ['Barry', 'John', 'Fred', 'George', 'Rich', 'Larry', 'John', 'Mike'],
            titleLeft: '2007',
            titleRight: '2008',
            gutterBottom: 45
        }
    }).draw();
</script>

The example pages are here.

Properties

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

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

• Margins
• Background
• Titles
• Colors
• Labels, text and axes
• Scale
• Interactive features
• Shadow
• Zoom
• Events
• Miscellaneous

Margins

Background

Titles

Colors

Labels, text and axes

labelsAboveFormatter: function (obj, num)
{
    return '42';
}

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

Scale

function myFormatter(obj, num)
{
    return num + 'F'; // An example of formatting
}
myGraph.set('scale.formatter', myFormatter);

Interactive features

Shadow

Zoom

Events

Miscellaneous

Methods

This method when used in an event will return the details of the bar that was clicked on moused over (if any). It returns:

• The X coordinate
• The Y coordinate
• The width
• The height
• The index of the bar (starting at 0)

The shape also includes textual indexes like this: shape['object'] And they are:

• object
• x
• y
• width
• height
• tooltip
• index

This method can be used to get an appropriate X coordinate for a value when you're doing custom drawing on the chart. It returns an array containing two values - one for each side - and it returns null if the value is out of range.

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 you wish to attach to and the second is the handler function. For example:

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

The exec function is documented here.

Coordinates

There are 6 coordinates arrays available to you with the Bipolar chart. These are:

• obj.coords
  This is an array consisting off all of the coordinates for the bars on the chart - both left and right sides. Each bars coordinates (an array that consists of x, y, width and height) are simply appended to this array.
  
  
• obj.coordsLeft
  Like the obj.coords array but only the left-hand-sides bars.
  
  
• obj.coordsRight
  Like the obj.coords array but only the right-hand-sides bars.
  
  
• obj.coords2
  This only applies to stacked and grouped charts. Like the obj.coords array this contains all of the charts coordinates (both left and right sides) but the method of indexing is different. The first index (obj.coords2[0]) contains all of the first stacks/groups coordinates - which may well be multiple bars. So if you have a stack/group that consists of three bars, obj.coords2[0][0] is the first bar in that stack/group (which will be an array of x, y, width and height), obj.coords2[0][1] is the second bar in that stack/group and obj.coords2[0][2] is the third bar in the stack/group.If you're unsure of the structure of these arrays then the console.log() function or the RGraph $p() function will show them to you more clearly.
  
  
• obj.coords2Left
  Like the obj.coords2 array but only the left-hand-sides bars.
  
  
• obj.coords2Right
  Like the obj.coords2 array but only the right-hand-sides bars.
  
  

Animation Effects

• Grow effect
• Wave effect

<script>
    window.onload = (function ()
    {
        /**
        * Optional callback function that's called when the effect is complete
        */
        function myCallback (obj)
        {
            // ...
        }
    
    
        var left  = [4,8,6,3,1,2,5];
        var right = [15,13,18,19,12,16,14];
    
        var bipolar = new RGraph.Bipolar({
            id: 'cvs',
            left: left,
            right: right,
            options: {
                gutterCenter: 135,
                titleLeft: 'August 2013',
                titleRight: 'August 2014',
                textSize: 16,
                textColor: '#666',
                labels: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
                colors: ['gradient(red:red:red:#a00:#a00:#a00:#600:#a00:red:red:red)']
            }
        }).grow({frames: 60}, myCallback);
        //}).wave({frames: 60}, myCallback);
    });
</script>