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
<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
- Miscellaneous properties
Background properties
Whether the background grid is enabled or not.
Default: true
backgroundGridColor
The color of the background grid.
Default: #ddd
backgroundGridLinewidth
The linewidth of the background grid.
Default: 1
backgroundGridHlines
Whether the grid has horizontal lines.
Default: true
backgroundGridVlines
Whether the grid has vertical lines.
Default: true
backgroundGridVlinesCount
This is the number of vertical gridlines that are displayed.
Default: null (linked to the number of scale points there is)
backgroundGridHlinesCount
This is the number of horizontal gridlines that are displayed.
Default: null (linked to the number of data items you've specified)
General axis properties
Property | Description | Default |
---|---|---|
axes | Set to false if you don't want any axes drawn. | true |
axesColor | The color of the axes. | black |
axesLinewidth | The linewidth of the axes. | 1 |
Set to false if you don't want any axes drawn.
Default: true
axesColor
The color of the axes.
Default: black
axesLinewidth
The linewidth of the axes.
Default: 1
Margin properties
The left margin of the chart.
Default: 25
marginRight
The right margin of the chart.
Default: 25
marginTop
The top margin of the chart.
Default: 25
marginBottom
The bottom margin of the chart.
Default: 25
marginCenter
The 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.
Default: 0
marginCenterAuto
If true (which is the default) the center margin (where the labels are positioned) will be automatically sized to fit the labels.
Default: true
marginInner
The space above and below each bar.
Default: 2
X axis properties
Set this to true if you don't want an X axis.
Default: true
xaxisTickmarksInterval
The X tickmark interval.
Default: null
xaxisTickmarksCount
The number of X axis tickmarks.
Default: 5
xaxisLabels
Whether the X labels (the scale) are drawn.
Default: true
xaxisLabelsCount
This controls how many scale labels that are displayed.
Default: 5
xaxisScaleMax
This allows you to set the maximum X value that the chart uses, instead of it being auto-generated.
Default: null
xaxisScaleUnitsPre
The units that are applied to the X axis labels (these are pre-pended to the number).
Default: none
xaxisScaleUnitsPost
The units that are applied to the X axis labels (these are appended to the number).
Default: none
xaxisScaleFormatter
To 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('xaxisScaleFormatter', myFormatter);
Default: null
xaxisScaleDecimals
The number of decimal places to display for the Y scale.
Default: 0
xaxisScalePoint
The character used as the decimal point.
Default: .
xaxisScaleThousand
The character used as the thousand separator.
Default: ,
xaxisScaleRound
Whether to round the maximum scale value up or not. This will produce slightly better scales in some instances.
Default: null
xaxisScaleZerostart
Whether to show zero on the scale or not.
Default: true
xaxisLabelsFont
What font to use for the X axis labels.
Default: null
xaxisLabelsSize
The size of the X axis labels.
Default: null
xaxisLabelsColor
The color of the X axis labels.
Default: null
xaxisLabelsBold
Whether the X axis labels are bold or not.
Default: null
xaxisLabelsItalic
Whether the X axis labels are italic or not.
Default: null
Y axis properties
Set this to true if you don't want a Y axis.
Default: true
yaxisLabels
An array of the charts labels (they go in the middle).
Default: null
yaxisLabelsFont
The font used to render the text (defaults to the
textFont
setting).Default: null
yaxisLabelsSize
The font-size used to render the text (defaults to the
textSize
setting).Default: null
yaxisLabelsBold
Whether the labels are bold or not (defaults to the
textBold
setting).Default: null
yaxisLabelsItalic
Whether the labels are italic or not (defaults to the
textItalic
setting).Default: null
yaxisLabelsColor
The color of the labels (defaults to the
textColor
setting).Default: null
Color properties
An 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.Default: ['#fcf', '#00f', '#f00', '#0f0', '#ff0', '#0ff', '#f0f', '#ff6101', '#b401ff', '#e4ff01', '#fb8195', '#ccc']
colorsSequential
If 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.
Default: false
colorsStroke
This 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)
.Default: #333
Other label properties
Property | Description | Default |
---|---|---|
labelsAbove | Set this to true if you want labels drawn above the bars. | false |
labelsAboveFont | The font that the labelsAbove are rendered in. If not specified this falls back to the textFont setting. | null |
labelsAboveSize | The size of the labelsAbove . If not specified this falls back to the textSize setting. | null |
labelsAboveBold | Whether the text is bold or not. This falls back to the textBold setting. | null |
labelsAboveItalic | Whether the text is italic or not. This falls back to the textItalic setting. | null |
labelsAboveColor | The color of the labelsAbove labels. If not specified this falls back to the textColor setting. | null |
labelsAboveUnitsPre | Units that are prepended to the text. This does not fall back to the xaxisScaleUnitsPre setting. | null |
labelsAboveUnitsPost | Units that are appended to the text. This does not fall back to the xaxisScaleUnitsPost setting. | null |
labelsAboveDecimals | How many decimals the numbers should have. This does not fall back to the xaxisScaleDecimals setting. | null |
labelsAboveFormatter | Using 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 |
textAccessible | A 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"> | true |
textAccessibleOverflow | This 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 |
textAccessiblePointerevents | This controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none). | true |
textFont | The font used to render the text. | Arial, Verdana, sans-serif |
textSize | The size of the text used (in points). | 12 |
textColor | The color of the labels. | black |
textBold | Whether the text (ie labels) are bold or not. | false |
textItalic | Whether the text (ie labels) are italic or not. | false |
Set this to true if you want labels drawn above the bars.
Default: false
labelsAboveFont
The font that the
labelsAbove
are rendered in. If not specified this falls back to the textFont
setting.Default: null
labelsAboveSize
The size of the
labelsAbove
. If not specified this falls back to the textSize
setting.Default: null
labelsAboveBold
Whether the text is bold or not. This falls back to the
textBold
setting.Default: null
labelsAboveItalic
Whether the text is italic or not. This falls back to the
textItalic
setting.Default: null
labelsAboveColor
The color of the
labelsAbove
labels. If not specified this falls back to the textColor
setting.Default: null
labelsAboveUnitsPre
Units that are prepended to the text. This does not fall back to the
xaxisScaleUnitsPre
setting.Default: null
labelsAboveUnitsPost
Units that are appended to the text. This does not fall back to the
xaxisScaleUnitsPost
setting.Default: null
labelsAboveDecimals
How many decimals the numbers should have. This does not fall back to the
xaxisScaleDecimals
setting.Default: null
labelsAboveFormatter
Using 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'; }
Default: null
textAccessible
A 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>
Default: true
textAccessibleOverflow
This 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.Default: visible
textAccessiblePointerevents
This controls whether the DOM text responds to mouse based events or not (it sets the
pointer-events
CSS property to none).Default: true
textFont
The font used to render the text.
Default: Arial, Verdana, sans-serif
textSize
The size of the text used (in points).
Default: 12
textColor
The color of the labels.
Default: black
textBold
Whether the text (ie labels) are bold or not.
Default: false
textItalic
Whether the text (ie labels) are italic or not.
Default: false
Title properties
The main title of the chart.
Default: (An empty string)
titleBackground
The background color (if any) for the title.
Default: null
titleX
To 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.
Default: null
titleY
To 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.
Default: null
titleColor
The color of the title.
Default: null
titleFont
The font that the title is rendered in. If not specified the
textFont
setting is used.Default: null
titleSize
The size of the title. If not specified the size is usually 2pt bigger than the
textSize
setting.Default: null
titleBold
Whether the title is bold or not.
Default: null
titleItalic
Whether the title is italic or not.
Default: null
titleLeft
The left title.
Default: null
titleLeftFont
The font the left title is rendered in.
Default: null
titleLeftSize
The size of the left titles font.
Default: null
titleLeftBold
Whether the left title is bold or not.
Default: null
titleLeftItalic
Whether the left title is italic or not.
Default: null
titleLeftColor
The color of the left title.
Default: null
titleRight
The right title.
Default: null
titleRightFont
The font that the right title is rendered in.
Default: null
titleRightSize
The size of the right titles font.
Default: null
titleRightBold
Whether the right title is bold or not.
Default: null
titleRightItalic
Whether the right title is italic or not.
Default: null
titleRightColor
The color of the right title.
Default: null
Shadow properties
Turns the shadow on or off.
Default: false
shadowColor
The color of the shadow.
Default: #666
shadowOffsetx
The horizontal offset of the shadow.
Default: 3
shadowOffsety
The vertical offset of the shadow.
Default: 3
shadowBlur
How severe the blurring effect is for the shadow.
Default: 3
Interactive features properties
Property | Description | Default |
---|---|---|
tooltips | A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML. | An empty array |
tooltipsEffect | The effect used for showing tooltips. Can be either fade or none . | fade |
tooltipsCssClass | This is the name of the CSS class the chart uses. | RGraph_tooltip |
tooltipsOverride | If 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 |
tooltipsNohideonclear | Not 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 |
contextmenu | An array of context menu items. Cannot be used in conjunction with tooltips. | [] (An empty array) |
annotatable | Whether annotations are enabled for the chart (ie you can draw on the chart interactively. | false |
annotatableColor | If you do not allow the use of the palette, then this will be the only color allowed for annotations. | black |
annotatableLinewidth | This is the linewidth of the annotations. | 1 |
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.
Default: An empty array
tooltipsEffect
The effect used for showing tooltips. Can be either
fade
or none
.Default: fade
tooltipsCssClass
This is the name of the CSS class the chart uses.
Default: RGraph_tooltip
tooltipsOverride
If 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.
Default: null
tooltipsNohideonclear
Not 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.Default: false
contextmenu
An array of context menu items. Cannot be used in conjunction with tooltips.
Default: [] (An empty array)
annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false
annotatableColor
If you do not allow the use of the palette, then this will be the only color allowed for annotations.
Default: black
annotatableLinewidth
This is the linewidth of the annotations.
Default: 1
Miscellaneous properties
By 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.
Default: null
highlightStroke
If you use tooltips, this controls the color of the highlight stroke.
Default: rgba(0,0,0,0)
highlightFill
If you use tooltips, this controls the color of the highlight fill.
Default: rgba(255,255,255,0.5)
linewidth
The thickness of the strokes used.
Default: 1
clearto
This is used in animations and effects as the default color to use when the canvas.
Default: null
variant
This stipulates whether you want a regular bar chart or a 3D chart. Possible values are:
bipolar
3d
Default: bipolar
variantThreedOffsetx
This determines the size of the offset in the X direction.
Default: 10
variantThreedOffsety
This determines the size of the offset in the Y direction.
Default: 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 makes it easy to get hold of which bar has been clicked on or hovered over. It returns an object which has the following indexes available:
object |
The chart object |
x |
The X coordinate |
y |
The Y coordinate |
width |
The width of the bar |
height |
The height of the bar |
dataset |
The zero-indexed "group". In a regular Bipolar chart this is the index of the bar. In a stacked or grouped chart however this is the index of the group (or stack). |
index |
The zero-indexed numerical index of the bar. In a stacked or grouped chart this is the index in a particular group. In a regular Bipolar chart this is always zero. |
sequentialIndex |
The zero-indexed sequential index of the bar. For example in a grouped chart where there's 3 groups of three - this goes from 0 up to 8. |
tooltip |
If a tooltip is associated with this segment this will be it.id:
strings are expanded for you (where the tooltip text is retrieved from the HTML
tag with the matching ID).
|
<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;
RGraph.path({
object: obj,
path: 'b r % % % % s black f red',
args: [x, y, width, height]
});
}
}
</script>
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:
bipolar.on('draw', function (obj)
{
// Put your event code here
});
obj.exec(function)
The exec function is documented here.
Custom RGraph events that are available
Custom RGraph events are events that RGraph fires when certain actions occur. There is a more comprehensive list of these events here . Here's some example code that show you how to add these events to your chart.
- click
- mousemove
- mouseover
- mouseout
There's more documentation about events available here: Summary of events documentation
<script>
bipolar = new RGraph.Bipolar({
id: 'cvs',
left: [8,4,6,3,5,4,8],
right: [6,4,2,3,5,4,2],
options: {
}
}).draw().on('click', function (e, shape)
{
// Add your click event listener code here
}).on('mousemove', function (e, shape)
{
// Add your mousemove event listener code here
}).on('mouseover', function (e, shape)
{
// Add your mouseover event listener code here
}).on('mouseout', function (obj)
{
// Add your mouseout event listener code here
});
</script>
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 theobj.coords
array but only the left-hand-sides coordinates.
-
obj.coordsRight
Like theobj.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 andobj.coords2[0][2]
is the third bar in the stack/group. If you're unsure of the structure of these arrays then theconsole.log()
function or the RGraph$p()
function will show them to you more clearly.
-
obj.coords2Left
Like theobj.coords2
array but only the left-hand-sides bars.
-
obj.coords2Right
Like theobj.coords2
array but only the right-hand-sides bars.
Animation effects
These animation effects are available and can be used instead of thedraw()
function. There are also generic effects available which
you can see here: Generic effects and transitions
- 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>