Bipolar chart API reference

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

<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'],
            vmargin: 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

PropertyDescriptionDefault
backgroundGridWhether the background grid is enabled or not.true
backgroundGridColorThe color of the background grid.#ddd
backgroundGridLinewidthThe linewidth of the background grid.1
backgroundGridHlinesWhether the grid has horizontal lines.true
backgroundGridVlinesWhether the grid has vertical lines.true
backgroundGridVlinesCountThis is the number of vertical gridlines that are displayed.null (linked to the number of scale points there is)
backgroundGridHlinesCountThis is the number of horizontal gridlines that are displayed.null (linked to the number of data items you've specified)

General axis properties

PropertyDescriptionDefault
axesSet to false if you don't want any axes drawn.true
axesColorThe color of the axes.black
axesLinewidthThe linewidth of the axes.1

Margin properties

PropertyDescriptionDefault
marginLeftThe left margin of the chart.25
marginRightThe right margin of the chart.25
marginTopThe top margin of the chart.25
marginBottomThe bottom margin of the chart.25
marginCenterThe center area of the chart that the labels sit in. Beginning October 2017 this is now automatically calculated based on the size of the labels. Previously the default was 60.0
marginCenterAutoIf true (which is the default) the center margin (where the labels are positioned) will be automatically sized to fit the labels.true
vmarginThe space above and below each bar.2

X axis properties

PropertyDescriptionDefault
xaxisSet this to true if you don't want an X axis.true
xaxisTickmarksIntervalThe X tickmark interval.null
xaxisTickmarksCountThe number of X axis tickmarks.5
xaxisLabelsWhether the X labels (the scale) are drawn.true
xaxisLabelsCountThis controls how many scale labels that are displayed.5
xaxisScaleMaxThis allows you to set the maximum X value that the chart uses, instead of it being auto-generated.null
xaxisScaleUnitsPreThe units that are applied to the X axis labels (these are pre-pended to the number).none
xaxisScaleUnitsPostThe units that are applied to the X axis labels (these are appended to the number).none
xaxisScaleFormatterTo allow thoroughly custom formats of numbers in the scale, you can use this option to specify a function that is used by RGraph to format numbers. This function should handle ALL of the formatting. Eg:

function myFormatter(obj, num)
{
    return num + 'F'; // An example of formatting
}
myGraph.set('scale.formatter', myFormatter);
null
xaxisScaleDecimalsThe number of decimal places to display for the Y scale.0
xaxisScalePointThe character used as the decimal point..
xaxisScaleThousandThe character used as the thousand separator.,
xaxisScaleRoundWhether to round the maximum scale value up or not. This will produce slightly better scales in some instances.null
xaxisScaleZerostartWhether to show zero on the scale or not.true
xaxisLabelsFontWhat font to use for the X axis labels.null
xaxisLabelsSizeThe size of the X axis labels.null
xaxisLabelsColorThe color of the X axis labels.null
xaxisLabelsBoldWhether the X axis labels are bold or not.null
xaxisLabelsItalicWhether the X axis labels are italic or not.null

Y axis properties

PropertyDescriptionDefault
yaxisSet this to true if you don't want a Y axis.true
yaxisLabelsAn array of the charts labels (they go in the middle).null
yaxisLabelsFontThe font used to render the text (defaults to the textFont setting).null
yaxisLabelsSizeThe font-size used to render the text (defaults to the textSize setting).null
yaxisLabelsBoldWhether the labels are bold or not (defaults to the textBold setting).null
yaxisLabelsItalicWhether the labels are italic or not (defaults to the textItalic setting).null
yaxisLabelsColorThe color of the labels (defaults to the textColor setting).null

Color properties

PropertyDescriptionDefault
colorsAn array of colors. These too can be gradients that you make if you wish. If you specify exactly two colors then they will be used as one for each side (this only applies to regular, non-stacked and non-grouped charts), without having to also specify the colorsSequential option.['#fcf', '#00f', '#f00', '#0f0', '#ff0', '#0ff', '#f0f', '#ff6101', '#b401ff', '#e4ff01', '#fb8195', '#ccc']
colorsSequentialIf you want the colors to be used in a sequential fashion (they're used in a similar way to other charts by default) then set this to true.false
colorsStrokeThis is the color used as the stroke color. If you don't want a stroke, you can set this to rgba(0,0,0,0).#333

Other label properties

PropertyDescriptionDefault
labelsAboveSet this to true if you want labels drawn above the bars.false
labelsAboveFontThe font that the labelsAbove are rendered in. If not specified this falls back to the textFont setting.null
labelsAboveSizeThe size of the labelsAbove. If not specified this falls back to the textSize setting.null
labelsAboveBoldWhether the text is bold or not. This falls back to the textBold setting.null
labelsAboveItalicWhether the text is italic or not. This falls back to the textItalic setting.null
labelsAboveColorThe color of the labelsAbove labels. If not specified this falls back to the textColor setting.null
labelsAboveUnitsPreUnits that are prepended to the text. This does not fall back to the xaxisScaleUnitsPre setting.null
labelsAboveUnitsPostUnits that are appended to the text. This does not fall back to the xaxisScaleUnitsPost setting.null
labelsAboveDecimalsHow many decimals the numbers should have. This does not fall back to the xaxisScaleDecimals setting.null
labelsAboveFormatterUsing this setting you can specify a function that completely handles the formatting of the number and returns it as a string. It should look like this:
labelsAboveFormatter: function (obj, num)
{
    return '42';
}
null
textAccessibleA new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:
<div style="margin-left: 50px; display: inline-block">
<canvas id="cvs" width="650" height="250"></canvas>
</div>
true
textAccessibleOverflowThis can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish.visible
textAccessiblePointereventsThis controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).true
textFontThe font used to render the text.Arial, Verdana, sans-serif
textSizeThe size of the text used (in points).12
textColorThe color of the labels.black
textBoldWhether the text (ie labels) are bold or not.false
textItalicWhether the text (ie labels) are italic or not.false

Title properties

PropertyDescriptionDefault
titleThe main title of the chart.(An empty string)
titleBackgroundThe background color (if any) for the title.null
titleXTo give the exact X coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null
titleYTo give the exact Y coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null
titleColorThe color of the title.null
titleFontThe font that the title is rendered in. If not specified the textFont setting is used.null
titleSizeThe size of the title. If not specified the size is usually 2pt bigger than the textSize setting.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleLeftThe left title.null
titleLeftFontThe font the left title is rendered in.null
titleLeftSizeThe size of the left titles font.null
titleLeftBoldWhether the left title is bold or not.null
titleLeftItalicWhether the left title is italic or not.null
titleLeftColorThe color of the left title.null
titleRightThe right title.null
titleRightFontThe font that the right title is rendered in.null
titleRightSizeThe size of the right titles font.null
titleRightBoldWhether the right title is bold or not.null
titleRightItalicWhether the right title is italic or not.null
titleRightColorThe color of the right title.null

Shadow properties

PropertyDescriptionDefault
shadowTurns the shadow on or off.false
shadowColorThe color of the shadow.#666
shadowOffsetxThe horizontal offset of the shadow.3
shadowOffsetyThe vertical offset of the shadow.3
shadowBlurHow severe the blurring effect is for the shadow.3

Interactive features properties

PropertyDescriptionDefault
tooltipsA numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.An empty array
tooltipsEffectThe effect used for showing tooltips. Can be either fade or none.fade
tooltipsCssClassThis is the name of the CSS class the chart uses.RGraph_tooltip
tooltipsOverrideIf you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more information on the tooltips documentation page.null
tooltipsNohideonclearNot an option that you'll need particularly often, if at all. Setting this to true means that when you call the RGraph.clear() API function tooltips do not get hidden.false
contextmenuAn array of context menu items. Cannot be used in conjunction with tooltips.[] (An empty array)
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotatableColorIf you do not allow the use of the palette, then this will be the only color allowed for annotations.black
annotatableLinewidthThis is the linewidth of the annotations.1
resizableDefaulting to false, this determines whether your chart will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).false
resizableHandleBackgroundWith this you can specify the background color for the resize handle. If you're adjusting the position of the handle then you may need this to make the handle stand out more.null
resizableMinwidthThis allows you to set a minimum width that the chart can be resized to.null
resizableMinheightThis allows you to set a minimum height that the chart can be resized to.null
resizableMaxwidthThis allows you to set a maximum width that the chart can be resized to.null
resizableMaxheightThis allows you to set a maximum height that the chart can be resized to.null

Event properties

PropertyDescriptionDefault
eventsClickIf you want to add your own click function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own mousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own mouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own mouseout function you can do so by assigning it to this property. See here for details.null

Miscellaneous properties

PropertyDescriptionDefault
highlightStyleBy default this is null but you can set it to a function if you wish so that the function is called to do the chart highlighting. It's passed the shape object as an argument.null
highlightStrokeIf you use tooltips, this controls the color of the highlight stroke.rgba(0,0,0,0)
highlightFillIf you use tooltips, this controls the color of the highlight fill.rgba(255,255,255,0.5)
linewidthThe thickness of the strokes used.1
cleartoThis is used in animations and effects as the default color to use when the canvas.null
variantThis stipulates whether you want a regular bar chart or a 3D chart. Possible values are:
  • bipolar
  • 3d
bipolar
variantThreedOffsetxThis determines the size of the offset in the X direction.10
variantThreedOffsetyThis determines the size of the offset in the Y direction.5

Methods

obj.get(name)
An accessor that you can use to retrieve the values of properties.

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 shape also includes textual indexes like this: shape['object']

obj.getXCoord(value)

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.

obj.on(event, function)

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 option and method

The exec function is documented here.

Coordinates

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

Animation effects

These animation effects are available and can be used instead of the draw() function. There are also generic effects available which you can see here: Generic effects and transitions
<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>