Bar chart API reference
Summary: Documentation about the Bar chart including information about all of the options that are available to you. The Bar chart is a very commonly used type of chart and is very versatile. As such there are lots of Bar chart demos available in the download that demonstrate what you can do with it.
- Example
- Properties
- Methods
- Custom RGraph events that are available
- Errorbars
- Note about the data_arr array
- Bar chart effects
Example
<script> data = [[3,5,6],[8,4,5],[4,9,6]]; labels = ['Richard', 'Alex', 'Nick']; new RGraph.Bar({ id: 'cvs', data: data, options: { xaxisTickmarksCount: 0, xaxisLinewidth: 5, backgroundGridVlines: false, backgroundGridBorder: false, yaxis: false, colors:[ 'Gradient(#faa:red)', 'Gradient(#afa:green)', 'Gradient(#aaf:blue)' ], textSize: 24, xaxisLabels: labels, marginLeft: 45, backgroundGrid: true, marginInner: 50, tooltips: '<b>Results</b><br />%{key}', tooltipsFormattedKeyLabels: ['06:00','12:00','18:00'], tooltipsFormattedKeyColors:['red','green','blue'], tooltipsFormattedUnitsPost: '%', tooltipsCss: { fontSize: '16pt', textAlign: 'left' } } }).wave(); </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.
- Background properties
- X axis properties
- Y axis properties
- Color properties
- Margin properties
- Labels and text properties
- Title properties
- Shadow properties
- Key properties
- Interactive features properties
- Miscellaneous properties
Background properties
The number of background bars.
Default: 5
backgroundBarsColor1
The color of the background bars, (1 of 2).
Default: rgba(0,0,0,0)
backgroundBarsColor2
The color of the background bars, (2 of 2).
Default: rgba(0,0,0,0)
backgroundGrid
Whether to show the background grid or not.
Default: true
backgroundGridColor
The color of the background grid.
Default: #ddd
backgroundGridHsize
The horizontal background grid size.
Default: 40
backgroundGridVsize
The vertical background grid size.
Default: 18
backgroundGridLinewidth
The width that the background grid lines are. Decimals (eg 0.5) are permitted.
Default: 1
backgroundGridBorder
Determines whether a border line is drawn around the grid.
Default: true
backgroundGridHlines
Determines whether to draw the horizontal grid lines.
Default: true
backgroundGridVlines
Determines whether to draw the vertical grid lines.
Default: true
backgroundGridAutofit
Instead of specifying a pixel width/height for the background grid, you can use autofit and specify how many horizontal and vertical lines you want.
Default: true
backgroundGridHlinesCount
When using autofit this allows you to specify how many horizontal grid lines you want.
Default: 5
backgroundGridVlinesCount
When using autofit this allows you to specify how many vertical grid lines you want.
Default: 20
backgroundGridAlign
If you want to have your grid lines line up with the labels (both X and Y axes), you can set this to true and RGraph will attempt to make the grid lines line up. If you have a
marginInner
set then the alignment will be thrown out.Default: false
backgroundGridDotted
If you want to have your background grid dashed then set this to true.
Default: false
backgroundGridDashed
If you want to have your background grid dotted then set this to true. This takes precedence over dashed lines.
Default: false
backgroundHbars
An array of information stipulating horizontal colored bars. You can use these to indicate limits. Eg:
obj.set('hbars', [[75, 10, 'yellow'], [85, 15, 'red']]);
This would give you two bars, one red and a lower yellow bar. The units correspond to your scale, and are the starting point and the height.Default: null
backgroundImage
If you want to specify a background image to use on your chart, specify it with this property. If you use effects with a background image on your chart it may make the effect flicker. Using a background image with the draw event may mean that the event fires twice. There is a property that you can check though that is set when the image has loaded:
obj.__rgraph_background_image_loaded__
Simply check this flag in your draw
event. If it's true then the background image has loaded.Default: null
backgroundImageStretch
By default your background image is stretched (if necessary) to cover the whole chart area (margins not included). If this is not what you want then set this property to false.
Default: true
backgroundImageX
The X position of the image. The coordinates are the top left corner of the image.
Default: null
backgroundImageY
The Y position of the image. The coordinates are the top left corner of the image.
Default: null
backgroundImageW
The width of the image. If you have a large canvas with many charts - you may need to specify this.
Default: null
backgroundImageH
The height of the image. If you have a large canvas with many charts - you may need to specify this.
Default: null
backgroundImageAlign
Instead of specifying the coordinates of the image, you can instead simply align it top, bottom, left or right. Examples are:
top left
bottom right
bottom
right
Default: null
backgroundImageAlpha
The alpha value (the opacity) of the image.
Default: 1
backgroundColor
If you want to have a single background color for your chart you can use this. It doesn't cover the margins. If you want that then you can simply apply a CSS background color to the canvas tag.
Default: null
X axis properties
Set this to true if you don't want an X axis.
Default: true
xaxisPosition
This determines where the X axis is positioned. If you wish to show negative values then you should set this to
center
or you can now (Jul 2016) use an offset X axis by leaving this property at the default bottom
and using the yaxisScaleMax
and yaxisScaleMin
properties.Default: bottom
xaxisLinewidth
The linewidth used for the X axis and the X axis tickmarks.
Default: 1
xaxisColor
The color of the X axis (and its tickmarks.
Default: black
xaxisTickmarks
Whether the X axis tickmarks are shown.
Default: true
xaxisTickmarksLastLeft
Whether the last tickmark on the left is displayed.
Default: null
xaxisTickmarksLastRight
Whether the last tickmark on the right is displayed.
Default: null
xaxisTickmarksLength
The length of the tickmarks.
Default: 3
xaxisTickmarksCount
The number of tickmarks that are shown on the X axis.
Default: null
xaxisLabels
An array of the labels to be used on the chart.
Default: An empty array
xaxisLabelsFont
The font used to render the labels.
Default: null
xaxisLabelsSize
The size of the labels.
Default: null
xaxisLabelsColor
The color of the labels.
Default: null
xaxisLabelsBold
Whether the labels are bold or not.
Default: null
xaxisLabelsItalic
Whether the labels are italic or not.
Default: null
xaxisLabelsOffsetx
This allows you finer grained control in the horizontal direction over the X label positioning if you need it.
Default: 0
xaxisLabelsOffsety
This allows you finer grained control in the vertical direction over the X label positioning if you need it.
Default: 0
xaxisLabelsHalign
The horizontal alignment of the labels.
Default: center
xaxisLabelsValign
The vertical alignment of the labels.
Default: top
xaxisLabelsAngle
The angle of the X axis labels. For example you could set this to 45 to get angled labels.
Default: 0 (Horizontal)
xaxisLabelsPosition
This property controls how the labels are arranged -
section
for most chart types and edge
for Line charts. You probably won't need to change this.Default: section
xaxisLabelsClass
This property allows you to add your own CSS class to the X 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 browsers 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]
xaxisLabelsSpecificAlign
This determines the alignment of the specific labels. You probably won't need this.
Default: left
xaxisTitle
This allows you to specify a title for the X axis.
Default: none
xaxisTitleSize
This allows you to specify a size for the X axis title.
Default: null
xaxisTitleFont
This allows you to specify a font for the X axis title.
Default: null
xaxisTitleBold
This controls whether the X axis title is bold or not.
Default: null
xaxisTitleItalic
This controls whether the X axis title is italic or not.
Default: null
xaxisTitleColor
This controls the color of the X axis title.
Default: null
xaxisTitleX
By giving this you can specifically set the X position of the X axis title.
Default: null
xaxisTitleY
By giving this you can specifically set the Y position of the X axis title.
Default: null
xaxisTitleOffsetx
The X pixel offset that's applied to the title.
Default: 0
xaxisTitleOffsety
The Y pixel offset that's applied to the title.
Default: 0
xaxisTitleHalign
The horizontal alignment of the title.
Default: center
xaxisTitleValign
The vertical alignment of the title.
Default: top
xaxisTitlePos
This is a multiplier (ie a digit usually between 0 and 1) that gets multiplied with the margin to get the Y position of the title.
Default: null
Y axis properties
Whether the Y axis is drawn.
Default: true
yaxisPosition
Specifies the Y axis position. Can be
left
or right
.Default: left
yaxisLinewidth
The linewidth of the Y axis.
Default: 1
yaxisColor
The color of the Y axis.
Default: black
yaxisTickmarks.
Whether the Y axis tickmarks are drawn.
Default: true
yaxisTickmarksLength
The length of the Y axis tickmarks.
Default: 3
yaxisTickmarksCount
This allows you to stipulate how many Y axis tickmarks there are.
Default: null (related to how many labels there are)
yaxisTickmarksLastTop
Whether the top-most tickmark is drawn.
Default: null (displayed if the X axis position warrants it)
yaxisTickmarksLastBottom
Whether the bottom-most tickmark is drawn.
Default: null (displayed if the X axis position warrants it)
yaxisLabelsCount
A value that controls how many Y labels there are. This value could formerly be either 1/3/5/10 however now it can be any number.
Default: 5
yaxisLabelsSpecific
You can use this option to give your own Y labels (eg
['Low', 'Medium', 'High']
. Note: Since March 2013 you may now need to add an extra (optionally) empty element to the array of labels to achieve your desired result.Default: null
yaxisLabelsPosition
This controls how the specific labels are positioned on the Y axis. It has no effect on a scale.
Default: edge
yaxisLabelsOffsetx
This allows you finer grained control in the horizontal direction over the Y label positioning if you need it.
Default: 0
yaxisLabelsOffsety
This allows you finer grained control in the vertical direction over the Y label positioning if you need it.
Default: 0
yaxisLabelsFont
The font that's used by the Y axis labels.
Default: null
yaxisLabelsSize
The size of the Y axis labels.
Default: null
yaxisLabelsColor
The color of the Y axis labels.
Default: null
yaxisLabelsBold
Whether the Y axis labels are bold or not.
Default: null
yaxisLabelsItalic
Whether the Y axis labels are italic or not.
Default: null
yaxisLabelsHalign
The horizontal alignment of the Y axis labels.
Default: null
yaxisLabelsValign
The vertical alignment of the Y axis labels.
Default: null
yaxisTitle
This allows you to specify a title for the Y axis.
Default: none
yaxisTitleSize
This allows you to specify a size for the Y axis title.
Default: null
yaxisTitleFont
This allows you to specify a font for the Y axis title.
Default: null
yaxisTitleBold
This controls whether the Y axis title is bold or not.
Default: null
yaxisTitleColor
This controls what color the Y axis title is.
Default: null
yaxisTitleItalic
This controls whether the Y axis title is italic or not.
Default: null
yaxisTitlePos
This is multiplied with the margin to give the position of the Y axis title.
Default: 0.25
yaxisTitleOffsetx
The pixel offset that's added to the Y axis titles X coordinate.
Default: 0
yaxisTitleOffsety
The pixel offset that's added to the Y axis titles Y coordinate.
Default: 0
yaxisTitleX
By giving this you can specifically set the X position of the Y axis title.
Default: null
yaxisTitleY
By giving this you can specifically set the Y position of the Y axis title.
Default: null
yaxisTitleHalign
The horizontal alignment of the Y axis title.
Default: null
yaxisTitleValign
The vertical alignment of the Y axis title.
Default: null
yaxisTitleAccessible
With this property you can control whether the Y axis title is accessible or not.
Default: true
yaxisScale
Whether the Y axis scale is displayed or not.
Default: true
yaxisScaleRound
Whether the Y axis scale is rounded up or not.
Default: false
yaxisScaleUnitsPre
The units that the Y axis is measured in. This string is displayed before the actual number, allowing you to specify values such as "$50".
Default: none
yaxisScaleUnitsPost
The units that the Y axis is measured in. This string is displayed after the actual number, allowing you to specify values such as "50ms".
Default: none
yaxisScaleMax
The optional maximum Y scale value. If not specified then it will be calculated.
Default: null (It's calculated)
yaxisScaleMin
The optional minimum Y scale value. If not specified then it will be 0.
Default: 0
yaxisScaleFormatter
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(opt) { var num = Number(opt.number) * 5; return String(num) } obj.set('yaxisScaleFormatter', myFormatter);
Default: null
yaxisScaleRound
Whether to round the scale up. eg A maximum value of 59 results in scale to 100.
Default: false
yaxisScaleDecimals
The number of decimal places to display for the Y scale.
Default: 0
yaxisScalePoint
The character used as the decimal point.
Default: .
yaxisScaleThousand
The character used as the thousand separator.
Default: ,
yaxisScaleInvert
Whether the Y axis scale is inverted or not.
Default: false
Color properties
An array of the colors of the bars.
Default: An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']
colorsStroke
The color of the outline of the bars.
Default: rgba(0,0,0,0)
colorsSequential
If true, for regular bar charts, (not stacked or grouped), the colors that you specify will be used in a sequential fashion.
Default: false
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
marginInner
The horizontal margin (in pixels) of the chart. The horizontal margin is on either side of each bar - so if you want to widen the bars then reduce this value.
Default: 5
marginInnerGrouped
In a grouped bar chart this is the margin between bars that are on the same group. You can see examples of the
marginInnerGrouped
in the examples folder of the download archive (eg the demos/bar-grouped2.html file).Default: 1
Labels and text properties
Property | Description | Default |
---|---|---|
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 (in points) of the labels. | 12 |
textColor | The color of the labels. | black |
textBold | Whether the font used to render the text is bold or not. | false |
textItalic | Whether the font used to render the text is italic or not. | false |
labelsAbove | If true, values will be shown above the bars. For regular and stacked bar charts units are included, whereas for grouped bar charts they're not (usually there isn't enough space for them). | false |
labelsAboveDecimals | This stipulates how many decimals are used in the labelsAbove labels. | 0 |
labelsAboveUnitsPre | The units to put on the labelsAbove labels. These are positioned before the number. | none |
labelsAboveUnitsPost | The units to put on the labelsAbove labels. These are positioned after the number. | none |
labelsAbovePoint | The character used as the labelsAbove decimal separator. | . |
labelsAboveThousand | The character used as the labelsAbove thousand separator. | , |
labelsAboveBackground | The background color of the labelsAbove labels. | rgba(0,0,0,0) |
labelsAboveSize | The font size of the labelsAbove labels. Useful if you only have a few bars. | null |
labelsAboveColor | The color 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 |
labelsAboveFont | The font face that is used to render the text. | null |
labelsAboveOffsetx | The horizontal offset of the labels above the bars (in pixels). | 0 |
labelsAboveOffsety | The distance of the labels above the bars (in pixels). | 4 |
labelsAboveAngle | You can use this to angle the text shown above the bars. It can be anything from -90 to 90 (degrees). | null |
labelsAboveSpecific | If instead of the values you want to show arbitrary text - you can with this. It should be an array of the labels to be shown. | null |
labelsIngraph | An array of labels for the chart which are drawn "inside" the chart. If you have 5 data points then this should have a corresponding number of elements, though there is a shorthand style available. | null |
labelsIngraphFont | The font that the ingraph labels are rendered in. | null |
labelsIngraphSize | The size of the ingraph labels. | null |
labelsIngraphColor | The color of the ingraph labels. | null |
labelsIngraphBold | Whether the ingraph labels are bold or not. | null |
labelsIngraphItalic | Whether the ingraph labels are italic or not. | null |
labelsIngraphOffsetx | This allows you finer grained control in the horizontal direction over the text positioning if you need it. | 0 |
labelsIngraphOffsety | This allows you finer grained control in the vertical direction over the text positioning if you need it. | 0 |
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 (in points) of the labels.
Default: 12
textColor
The color of the labels.
Default: black
textBold
Whether the font used to render the text is bold or not.
Default: false
textItalic
Whether the font used to render the text is italic or not.
Default: false
labelsAbove
If true, values will be shown above the bars. For regular and stacked bar charts units are included, whereas for grouped bar charts they're not (usually there isn't enough space for them).
Default: false
labelsAboveDecimals
This stipulates how many decimals are used in the
labelsAbove
labels.Default: 0
labelsAboveUnitsPre
The units to put on the
labelsAbove
labels. These are positioned before the number.Default: none
labelsAboveUnitsPost
The units to put on the
labelsAbove
labels. These are positioned after the number.Default: none
labelsAbovePoint
The character used as the
labelsAbove
decimal separator.Default: .
labelsAboveThousand
The character used as the
labelsAbove
thousand separator.Default: ,
labelsAboveBackground
The background color of the
labelsAbove
labels.Default: rgba(0,0,0,0)
labelsAboveSize
The font size of the
labelsAbove
labels. Useful if you only have a few bars.Default: null
labelsAboveColor
The color 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
labelsAboveFont
The font face that is used to render the text.
Default: null
labelsAboveOffsetx
The horizontal offset of the labels above the bars (in pixels).
Default: 0
labelsAboveOffsety
The distance of the labels above the bars (in pixels).
Default: 4
labelsAboveAngle
You can use this to angle the text shown above the bars. It can be anything from -90 to 90 (degrees).
Default: null
labelsAboveSpecific
If instead of the values you want to show arbitrary text - you can with this. It should be an array of the labels to be shown.
Default: null
labelsIngraph
An array of labels for the chart which are drawn "inside" the chart. If you have 5 data points then this should have a corresponding number of elements, though there is a shorthand style available.
Default: null
labelsIngraphFont
The font that the ingraph labels are rendered in.
Default: null
labelsIngraphSize
The size of the ingraph labels.
Default: null
labelsIngraphColor
The color of the ingraph labels.
Default: null
labelsIngraphBold
Whether the ingraph labels are bold or not.
Default: null
labelsIngraphItalic
Whether the ingraph labels are italic or not.
Default: null
labelsIngraphOffsetx
This allows you finer grained control in the horizontal direction over the text positioning if you need it.
Default: 0
labelsIngraphOffsety
This allows you finer grained control in the vertical direction over the text positioning if you need it.
Default: 0
Title properties
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 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
titleColor
The color of the title.
Default: null
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
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
Shadow properties
Whether a drop shadow is applied.
Default: false
shadowColor
The color of the shadow.
Default: #aaa
shadowOffsetx
The X offset of the shadow.
Default: 0
shadowOffsety
The Y offset of the shadow.
Default: 0
shadowBlur
The severity of the shadow blurring effect.
Default: 15
Key properties
The key properties are documented on the key documentation page.Interactive features properties
Property | Description | Default |
---|---|---|
contextmenu | An array of context menu items. More information about context menus is here. | [] (An empty array) |
tooltips | A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML. | null |
tooltipsEffect | The effect used for showing tooltips. Can be either or none . | fade |
tooltipsEvent | This is the event that triggers the tooltips. It can be either click or mousemove . | click |
tooltipsOverride | If you wish to handle showing tooltips yourself, this should be a function which does just that. There's more information on the tooltips documentation page. | null |
tooltipsHighlight | Set this to false if you don't want your charts to be highlighted. | true |
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 the tooltip DOES NOT get hidden. | false |
tooltipsHotspotXonly | If set to true the hotspot for the tooltips will ignore the height of the bar and extend from the top margin down to the bottom margin. This can be useful when you have zero value bars but still want to see the tooltips. | false |
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) |
tooltipsFormattedKeyColors | When using formatted tooltip strings you can give specific colors for the %{key} option to use. | 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: "1px solid #ddd"; } | null |
tooltipsFormattedKeyLabels | When using formatted tooltip strings these are the labels that are displayed. | [] (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 . | 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, 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 (for example a CSS border) 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.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 |
tooltipsCssClass | This is the name of the CSS class the chart uses. | 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 |
crosshairs | If true, you will get a crosshair centering on the current mouse position. | false |
crosshairsLinewidth | This controls the linewidth of the crosshairs. | 1 |
crosshairsColor | The color of the crosshairs. | #333 |
crosshairsHline | This determines whether the horizontal crosshair is shown. | true |
crosshairsVline | This determines whether the vertical crosshair is shown. | true |
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 |
adjustable | Defaulting to false, this determines whether your bar chart will be adjustable. | false |
adjustableOnly | This should be an array of values that determine whether a Bar is adjustable or not. A true value for when it is, a false value for when it's not. | null |
An array of context menu items. More information about context menus is here.
Default: [] (An empty array)
tooltips
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.
Default: null
tooltipsEffect
The effect used for showing tooltips. Can be either
or none
.Default: fade
tooltipsEvent
This is the event that triggers the tooltips. It can be either
click
or mousemove
.Default: click
tooltipsOverride
If you wish to handle showing tooltips yourself, this should be a function which does just that. There's more information on the tooltips documentation page.
Default: null
tooltipsHighlight
Set this to false if you don't want your charts to be highlighted.
Default: true
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 the tooltip DOES NOT get hidden.Default: false
tooltipsHotspotXonly
If set to true the hotspot for the tooltips will ignore the height of the bar and extend from the top margin down to the bottom margin. This can be useful when you have zero value bars but still want to see the tooltips.
Default: false
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:
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.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
crosshairs
If true, you will get a crosshair centering on the current mouse position.
Default: false
crosshairsLinewidth
This controls the linewidth of the crosshairs.
Default: 1
crosshairsColor
The color of the crosshairs.
Default: #333
crosshairsHline
This determines whether the horizontal crosshair is shown.
Default: true
crosshairsVline
This determines whether the vertical crosshair is shown.
Default: true
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
adjustable
Defaulting to false, this determines whether your bar chart will be adjustable.
Default: false
adjustableOnly
This should be an array of values that determine whether a Bar is adjustable or not. A true value for when it is, a false value for when it's not.
Default: null
Miscellaneous properties
Property | Description | Default |
---|---|---|
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. | null |
highlightStroke | If you use tooltips, this controls the color of the highlight stroke. | black |
highlightFill | If you use tooltips, this controls the color of the highlight fill. | rgba(255,255,255,0.5) |
variant | This stipulates whether you want a regular bar chart or a 3D chart. In August 2015 the 3D variant has much improved perspective. Possible values are:
| bar |
variantThreedOffsetx | This determines the size of the offset in the X direction. | 10 |
variantThreedOffsety | This determines the size of the offset in the Y direction. | 5 |
variantThreedXaxis | This allows you to turn on/off the 3D X axis. | true |
variantThreedYaxis | This allows you to turn on/off the 3D Y axis. | true |
grouping | How the bars are grouped, and it should be one of: grouped or stacked . | grouped |
bevelled | If true the bars will be given a 3D bevelled appearance. | false |
clearto | This is used in animations and effects as the default color to use when clearing the canvas. | null |
errorbars | This should be an array of errorbar information or it can simply be a number instead (see below). | false |
errorbarsLinewidth | This is the linewidth of the errorbars . | 1 |
errorbarsColor | This is the color of the errorbars . You can also override the color in the errorbars array. | black |
errorbarsCapped | This dictates whether the errorbars have caps on their ends or not. | true |
errorbarsCappedWidth | This is the width of the caps (in total) on the end of the errorbars . | 14 |
combinedEffect | Set this to the name of an effect (eg grow ) and the CombinedChart object will use that effect to draw the chart instead of the regular draw() function. | null |
combinedEffectOptions | This should be a STRING that contains a JavaScript object of options for the effect function like this: combinedEffectOptions: '{frames: 300}'It has to be a string because of a quirk of the option parsing system. | null |
combinedEffectCallback | A function that runs when this objects effect has completed. | null |
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: black
highlightFill
If you use tooltips, this controls the color of the highlight fill.
Default: rgba(255,255,255,0.5)
variant
This stipulates whether you want a regular bar chart or a 3D chart. In August 2015 the 3D variant has much improved perspective. Possible values are:
bar
3d
Default: bar
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
variantThreedXaxis
This allows you to turn on/off the 3D X axis.
Default: true
variantThreedYaxis
This allows you to turn on/off the 3D Y axis.
Default: true
grouping
How the bars are grouped, and it should be one of:
grouped
or stacked
.Default: grouped
bevelled
If true the bars will be given a 3D bevelled appearance.
Default: false
clearto
This is used in animations and effects as the default color to use when clearing the canvas.
Default: null
errorbars
This should be an array of errorbar information or it can simply be a number instead (see below).
Default: false
errorbarsLinewidth
This is the linewidth of the
errorbars
.Default: 1
errorbarsColor
This is the color of the
errorbars
. You can also override the color in the errorbars
array.Default: black
errorbarsCapped
This dictates whether the
errorbars
have caps on their ends or not.Default: true
errorbarsCappedWidth
This is the width of the caps (in total) on the end of the
errorbars
.Default: 14
combinedEffect
Set this to the name of an effect (eg
grow
) and the CombinedChart
object will use that effect to draw the chart instead of the regular draw()
function.Default: null
combinedEffectOptions
This should be a STRING that contains a JavaScript object of options for the effect function like this:
combinedEffectOptions: '{frames: 300}'It has to be a string because of a quirk of the option parsing system.
Default: null
combinedEffectCallback
A function that runs when this objects effect has completed.
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 or segment 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 Bar 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 Bar 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 bar or 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.getShapeByX(event)
This method is similar to the above, but only uses the X coordinate to determine the relevant bar.
obj.getValue(mixed)
This method can be used to get the value at a particular point or at the mouse coordinates, based on the scale that is in use. Not simply the coordinates of the mouse. The argument can either be an event object (for use in event listener functions) OR a two element array consisting of the X and Y coordinates (ie when you're not in an event listener function). It returns null if the mouse or coordinates are in the margin areas. An example:
bar.canvas.onclick = function (e) { var obj = e.target.__object__; var value = obj.getValue(e); // ... }
obj.getYCoord(value)
This method can be used to get a Y coordinate for a value when you're doing custom drawing on the chart. It returns null if the value is out of range.
obj.on(event, function)
This method can be used to set an event listener on an object. It
operates in a similar way to the jQuery on()
function.
The first argument is the event that you wish to attach to and the second
is the handler function. For example:
.on('draw', function (obj)
{
// Put 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.
The responsive()
function is documented on its own page 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>
bar = new RGraph.Bar({
id: 'cvs',
data: [4,6,2,4,8,5,8],
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>
Errorbars
Errorbars can allow you to show an upper and lower range for a particular
bar like the bar-errorbars.html
example page shows in
the download archive.
You can specify errorbars like this:
bar = new RGraph.Bar({
id: 'cvs',
data: [12,18,10,9,6,20,18],
options: {
xaxisLabels: ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday'],
shadow: false,
colors: ['red'],
colorsStroke: 'rgba(0,0,0,0)',
errorbars: [ [5,3], [2,6], [5,15,'blue',5,45] ],
errorbarsLinewidth: 2, // The default linewidth
errorbarsColor: 'gray', // The default color
errorbarsCapped: true, // Whether the ends of the errorbar have terminating lines
errorbarsCappedWidth: 14 // The default width of the caps
}
}).draw();
This would give you three errorbars and the elements of each errorbar array are (each one is optional):
- The upper extent of the errorbar
- The lower extent of the errorbar
- The color of this errorbar
- The linewidth of this errorbar
- The (total) width of the cap at the end of this errorbar
Note about the data_arr array
Sometimes you may wish to view your data as one big array, instead of one array per dataset. In this case theobj.data_arr
is available. This is one long array containing
all of the individual data points.
Animation effects
These 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
- Wave effect (effects-bar-wave.html in the download archive)
- Grow effect (effects-bar-grow.html in the download archive)
- ColorWave effect (effects-bar-color-wave.html in the download archive)
<script> /** * The optional callback function that's called when the effect is complete */ function myCallback (obj) { // ... } obj = new RGraph.Bar({ id: 'cvs', data: [3,4,7,5,6,9,8], options: { marginLeft: 35, marginInner: 60 } }).wave({frames: 60}, myCallback); // .grow({frames: 60}, myCallback); </script>