Bipolar chart

Example

View example on CodePen
<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

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 grid lines that are displayed.null (linked to the number of scale points there is)
backgroundGridHlinesCountThis is the number of horizontal grid lines that are displayed.null (linked to the number of data items you've specified)
backgroundGrid
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 grid lines that are displayed.
Default: null (linked to the number of scale points there is)

backgroundGridHlinesCount
This is the number of horizontal grid lines that are displayed.
Default: 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
axes
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

PropertyDescriptionDefault
marginLeftThe left margin of the chart.35
marginRightThe right margin of the chart.35
marginTopThe top margin of the chart.35
marginBottomThe bottom margin of the chart.35
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
marginInnerThe space above and below each bar.2
marginLeft
The left margin of the chart.
Default: 35

marginRight
The right margin of the chart.
Default: 35

marginTop
The top margin of the chart.
Default: 35

marginBottom
The bottom margin of the chart.
Default: 35

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

PropertyDescriptionDefault
xaxisSet this to true if you don't want an x-axis.true
xaxisTickmarksIntervalThe x-axis tickmark interval.null
xaxisTickmarksCountThe number of x-axis tickmarks.5
xaxisLabelsWhether the x-axis labels (the scale) are drawn.true
xaxisLabelsCountThis controls how many scale labels are displayed.5
xaxisScaleMaxThis allows you to set the maximum x-axis 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('xaxisScaleFormatter', myFormatter);
null
xaxisScaleDecimalsThe number of decimal places to display for the y-axis scale. 0
xaxisScalePointThe character that's used as the decimal point..
xaxisScaleThousandThe character that's 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
xaxisLabelsFormattedDecimalsWhen using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. 0
xaxisLabelsFormattedPointWhen using formatted labels this is the decimal point character that's used with the %{value_formatted} macro..
xaxisLabelsFormattedThousandWhen using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.,
xaxisLabelsFormattedUnitsPreWhen using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.(an empty string)
xaxisLabelsFormattedUnitsPostWhen using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.(an empty string)
xaxisLabelsOffsetxThis allows you finer-grained control in the horizontal direction over the text positioning if you need it. 0
xaxisLabelsOffsetyThis allows you finer-grained control in the vertical direction over the text positioning if you need it. 0
xaxis
Set this to true if you don't want an x-axis.
Default: true

xaxisTickmarksInterval
The x-axis tickmark interval.
Default: null

xaxisTickmarksCount
The number of x-axis tickmarks.
Default: 5

xaxisLabels
Whether the x-axis labels (the scale) are drawn.
Default: true

xaxisLabelsCount
This controls how many scale labels are displayed.
Default: 5

xaxisScaleMax
This allows you to set the maximum x-axis 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-axis scale.
Default: 0

xaxisScalePoint
The character that's used as the decimal point.
Default: .

xaxisScaleThousand
The character that's 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

xaxisLabelsFormattedDecimals
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default: 0

xaxisLabelsFormattedPoint
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .

xaxisLabelsFormattedThousand
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,

xaxisLabelsFormattedUnitsPre
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)

xaxisLabelsFormattedUnitsPost
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)

xaxisLabelsOffsetx
This allows you finer-grained control in the horizontal direction over the text positioning if you need it.
Default: 0

xaxisLabelsOffsety
This allows you finer-grained control in the vertical direction over the text positioning if you need it.
Default: 0

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). You can also give this option a string if you prefer and use formatted labelsnull
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
yaxisLabelsClassThis property allows you to add your own css class to the y-axis labels which you can then use for styling purposes or to make retrieving the span tags easier (the dom elements). If you inspect the labels in your browser's javascript console (you will first need to enable the textAccessiblePointerevents property) you will be able to see the other css classes that are assigned to the labels.[none]
yaxisLabelsOffsetxThis allows you finer-grained control in the horizontal direction over the text positioning if you need it. 0
yaxisLabelsOffsetyThis allows you finer-grained control in the vertical direction over the text positioning if you need it. 0
yaxisLabelsFormattedDecimalsWhen using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. 0
yaxisLabelsFormattedPointWhen using formatted labels this is the decimal point character that's used with the %{value_formatted} macro..
yaxisLabelsFormattedThousandWhen using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.,
yaxisLabelsFormattedUnitsPreWhen using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.(an empty string)
yaxisLabelsFormattedUnitsPostWhen using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.(an empty string)
yaxis
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). You can also give this option a string if you prefer and use formatted labels
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

yaxisLabelsClass
This property allows you to add your own css class to the y-axis labels which you can then use for styling purposes or to make retrieving the span tags easier (the dom elements). If you inspect the labels in your browser's javascript console (you will first need to enable the textAccessiblePointerevents property) you will be able to see the other css classes that are assigned to the labels.
Default: [none]

yaxisLabelsOffsetx
This allows you finer-grained control in the horizontal direction over the text positioning if you need it.
Default: 0

yaxisLabelsOffsety
This allows you finer-grained control in the vertical direction over the text positioning if you need it.
Default: 0

yaxisLabelsFormattedDecimals
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default: 0

yaxisLabelsFormattedPoint
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .

yaxisLabelsFormattedThousand
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,

yaxisLabelsFormattedUnitsPre
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)

yaxisLabelsFormattedUnitsPost
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)

Color properties

PropertyDescriptionDefault
colorsAn array of colors. These too can be gradients that you make if you wish.['#fcf', '#00f', '#f00', '#0f0', '#ff0', '#0ff', '#f0f', '#ff6101', '#b401ff', '#e4ff01', '#fb8195', '#ccc']
colorsSequentialIf you want the colors to be used sequentially (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 transparent.#333
colorsLeftUse this property to specify an array of colors that are used just for the left-hand-side bars. This property can be used instead of the colors property.null
colorsRightUse this property to specify an array of colors that are used just for the right-hand-side bars. This property can be used instead of the colors property.null
colors
An array of colors. These too can be gradients that you make if you wish.
Default: ['#fcf', '#00f', '#f00', '#0f0', '#ff0', '#0ff', '#f0f', '#ff6101', '#b401ff', '#e4ff01', '#fb8195', '#ccc']

colorsSequential
If you want the colors to be used sequentially (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 transparent.
Default: #333

colorsLeft
Use this property to specify an array of colors that are used just for the left-hand-side bars. This property can be used instead of the colors property.
Default: null

colorsRight
Use this property to specify an array of colors that are used just for the right-hand-side bars. This property can be used instead of the colors property.
Default: null

Labels and text 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
labelsAboveOffsetxThis allows you finer-grained control in the horizontal direction over the text positioning if you need it. 0
labelsAboveOffsetyThis allows you finer-grained control in the vertical direction over the text positioning if you need it. 0
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>
false
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
textThis allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.null
labelsAbove
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

labelsAboveOffsetx
This allows you finer-grained control in the horizontal direction over the text positioning if you need it.
Default: 0

labelsAboveOffsety
This allows you finer-grained control in the vertical direction over the text positioning if you need it.
Default: 0

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

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

text
This allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.
Default: null

Title properties

PropertyDescriptionDefault
titleThe title of the chart, if any.null
titleFontThe font that the title is rendered in. If not specified the textFont setting is used (usually Arial).null
titleSizeThe size of the title. If not specified the size is usually 4pt bigger than the textSize setting.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleColorThe color of 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
titleHalignThe horizontal alignment of the title.center (can change depending on other options)
titleValignThe vertical alignment of the title.center (can change depending on other options)
titleOffsetxYou can use this property to adjust the positioning of the title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left). 0
titleOffsetyYou can use this property to adjust the positioning of the title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards). 0
titleSubtitleThe subtitle of the chart. If a subtitle is specified the title is moved up to accommodate it. As such you might need to give a larger marginTop value.null
titleSubtitleSizeThe size of the font used to render the subtitle.null
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleBoldWhether the subtitle is bold or not.null
titleSubtitleItalicWhether the subtitle is italic or not.null
titleSubtitleOffsetxUse this property to adjust the horizontal position of the subtitle. 0
titleSubtitleOffsetyUse this property to adjust the vertical position of the subtitle. 0
titleLeftThe left-hand-side title.null
titleLeftFontThe font the left-hand-side title is rendered in.null
titleLeftSizeThe size of the left-hand-side titles font.null
titleLeftBoldWhether the left-hand-side-title is bold or not.null
titleLeftItalicWhether the left-hand-side-title is italic or not.null
titleLeftColorThe color of the left-hand-side title.null
titleLeftOffsetxYou can use this property to adjust the positioning of the left-hand-side title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left). 0
titleLeftOffsetyYou can use this property to adjust the positioning of the left-hand-side title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards). 0
titleRightThe right-hand-side title.null
titleRightFontThe font that the right-hand-side title is rendered in.null
titleRightSizeThe size of the right-hand-side titles font.null
titleRightBoldWhether the right-hand-side title is bold or not.null
titleRightItalicWhether the right-hand-side title is italic or not.null
titleRightColorThe color of the right-hand-side title.null
titleRightOffsetxYou can use this property to adjust the positioning of the right-hand-side title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left). 0
titleRightOffsetyYou can use this property to adjust the positioning of the right-hand-side title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards). 0
title
The title of the chart, if any.
Default: null

titleFont
The font that the title is rendered in. If not specified the textFont setting is used (usually Arial).
Default: null

titleSize
The size of the title. If not specified the size is usually 4pt 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

titleColor
The color of 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

titleHalign
The horizontal alignment of the title.
Default: center (can change depending on other options)

titleValign
The vertical alignment of the title.
Default: center (can change depending on other options)

titleOffsetx
You can use this property to adjust the positioning of the title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left).
Default: 0

titleOffsety
You can use this property to adjust the positioning of the title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards).
Default: 0

titleSubtitle
The subtitle of the chart. If a subtitle is specified the title is moved up to accommodate it. As such you might need to give a larger marginTop value.
Default: null

titleSubtitleSize
The size of the font used to render the subtitle.
Default: null

titleSubtitleColor
The color of the subtitle.
Default: #aaa

titleSubtitleFont
The font used to render the subtitle.
Default: null

titleSubtitleBold
Whether the subtitle is bold or not.
Default: null

titleSubtitleItalic
Whether the subtitle is italic or not.
Default: null

titleSubtitleOffsetx
Use this property to adjust the horizontal position of the subtitle.
Default: 0

titleSubtitleOffsety
Use this property to adjust the vertical position of the subtitle.
Default: 0

titleLeft
The left-hand-side title.
Default: null

titleLeftFont
The font the left-hand-side title is rendered in.
Default: null

titleLeftSize
The size of the left-hand-side titles font.
Default: null

titleLeftBold
Whether the left-hand-side-title is bold or not.
Default: null

titleLeftItalic
Whether the left-hand-side-title is italic or not.
Default: null

titleLeftColor
The color of the left-hand-side title.
Default: null

titleLeftOffsetx
You can use this property to adjust the positioning of the left-hand-side title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left).
Default: 0

titleLeftOffsety
You can use this property to adjust the positioning of the left-hand-side title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards).
Default: 0

titleRight
The right-hand-side title.
Default: null

titleRightFont
The font that the right-hand-side title is rendered in.
Default: null

titleRightSize
The size of the right-hand-side titles font.
Default: null

titleRightBold
Whether the right-hand-side title is bold or not.
Default: null

titleRightItalic
Whether the right-hand-side title is italic or not.
Default: null

titleRightColor
The color of the right-hand-side title.
Default: null

titleRightOffsetx
You can use this property to adjust the positioning of the right-hand-side title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left).
Default: 0

titleRightOffsety
You can use this property to adjust the positioning of the right-hand-side title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards).
Default: 0

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

Key properties

The key properties are documented on the key documentation page.

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. Possible values are slide fade or none.slide
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
tooltipsFormattedPointWhen using formatted tooltip strings this is used as the point when using the %{value_formatted} option..
tooltipsFormattedThousandWhen using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.,
tooltipsFormattedDecimalsWhen using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option. 0
tooltipsFormattedUnitsPreWhen using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedUnitsPostWhen using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedKeyColorsWhen using formatted tooltip strings you can give specific colors for the %{key} option to use.null
tooltipsFormattedKeyColorsShapeThis is the shape that's used in the tooltip key. It can be square or circlesquare
tooltipsFormattedKeyColorsCss By using this property you can add css values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of css properties like this:
tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}
null
tooltipsFormattedKeyLabelsWhen using formatted tooltip strings these are the labels that are displayed.[] (an empty array)
tooltipsFormattedListTypeWith this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.ul
tooltipsFormattedListItemsThis should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]
You can use css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}
null
tooltipsFormattedTableHeadersWhen showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.null
tooltipsFormattedTableDataThis is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example, copy the code from it and then modify it suit. You'll create fewer bugs this way.null
tooltipsPointerBy default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.true
tooltipsPointerCssIf you want any css values applied to the tooltips pointer (for example a css border) then specify an object containing those values to this property. For example:
tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}
null
tooltipsPointerOffsetxThis allows you to adjust the vertical position of the tooltips pointer. 0
tooltipsPointerOffsetyThis allows you to adjust the vertical position of the tooltips pointer (for example, if you add a border you may need to move it down slightly). 0
tooltipsPositionStaticThe new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.true
tooltipsCssIf you want to specify some css that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object css for the tooltips. These are css styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt',
    backgroundColor: 'black',
    color: 'white'
}
null
tooltipsCssClassThis is the name of the css class the chart uses.RGraph_tooltip
tooltipsOffsetxThis property allows you to shift the tooltips left or right. 0
tooltipsOffsetyThis property allows you to shift the tooltips up or down. 0
tooltipsHotspotIgnoreThis can be a number of things and can be used to ignore certain tooltip hotspots - which can allow charts to the rear to be clickable. There's an example of this in the download archive called pie-tooltipshotspotignore.html. You can use the transparent color to allow the rear chart to be seen in such a case. It can be:
  • A single boolean value (ie true or false) to enable or disable all of the hotspots - true means the hotspot will be ignored
  • A single number (the zero-indexed number corresponding to the hotspot to ignore)
  • An array of numbers (the numbers are the indexes of hotspots to ignore)
  • An array of boolean true or false values - the position of these values correspond to the index(es) of the segments to ignore (for example [false, false, true, false, false] - true means the corresponding hotspot will be ignored)
null
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
tooltips
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. Possible values are slide fade or none.
Default: slide

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

tooltipsFormattedPoint
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .

tooltipsFormattedThousand
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,

tooltipsFormattedDecimals
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default: 0

tooltipsFormattedUnitsPre
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedUnitsPost
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedKeyColors
When using formatted tooltip strings you can give specific colors for the %{key} option to use.
Default: null

tooltipsFormattedKeyColorsShape
This is the shape that's used in the tooltip key. It can be square or circle
Default: square

tooltipsFormattedKeyColorsCss
By using this property you can add css values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of css properties like this:
tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}

Default: null

tooltipsFormattedKeyLabels
When using formatted tooltip strings these are the labels that are displayed.
Default: [] (an empty array)

tooltipsFormattedListType
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.
Default: ul

tooltipsFormattedListItems
This should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]
You can use css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}

Default: null

tooltipsFormattedTableHeaders
When showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.
Default: null

tooltipsFormattedTableData
This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null

tooltipsPointer
By default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.
Default: true

tooltipsPointerCss
If you want any css values applied to the tooltips pointer (for example a css border) then specify an object containing those values to this property. For example:
tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

Default: null

tooltipsPointerOffsetx
This allows you to adjust the vertical position of the tooltips pointer.
Default: 0

tooltipsPointerOffsety
This allows you to adjust the vertical position of the tooltips pointer (for example, if you add a border you may need to move it down slightly).
Default: 0

tooltipsPositionStatic
The new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.
Default: true

tooltipsCss
If you want to specify some css that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object css for the tooltips. These are css styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt',
    backgroundColor: 'black',
    color: 'white'
}

Default: null

tooltipsCssClass
This is the name of the css class the chart uses.
Default: RGraph_tooltip

tooltipsOffsetx
This property allows you to shift the tooltips left or right.
Default: 0

tooltipsOffsety
This property allows you to shift the tooltips up or down.
Default: 0

tooltipsHotspotIgnore
This can be a number of things and can be used to ignore certain tooltip hotspots - which can allow charts to the rear to be clickable. There's an example of this in the download archive called pie-tooltipshotspotignore.html. You can use the transparent color to allow the rear chart to be seen in such a case. It can be:
Default: null

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

PropertyDescriptionDefault
highlightStyleBy default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument. As of version 5.23 you can also set this to invert as well. If you do this on a dark background you may find that you need to change the highlightFill color setting as well.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 clearing the canvas.null
variantThis stipulates whether you want a regular 2D or a 3D chart. Possible values are:
  • bipolar
  • 3d
bipolar
variantThreedOffsetxThis determines the size of the offset in the horizontal direction.10
variantThreedOffsetyThis determines the size of the offset in the vertical direction.5
leftVisibleIf you want to hide the left side of the Bipolar chart set this to false.true
rightVisibleIf you want to hide the right side of the Bipolar chart set this to false.true
responsiveThis option is new to the July 2023 release (v6.13) and allows you to inline the responsive configuration instead of appending it on to the end of the object it as a function. The documentation and demo pages have been updated to use this new option. You can read more about the responsive feature by reading the responsive configuration page.null
highlightStyle
By default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument. As of version 5.23 you can also set this to invert as well. If you do this on a dark background you may find that you need to change the highlightFill color setting as well.
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 clearing the canvas.
Default: null

variant
This stipulates whether you want a regular 2D or a 3D chart. Possible values are:
Default: bipolar

variantThreedOffsetx
This determines the size of the offset in the horizontal direction.
Default: 10

variantThreedOffsety
This determines the size of the offset in the vertical direction.
Default: 5

leftVisible
If you want to hide the left side of the Bipolar chart set this to false.
Default: true

rightVisible
If you want to hide the right side of the Bipolar chart set this to false.
Default: true

responsive
This option is new to the July 2023 release (v6.13) and allows you to inline the responsive configuration instead of appending it on to the end of the object it as a function. The documentation and demo pages have been updated to use this new option. You can read more about the responsive feature by reading the responsive configuration page.
Default: null

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
side Which side of the chart the focused bar is on. 0 for the left-hand-side and 1 for the right-hand-side.
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 are 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;
            
            obj.path(
                'b r % % % % s black f red',
                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 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
});

obj.exec(function)

The exec function is documented here.


obj.responsive(configuration)

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:

Events

RGraph supports custom events that allow you to easily add interactivity to your charts if required. The following events are available:

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

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