Bipolar chart API reference

Summary: Documentation about the Bipolar chart including details about all of the options that are available to you. 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 accepts two arrays of data - one for the left side and one for the right.
    left  = [5,6,8,9,12,13,4,9];
    right = [5,8,4,11,15,26,13,16];
    
    new RGraph.Bipolar({
        id: 'cvs',
        left: left,
        right: right,
        options: {
            colors: ['red'],
            marginInner: 3,
            yaxisLabels: ['Barry', 'John', 'Fred', 'George', 'Rich', 'Larry', 'John', 'Mike'],
            titleLeft: '2007',
            titleRight: '2008',
            marginBottom: 45
        }
    }).draw();
</script>

Properties

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

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

• Background properties
• General axis properties
• X axis properties
• Y axis properties
• Color properties
• Margin properties
• Other label properties
• Title properties
• Shadow properties
• Interactive features properties
• Event properties
• Miscellaneous properties

Background properties

General axis properties

Margin properties

X axis properties

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

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

Y axis properties

Color properties

Other label properties

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

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

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

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

Title properties

Shadow properties

Interactive features properties

Event properties

Miscellaneous properties

Methods

obj.set(name, value)
An accessor that you can use to set the values of properties.

obj.getShape(event)

This method, when used in an event handler, will return the details of the bar that was clicked on hovered 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']

• 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 that 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 of 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 appended to this array.
  
  
• obj.coordsLeft
  Like the obj.coords array but only the left-hand-sides coordinates.
  
  
• obj.coordsRight
  Like the obj.coords array but only the right-hand-sides coordinates.
  
  
• obj.coords2
  This only applies to stacked and grouped charts. Like the obj.coords array this contains all of the charts coordinates (both the 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

• The Grow effect (you can see an example in the download archive)
• Wave effect (you can see an example in the download archive)

<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: {
                marginCenter: 135,
                titleLeft: 'August 2013',
                titleRight: 'August 2014',
                textSize: 16,
                textColor: '#666',
                yaxisLabels: ['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>