Bipolar chart
- Example
- The coordinates properties
- Properties
- Methods
- Data properties that are used on the bars
- Events
- Effects
Example
<script> labels = ['Monday','Tuesday','Wednesday']; bipolar = new RGraph.SVG.Bipolar({ id: 'chart-container', left: [[8,5],[6,3],[4,8]], right: [[1,2],[8,2],[6,5]], //left: [4,8,6], //right: [4,8,5], options: { backgroundGridHlines: false, backgroundGridBorder: false, title: 'A Bipolar chart', titleSubtitle: 'A subtitle for the chart that was generated on Sunday', titleSubtitleItalic: true, marginTop: 50, colors: ['red','black'], yaxisLabels: '%{global:labels[%{index}]}', yaxisTextBold: true, yaxisTextItalic: true, xaxis: false, yaxisColor: '#aaa', shadow: true, tooltips: 'Results:%{key}', tooltipsFormattedUnitsPre: '$', tooltipsFormattedUnitsPost: '', tooltipsFormattedDecimals: 2, tooltipsFormattedKeyLabels: ['Berty','Charles'], tooltipsCss: { backgroundColor: '#333', fontWeight: 'bold', fontSize: '14pt', opacity: 0.85 } } }).draw().responsive([ {maxWidth: 700, width: 400, height: 200,options: {textSize: 8, marginInner: 4}}, {maxWidth: 950, width: 600, height: 250,options: {textSize: 12, marginInner: 3}}, {maxWidth: null, width: 700, height: 350,options: {textSize: 16, marginInner: 5}} ]); </script>
The coordinates properties
The coordinates for the bars on the Bipolar chart are held in the following arrays:
-
obj.coords
All of the coordinates - that are simply appended to this array as the bars are drawn. Each element of the array is an object which consists ofx
,y
,width
,height
,element
andobject
properties. Theelement
property is theSVG
rect
element and theobject
property is the RGraph object.
-
obj.coordsLeft
Similar to theobj.coords
array but just for the left-hand-side bars.
-
obj.coordsRight
Similar to theobj.coords
array but just for the right-hand-side bars.
-
obj.coords2
Again, this is all of the coordinates - but arranged slightly differently. This is only used by stacked and grouped charts - each element is an array of that groups/stacks segments. then each sub-element is an object which consists ofx
,y
,width
andheight
,element
andobject
properties. Theelement
property is theSVG
rect
element and theobject
property is the RGraph object.
-
obj.coords2Left
Similar to theobj.coords2
array but just for the left-hand-side bars.
-
obj.coords2Right
Similar to theobj.coords2
array but just for the right-hand-side bars.
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.
- Background properties
- Margin properties
- Color properties
- X-axis properties
- Y-axis properties
- Other label properties
- Key properties
- Tooltip properties
- Shadow properties
- Title properties
- Other properties
Background properties
The color of the background.
Default: null
backgroundImageLeft
A URL of an image to render to the left background.
Default: null
backgroundImageLeftAspect
The aspect ratio setting of the left
SVG
image tag, eg it could be XMinYMin meet
.Default: none
backgroundImageLeftOpacity
The
opacity
value of the left background image.Default: 0.5
backgroundImageLeftStretch
Whether the left background image is stretched across the whole chart (except the margins).
Default: true
backgroundImageLeftX
If you're not using the stretch option you can specify the
X-axis
coordinate of the left background image.Default: null
backgroundImageLeftY
If you're not using the stretch option you can specify the
Y-axis
coordinate of the left background image.Default: null
backgroundImageLeftW
If you're not using the stretch option you can specify the width of the left background image.
Default: null
backgroundImageLeftH
If you're not using the stretch option you can specify the height of the left background image.
Default: null
backgroundImageRight
A URL of an image to render to the right background.
Default: null
backgroundImageRightAspect
The aspect ratio setting of the right
SVG
image tag, eg it could be XMinYMin meet
.Default: none
backgroundImageRightOpacity
The
opacity
value of the right background image.Default: 0.5
backgroundImageRightStretch
Whether the right background image is stretched across the whole chart (except the margins).
Default: true
backgroundImageRightX
If you're not using the stretch option you can specify the
X-axis
coordinate of the right background image.Default: null
backgroundImageRightY
If you're not using the stretch option you can specify the
Y-axis
coordinate of the right background image.Default: null
backgroundImageRightW
If you're not using the stretch option you can specify the width of the right background image.
Default: null
backgroundImageRightH
If you're not using the stretch option you can specify the height of the right background image.
Default: null
backgroundGrid
Whether to show the background grid or not.
Default: true
backgroundGridColor
The color of the background grid.
Default: #ddd
backgroundGridLinewidth
The
linewidth
that the background grid lines are. Decimals (eg 0.5) are permitted.Default: 1
backgroundGridBorder
Determines whether a border is drawn around the grid.
Default: true
backgroundGridHlines
Determines whether to draw the horizontal grid lines.
Default: true
backgroundGridHlinesCount
Determines how many horizontal grid lines you have. The default is linked to how many scale labels that you have.
Default: null
backgroundGridVlines
Determines whether to draw the vertical grid lines.
Default: true
backgroundGridVlinesCount
Determines how many vertical grid lines you have. The default is to be linked to how many scale labels that you have.
Default: null
backgroundGridDashed
You can specify a dashed background grid by setting this to true. This option takes precedence over the dotted variant.
Default: false
backgroundGridDotted
You can specify a dotted background grid by setting this to true.
Default: false
backgroundGridDashArray
With this option you can specify exactly what the array used for the
linedash
setting should be. It should be an array consisting of two numbers.Default: null
Margin properties
The left margin of the chart, (the margin is where the labels and title are)).
Default: 35
marginRight
The right margin of the chart, (the margin is where the labels and title are).
Default: 35
marginTop
The top margin of the chart, (the margin is where the labels and title are).
Default: 35
marginBottom
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 35
marginCenter
This is the center bit of the chart where the labels sit. By default, it's automatically calculated for you but you can set it to a number if you wish.
Default: null
marginInner
This is the margin between bars (or groups of bars on a grouped chart.
Default: 3
marginInnerGrouped
On a grouped Bipolar chart this is the margin between bars within each group.
Default: 2
Color properties
An array of the colors of the bars.
Default: An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']
colorsSequential
If
true
, for regular bar charts, (not stacked or grouped), the colors that you specify will be used sequentially.Default: false
colorsStroke
The color of the outline of the bars.
Default: rgba(0,0,0,0)
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
X-axis properties
Whether the
X-axis
is shown or not.Default: true
xaxisLinewidth
The
linewidth
that's used to draw the X-axis
.Default: 1
xaxisTickmarks
Whether the
X-axis
has tickmarks or not.Default: true
xaxisTickmarksLength
The size of the
X-axis
tickmarks.Default: 3
xaxisLabelsOffsetx
The horizontal pixel offset that's added to the
X-axis
labels.Default: 0
xaxisLabelsOffsety
The vertical pixel offset that's added to the
X-axis
labels.Default: 0
xaxisLabelsCount
The number of
X-axis
labels.Default: 5
xaxisLabelsPositionEdgeTickmarksCount
Not something you'll use often, if at all. Determines how many tickmarks there are.
Default: null
xaxisScaleUnitsPre
Units that are prepended to the scale numbers.
Default: (An empty string
xaxisScaleUnitsPost
Units that are appended to the scale numbers.
Default: (An empty string
xaxisScaleDecimals
The number of decimals that the scale will show.
Default: 0
xaxisScalePoint
The character(s) used as the decimal point.
Default: .
xaxisScaleThousand
The character(s) used as the thousand separator.
Default: ,
xaxisScaleRound
If set to
true
the max scale value will be rounded up.Default: false
xaxisScaleMax
The maximum scale value.
Default: null
xaxisLabelsColor
The color of the
X-axis
text.Default: null
xaxisLabelsBold
Whether the
X-axis
text is bold or not.Default: null
xaxisLabelsItalic
Whether the
X-axis
text is italic or not.Default: null
xaxisLabelsFont
The font of the
X-axis
text.Default: null
xaxisLabelsSize
The size of the
X-axis
text.Default: null
Y-axis properties
Property | Description | Default |
---|---|---|
yaxis | Whether the Y-axis is shown or not. | true |
yaxisLinewidth | The linewidth that's used to draw the Y-axis . | 1 |
yaxisTickmarks | Whether the Y-axis has tickmarks or not. | true |
yaxisTickmarksLength | The size of the Y-axis tickmarks. | 3 |
yaxisLabels | The labels for the Y-axis . | null |
yaxisLabelsOffsetx | The horizontal pixel offset that's added to the Y-axis labels. | 0 |
yaxisLabelsOffsety | The vertical pixel offset that's added to the Y-axis labels. | 0 |
yaxisColor | The color of the Y-axis . | black |
yaxisLabelsColor | The color of the Y-axis text. | null |
yaxisLabelsBold | Whether the Y-axis text is bold or not. | null |
yaxisLabelsItalic | Whether the Y-axis text is italic or not. | null |
yaxisLabelsFont | The font of the Y-axis text. | null |
yaxisLabelsSize | The size of the Y-axis text. | null |
yaxisLabelsFormattedDecimals | When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. | 0 |
yaxisLabelsFormattedPoint | When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro. | . |
yaxisLabelsFormattedThousand | When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro. | , |
yaxisLabelsFormattedUnitsPre | When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro. | (an empty string) |
yaxisLabelsFormattedUnitsPost | When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro. | (an empty string) |
Whether the
Y-axis
is shown or not.Default: true
yaxisLinewidth
The
linewidth
that's used to draw the Y-axis
.Default: 1
yaxisTickmarks
Whether the
Y-axis
has tickmarks or not.Default: true
yaxisTickmarksLength
The size of the
Y-axis
tickmarks.Default: 3
yaxisLabels
The labels for the
Y-axis
.Default: null
yaxisLabelsOffsetx
The horizontal pixel offset that's added to the
Y-axis
labels.Default: 0
yaxisLabelsOffsety
The vertical pixel offset that's added to the
Y-axis
labels.Default: 0
yaxisColor
The color of the
Y-axis
.Default: black
yaxisLabelsColor
The color of the
Y-axis
text.Default: null
yaxisLabelsBold
Whether the
Y-axis
text is bold or not.Default: null
yaxisLabelsItalic
Whether the
Y-axis
text is italic or not.Default: null
yaxisLabelsFont
The font of the
Y-axis
text.Default: null
yaxisLabelsSize
The size of the
Y-axis
text.Default: null
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)
Other label properties
Property | Description | Default |
---|---|---|
textColor | The color of the text. | black |
textFont | The font used for text. | Arial, Verdana, sans-serif |
textSize | The size of the text. | 12 |
textBold | Whether the text is bold or not. | false |
textItalic | Whether the text is italic or not. | 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. | null |
labelsAbove | Whether to show the labelsAbove style labels. | false |
labelsAbovePoint | The decimal point character to use for the labelsAbove labels. | null |
labelsAboveThousand | The thousand separator character to use for the labelsAbove labels. | null |
labelsAboveDecimals | The number of decimals to use for the labelsAbove labels. | 0 |
labelsAbovePre | A string to prepend to the labelsAbove labels. | null |
labelsAbovePost | A string to append to the labelsAbove labels. | null |
labelsAboveFormatter | A function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number. | null |
labelsAboveOffsetx | The horizontal offset of the labelsAbove labels. | 0 |
labelsAboveOffsety | The vertical offset of the labelsAbove labels. | 0 |
labelsAboveFont | The font of the labelsAbove labels. | null |
labelsAboveSize | The size of the labelsAbove labels. | null |
labelsAboveBold | Whether the labelsAbove labels are bold or not. | null |
labelsAboveItalic | Whether the labelsAbove labels are italic or not. | null |
labelsAboveColor | The color of the labelsAbove labels. | null |
labelsAboveBackground | The background color of the labelsAbove labels. | null |
labelsAboveBackgroundPadding | The padding of the labelsAbove labels. | 0 |
labelsAboveSpecific | This property allows you to make the labelsAbove labels specific strings. | null |
The color of the text.
Default: black
textFont
The font used for text.
Default: Arial, Verdana, sans-serif
textSize
The size of the text.
Default: 12
textBold
Whether the text is bold or not.
Default: false
textItalic
Whether the text is 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
labelsAbove
Whether to show the
labelsAbove
style labels.Default: false
labelsAbovePoint
The decimal point character to use for the
labelsAbove
labels.Default: null
labelsAboveThousand
The thousand separator character to use for the
labelsAbove
labels.Default: null
labelsAboveDecimals
The number of decimals to use for the
labelsAbove
labels.Default: 0
labelsAbovePre
A string to prepend to the
labelsAbove
labels.Default: null
labelsAbovePost
A string to append to the
labelsAbove
labels.Default: null
labelsAboveFormatter
A function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number.
Default: null
labelsAboveOffsetx
The horizontal offset of the
labelsAbove
labels.Default: 0
labelsAboveOffsety
The vertical offset of the
labelsAbove
labels.Default: 0
labelsAboveFont
The font of the
labelsAbove
labels.Default: null
labelsAboveSize
The size of the
labelsAbove
labels.Default: null
labelsAboveBold
Whether the
labelsAbove
labels are bold or not.Default: null
labelsAboveItalic
Whether the
labelsAbove
labels are italic or not.Default: null
labelsAboveColor
The color of the
labelsAbove
labels.Default: null
labelsAboveBackground
The background color of the
labelsAbove
labels.Default: null
labelsAboveBackgroundPadding
The padding of the
labelsAbove
labels.Default: 0
labelsAboveSpecific
This property allows you to make the
labelsAbove
labels specific strings.Default: null
Key properties
An array of the labels that appear on the key.
Default: null
keyColors
An array of colors to be shown on the key. If not specified then the
colors
option will be used instead.Default: null
keyLabelsColor
The color of the text in the key.
Default: null
keyLabelsBold
Whether the key text is bold or not.
Default: null
keyLabelsFont
The font to use for the key text. If not specified it defaults to the
textFont
setting.Default: null
keyLabelsSize
The size to use for the key text. If not specified then the
textSize
is used.Default: null
ketLabelsItalic
Whether the key text is italic or not.
Default: null
keyLabelsOffsetx
The horizontal pixel offset of the key text (just the text).
Default:
keyLabelsOffsety
The vertical pixel offset of the key text (just the text).
Default: -1
keyOffsetx
The horizontal pixel offset of the entire key.
Default:
keyOffsety
The horizontal pixel offset of the entire key.
Default:
keyColorShape
This controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are:
rect
, circle
, triangle
, line
, dot
, rectdot
Default: rect
Tooltip properties
Property | Description | Default |
---|---|---|
tooltips | An array of tooltips for the chart. This array should NOT be multidimensional - even for stacked or grouped charts. You can also check the canvas tooltips documentation for more information. | null |
tooltipsOverride | This can be a function that handles the tooltip showing instead of the default RGraph tooltips. It should look like this: tooltipsOverride: function (obj, opt)
{
// Show tooltip
} The opt is an argument that contains these items:
| null |
tooltipsEvent | The event used for tooltips (either click or mousemove . | click |
tooltipsFormattedPoint | When using formatted tooltip strings this is used as the point when using the %{value_formatted} option. | . |
tooltipsFormattedThousand | When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option. | , |
tooltipsFormattedDecimals | When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option. | 0 |
tooltipsFormattedUnitsPre | When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option. | (an empty string) |
tooltipsFormattedUnitsPost | When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option. | (an empty string) |
tooltipsFormattedKeyLabels | The labels that are used in the formatted tooltip key. | [] (an empty array) |
tooltipsFormattedKeyColors | The colors that are used in the formatted tooltip key. Normally these are automatically taken from the colors on the chart but can be specified differently using this property. | null |
tooltipsFormattedKeyColorsShape | This is the shape that's used in the tooltip key. It can be square or circle | 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: "1 px solid #ddd"; } | null |
tooltipsFormattedListType | With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol . | 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; } | 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. | 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 in the canvas documentation, copy the code from it and then modify it suit. You'll create fewer bugs this way. | 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. | true |
tooltipsPointerCss | If you want any CSS values applied to the tooltips pointer (a CSS border, for example) then specify an object containing those values to this property. For example: tooltips: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' } | null |
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. | 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.SVG.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' } | null |
tooltipsCssClass | The CSS class that's applied to the tooltip div . | RGraph_tooltip |
tooltipsOffsetx | This property allows you to shift the tooltips left or right. | 0 |
tooltipsOffsety | This property allows you to shift the tooltips up or down. | 0 |
highlightStroke | The stroke color that's used when highlighting the chart. | rgba(0,0,0,0) |
highlightFill | The fill color that's used when highlighting the chart. | rgba(255,255,255,0.7) |
highlightLinewidth | The linewidth that's used when highlighting the chart. | 1 |
An array of tooltips for the chart. This array should NOT be multidimensional - even for stacked or grouped charts. You can also check the canvas tooltips documentation for more information.
Default: null
tooltipsOverride
This can be a function that handles the tooltip showing instead of the default RGraph tooltips. It should look like this:
tooltipsOverride: function (obj, opt)
{
// Show tooltip
}
The opt is an argument that contains these items: object
The chart object.index
The index of the element (that triggered the tooltip).sequentialIndex
The sequential index of the element that was clicked.text
The text to be used as the tooltip. Remember that this may containHTML
(or whatever else you may have specified).event
The event object (either aclick
ormousemove
event).
Default: null
tooltipsEvent
The event used for tooltips (either
click
or mousemove
.Default: click
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)
tooltipsFormattedKeyLabels
The labels that are used in the formatted tooltip key.
Default: [] (an empty array)
tooltipsFormattedKeyColors
The colors that are used in the formatted tooltip key. Normally these are automatically taken from the colors on the chart but can be specified differently using this property.
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: "1 px solid #ddd"; }
Default: null
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 in the
canvas
documentation, 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 (a CSS
border, for example) then specify an object containing those values to this property. For example: tooltips: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' }
Default: null
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.SVG.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' }
Default: null
tooltipsCssClass
The
CSS
class that's applied to the tooltip div
.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
highlightStroke
The stroke color that's used when highlighting the chart.
Default: rgba(0,0,0,0)
highlightFill
The fill color that's used when highlighting the chart.
Default: rgba(255,255,255,0.7)
highlightLinewidth
The
linewidth
that's used when highlighting the chart.Default: 1
Shadow properties
Whether a drop shadow is applied to the lines.
Default: false
shadowOffsetx
The horizontal offset of the shadow.
Default: 2
shadowOffsety
The vertical offset of the shadow.
Default: 2
shadowBlur
The extent of the blurring effect that's applied to the shadow.
Default: 2
shadowColor
The color of the shadow.
Default: rgba(0,0,0,0.25)
Title properties
The title of the chart.
Default: (An empty string)
titleX
The specific
X-axis
coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.Default: null
titleY
The specific
Y-axis
coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.Default: null
titleOffsetx
An offset value that is added to the calculated X coordinate.
Default: 0
titleOffsety
An offset value that is added to the calculated Y coordinate.
Default: 0
titleHalign
The horizontal alignment of the title.
Default: center
titleColor
The color of the title.
Default: null
titleFont
The font used to render the title.
Default: null
titleSize
The size of the font used to render the title.
Default: null
titleBold
Whether the title is bold or not.
Default: null
titleItalic
Whether the title is italic or not.
Default: null
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: (An empty string)
titleSubtitleColor
The color of the subtitle.
Default: #aaa
titleSubtitleFont
The font used to render the subtitle.
Default: null
titleSubtitleSize
The size of 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
Other properties
The
linewidth
(around the bars) used. Remember to set the colorsStroke
setting to something other than transparent (the default).Default: 1
grouping
Whether to show a grouped or stacked Bar chart. It can be
stacked
or grouped
.Default: grouped
Methods
obj.get(name)
This can be used to get properties if necessary. It's normally used after the chart is drawn if you need to get parameters (if you're doing custom coding for example).
obj.set(name, value)
This can be used to set properties if necessary. It's normally used after the chart is drawn if you need to set additional parameters or change them.
obj.getWidth(value)
This returns the width that represents the given value. It does not give you a start or end point - just the width.
obj.getLeftXCoord(value)
This returns the left-hand-side X-axis
coordinate for a given value. The left
X-axis
coordinate can be retrieved by doing this:
<script> x0 = obj.get('marginLeft') + obj.graphWidth; </script>
obj.getRightXCoord(value)
This returns the right-hand-side X-axis
coordinate for a given value. The right
X-axis
coordinate can be retrieved by doing this:
<script> x0 = obj.get('marginLeft') + obj.graphWidth + obj.get('marginCenter'); </script>
obj.on(event, handler)
This function adds an event listener (such as beforedraw
or
draw
) to the chart object. For example:
obj.on('draw', function (obj)
{
// Put your code here
});
obj.exec(func)
This function can be used to execute a function (immediately). It's not event-based
(ie it doesn't run when something happens) - it just runs immediately - and only once.
You might use it when you need to get something from the chart when it's drawn and
then call the redraw function. Because this function only runs once the RGraph.SVG.redraw
function would not cause a loop - which would happen if you used the draw
event.
obj.exec(function (obj)
{
// Put your code 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.
The responsive function is documented on its own page here.
Data properties that are used on the bars
The SVG
rect
elements that represent the bars on the Bipolar chart have
various data attributes added to them that hold various bits of information. These
are:
data-original-x
data-original-y
data-original-width
data-original-height
data-index
data-subindex
(only used in grouped or stacked charts)data-sequential-index
data-value
data-tooltip
These can be retrieved by using standard DOM
methods:
obj.coords[0].element.getAttribute('data-sequential-index');
Events
RGraph supports custom events that allow you to easily add interactivity to your charts if required. The following events are available:
beforedraw
This event fires at the start of thedraw
method before anything has been done.draw
This event fires at the end of thedraw
function.firstdraw
This event fires at the end of thedraw
function - but only the first time and so it fires only once after the firstdraw
call.beforetooltip
This event fires at the start of the tooltip showing process.tooltip
This event fires after a tooltip has been shown.
new RGraph.SVG.Bipolar({ id: 'chart-container', left: [4,8,6,4,5,2,3], right: [8,4,6,3,5,8,4], options: { } }).on('draw', function (obj) { console.log('The draw event has fired'); }).draw();
Effects
These effects are available and can be used instead of thedraw
function.
- The
grow
effect (svg-bipolar-effect-grow.html
in the download archive) - The
wave
effect (svg-bipolar-effect-wave.html
in the download archive)
<script> // // Optional callback function that's called when the effect is complete // function myCallback (obj) { // ... } obj = new RGraph.SVG.Bipolar({ id: 'chart-container', left: [4,8,6,3,6,9,8], right: [4,5,3,5,6,1,2], options: { } }).grow({frames: 60, callback: myCallback}); </script>