Bipolar chart

• Example
• Properties
• Methods
• Coordinates
• Events
• Effects

Example

<script>
    // The Bipolar chart accepts two arrays of data - one for the left side and one for the right.
    left  = [[4,8,6],[4,3,2],[9,8,5]];
    right = [[4,6,5],[3,2,2],[4,5,6]];
    
    new RGraph.Bipolar({
        id: 'cvs',
        left: left,
        right: right,
        options: {
            backgroundGridHlines: false,
            backgroundGridBorder: false,
            titleLeftBold: true,
            titleLeftSize: 18,
            titleRightBold: true,
            titleRightSize: 18,
            colors: ['red','#aaf','green'],
            marginInner:15,
            yaxisLabels: ['Barry', 'John', 'Fred'],
            tooltips: '<b>Results:</b><br/>%{key}',
            tooltipsFormattedKeyLabels: ['8pm','9pm','10pm'],
            titleLeft: '2007',
            titleRight: '2008',
            marginBottom: 45,
            xaxis: false,
            tooltipsCss: {
                fontSize: '16pt',
                textAlign: 'left'
            }
        }
    }).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 shown above.

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

• Background properties
• General axis properties
• Margin properties
• X-axis properties
• Y-axis properties
• Color properties
• Margin properties
• Labels and text properties
• Title properties
• Shadow properties
• Key properties
• Interactive features 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

Labels and text 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

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

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

tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt',
    backgroundColor: 'black',
    color: 'white'
}

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',
    backgroundColor: 'black',
    color: 'white'
}

Miscellaneous properties

Methods

<script>
    obj.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,
                width  = shape.width,
                height = shape.height;
            
            obj.path(
                'b r % % % % s black f red',
                x, y, width, height
            );
        }
    }
</script>

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 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:

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

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.

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 bar's 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.
  
  

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

Effects

• The grow effect (you can see an example in the download archive)
• The 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>