About
RGraph is a JavaScript charts library based on HTML5 SVG and canvas. RGraph is mature (over 15 years old) and has a wealth of features making it an ideal choice to show charts on your website.

More »

 

License
RGraph can be used for free under the GPL or if that doesn't suit your situation there's an inexpensive (£99) commercial license available.

More »

 

Download
Get the latest version of RGraph (version 6.16) from the download page. There's also older versions available, minified files and links to cdnjs.com hosted libraries.

More »

Bar chart

Example

A grouped Bar chart with tooltips
<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: '%{global:labels[%{index}]}',
            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'
            }
        }
    }).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.

Background properties

Name: backgroundBarsCount
Description: 
The number of background bars.
Default: 5
Name: backgroundBarsColor1
Description: 
The color of the background bars, (1 of 2).
Default: rgba(0,0,0,0)
Name: backgroundBarsColor2
Description: 
The color of the background bars, (2 of 2).
Default: rgba(0,0,0,0)
Name: backgroundGrid
Description: 
Whether to show the background grid or not.
Default: true
Name: backgroundGridColor
Description: 
The color of the background grid.
Default: #ddd
Name: backgroundGridHsize
Description: 
The horizontal background grid size.
Default: 40
Name: backgroundGridVsize
Description: 
The vertical background grid size.
Default: 18
Name: backgroundGridLinewidth
Description: 
The width that the background grid lines are. Decimals (eg 0.5) are permitted.
Default: 1
Name: backgroundGridBorder
Description: 
Determines whether a border is drawn around the grid.
Default: true
Name: backgroundGridHlines
Description: 
Determines whether to draw the horizontal grid lines.
Default: true
Name: backgroundGridVlines
Description: 
Determines whether to draw the vertical grid lines.
Default: true
Name: backgroundGridAutofit
Description: 
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
Name: backgroundGridHlinesCount
Description: 
When using autofit this allows you to specify how many horizontal gridlines you want.
Default: 5
Name: backgroundGridVlinesCount
Description: 
When using autofit this allows you to specify how many vertical gridlines you want.
Default: 20
Name: backgroundGridAlign
Description: 
If you want to have your gridlines line up with the labels (both X and Y axes), you can set this to true and RGraph will attempt to make the gridlines line up. If you have a marginInner set then the alignment will be thrown out.
Default: false
Name: backgroundGridDotted
Description: 
If you want to have your background grid dashed then set this to true.
Default: false
Name: backgroundGridDashed
Description: 
If you want to have your background grid dotted then set this to true. This takes precedence over dashed lines.
Default: false
Name: backgroundGridDashArray
Description: 
If you want a custom format for the line dash then you can give an array to this property. It should be an array of two or more numbers that specifies the size of dashes and gaps like this: [5, 10]
Default: null
Name: backgroundGridThreedYaxis
Description: 
If you're showing a 3D chart and don't want your grid lines to extend on to the Y axis then this property can be set to false.
Default: true
Name: backgroundHbars
Description: 
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
Name: backgroundImage
Description: 
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
Name: backgroundImageStretch
Description: 
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
Name: backgroundImageX
Description: 
The horizontal position of the image. The coordinates are the top left corner of the image.
Default: null
Name: backgroundImageY
Description: 
The vertical position of the image. The coordinates are the top left corner of the image.
Default: null
Name: backgroundImageW
Description: 
The width of the image. If you have a large canvas with many charts - you may need to specify this.
Default: null
Name: backgroundImageH
Description: 
The height of the image. If you have a large canvas with many charts - you may need to specify this.
Default: null
Name: backgroundImageAlign
Description: 
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
Name: backgroundImageAlpha
Description: 
The alpha value (the opacity) of the image.
Default: 1
Name: backgroundColor
Description: 
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
Name: backgroundBorder
Description: 
You can use this property to specify that the chart area has a border around it.
Default: false
Name: backgroundBorderLinewidth
Description: 
The linewidth of the border that goes around the chart area.
Default: 1
Name: backgroundBorderColor
Description: 
The color of the border that goes around the chart area.
Default: #aaa
Name: backgroundBorderDashed
Description: 
Whether the border around the chart area is dashed or not.
Default: false
Name: backgroundBorderDotted
Description: 
Whether the border around the chart area is dotted or not.
Default: false
Name: backgroundBorderDashArray
Description: 
If the default dot or dash style is not to your liking you can use this property to specify your own style. It should be an array of two or more elements that specify the dashes and spaces - for example: backgroundBorderDashArray: [5,10],
Default: null

X-axis properties

Name: xaxis
Description: 
Set this to true if you don't want an x-axis.
Default: true
Name: xaxisPosition
Description: 
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
Name: xaxisLinewidth
Description: 
The linewidth used for the x-axis and the x-axis tickmarks.
Default: 1
Name: xaxisColor
Description: 
The color of the x-axis (and its tickmarks.
Default: black
Name: xaxisTickmarks
Description: 
Whether the x-axis tickmarks are shown.
Default: true
Name: xaxisTickmarksLastLeft
Description: 
Whether the last tickmark on the left is displayed.
Default: null
Name: xaxisTickmarksLastRight
Description: 
Whether the last tickmark on the right is displayed.
Default: null
Name: xaxisTickmarksLength
Description: 
The length of the tickmarks.
Default: 3
Name: xaxisTickmarksCount
Description: 
The number of tickmarks that are shown on the x-axis.
Default: null
Name: xaxisLabels
Description: 
An array of the labels to be used on the chart. You can also give this option a string if you prefer and use formatted labels
Default: An empty array
Name: xaxisLabelsFont
Description: 
The font used to render the labels.
Default: null
Name: xaxisLabelsSize
Description: 
The size of the labels.
Default: null
Name: xaxisLabelsColor
Description: 
The color of the labels.
Default: null
Name: xaxisLabelsBold
Description: 
Whether the labels are bold or not.
Default: null
Name: xaxisLabelsItalic
Description: 
Whether the labels are italic or not.
Default: null
Name: xaxisLabelsOffsetx
Description: 
This allows you finer-grained control in the horizontal direction over the x-axis label positioning if you need it.
Default:  0
Name: xaxisLabelsOffsety
Description: 
This allows you finer-grained control in the vertical direction over the x-axis label positioning if you need it.
Default:  0
Name: xaxisLabelsHalign
Description: 
The horizontal alignment of the labels.
Default: center
Name: xaxisLabelsValign
Description: 
The vertical alignment of the labels.
Default: top
Name: xaxisLabelsAngle
Description: 
The angle of the x-axis labels. For example, you could set this to 45 to get angled labels.
Default: 0 (Horizontal)
Name: xaxisLabelsPosition
Description: 
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
Name: xaxisLabelsClass
Description: 
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 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]
Name: xaxisLabelsSpecificAlign
Description: 
This determines the alignment of the specific labels. You probably won't need this.
Default: left
Name: xaxisLabelsFormattedDecimals
Description: 
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default:  0
Name: xaxisLabelsFormattedPoint
Description: 
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .
Name: xaxisLabelsFormattedThousand
Description: 
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,
Name: xaxisLabelsFormattedUnitsPre
Description: 
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: xaxisLabelsFormattedUnitsPost
Description: 
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: xaxisTitle
Description: 
This allows you to specify a title for the x-axis.
Default: none
Name: xaxisTitleSize
Description: 
This allows you to specify a size for the x-axis title.
Default: null
Name: xaxisTitleFont
Description: 
This allows you to specify a font for the x-axis title.
Default: null
Name: xaxisTitleBold
Description: 
This controls whether the x-axis title is bold or not.
Default: null
Name: xaxisTitleItalic
Description: 
This controls whether the x-axis title is italic or not.
Default: null
Name: xaxisTitleColor
Description: 
This controls the color of the x-axis title.
Default: null
Name: xaxisTitleX
Description: 
By giving this you can specifically set the horizontal position of the x-axis title.
Default: null
Name: xaxisTitleY
Description: 
By giving this you can specifically set the vertical position of the x-axis title.
Default: null
Name: xaxisTitleOffsetx
Description: 
The horizontal pixel offset that's applied to the title.
Default:  0
Name: xaxisTitleOffsety
Description: 
The vertical pixel offset that's applied to the title.
Default:  0
Name: xaxisTitleHalign
Description: 
The horizontal alignment of the title.
Default: center
Name: xaxisTitleValign
Description: 
The vertical alignment of the title.
Default: top
Name: xaxisTitlePos
Description: 
This is a multiplier (ie a digit usually between 0 and 1) that gets multiplied with the margin to get the Y coordinate of the title.
Default: null

Y-axis properties

Name: yaxis
Description: 
Whether the y-axis is drawn.
Default: true
Name: yaxisPosition
Description: 
Specifies the y-axis position. Can be left or right.
Default: left
Name: yaxisLinewidth
Description: 
The linewidth of the y-axis.
Default: 1
Name: yaxisColor
Description: 
The color of the y-axis.
Default: black
Name: yaxisTickmarks.
Description: 
Whether the y-axis tickmarks are drawn.
Default: true
Name: yaxisTickmarksLength
Description: 
The length of the y-axis tickmarks.
Default: 3
Name: yaxisTickmarksCount
Description: 
This allows you to stipulate how many y-axis tickmarks there are.
Default: null (related to how many labels there are)
Name: yaxisTickmarksLastTop
Description: 
Whether the top-most tickmark is drawn.
Default: null (displayed if the X-axis position warrants it)
Name: yaxisTickmarksLastBottom
Description: 
Whether the bottom-most tickmark is drawn.
Default: null (displayed if the X-axis position warrants it)
Name: yaxisLabelsCount
Description: 
A value that controls how many y-axis labels there are. This value could formerly be either 1/3/5/10 however now it can be any number.
Default: 5
Name: yaxisLabelsSpecific
Description: 
You can use this option to give your own y-axis 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
Name: yaxisLabelsPosition
Description: 
This controls how the specific labels are positioned on the y-axis. It does not affect a scale.
Default: edge
Name: yaxisLabelsOffsetx
Description: 
This allows you finer-grained control in the horizontal direction over the y-axis label positioning if you need it.
Default:  0
Name: yaxisLabelsOffsety
Description: 
This allows you finer-grained control in the vertical direction over the y-axis label positioning if you need it.
Default:  0
Name: yaxisLabelsFont
Description: 
The font that's used by the y-axis labels.
Default: null
Name: yaxisLabelsSize
Description: 
The size of the y-axis labels.
Default: null
Name: yaxisLabelsColor
Description: 
The color of the y-axis labels.
Default: null
Name: yaxisLabelsBold
Description: 
Whether the y-axis labels are bold or not.
Default: null
Name: yaxisLabelsItalic
Description: 
Whether the y-axis labels are italic or not.
Default: null
Name: yaxisLabelsHalign
Description: 
The horizontal alignment of the y-axis labels.
Default: null
Name: yaxisLabelsValign
Description: 
The vertical alignment of the y-axis labels.
Default: null
Name: yaxisTitle
Description: 
This allows you to specify a title for the y-axis.
Default: none
Name: yaxisTitleSize
Description: 
This allows you to specify a size for the y-axis title.
Default: null
Name: yaxisTitleFont
Description: 
This allows you to specify a font for the y-axis title.
Default: null
Name: yaxisTitleBold
Description: 
This controls whether the y-axis title is bold or not.
Default: null
Name: yaxisTitleColor
Description: 
This controls what color the y-axis title is.
Default: null
Name: yaxisTitleItalic
Description: 
This controls whether the y-axis title is italic or not.
Default: null
Name: yaxisTitlePos
Description: 
This is multiplied with the margin to give the position of the y-axis title.
Default: 0.25
Name: yaxisTitleOffsetx
Description: 
The pixel offset that's added to the y-axis titles X coordinate.
Default:  0
Name: yaxisTitleOffsety
Description: 
The pixel offset that's added to the y-axis titles Y coordinate.
Default:  0
Name: yaxisTitleX
Description: 
By giving this you can specifically set the horizontal position of the y-axis title.
Default: null
Name: yaxisTitleY
Description: 
By giving this you can specifically set the vertical position of the y-axis title.
Default: null
Name: yaxisTitleHalign
Description: 
The horizontal alignment of the y-axis title.
Default: null
Name: yaxisTitleValign
Description: 
The vertical alignment of the y-axis title.
Default: null
Name: yaxisTitleAccessible
Description: 
With this property you can control whether the y-axis title is accessible or not.
Default: true
Name: yaxisScale
Description: 
Whether the y-axis scale is displayed or not.
Default: true
Name: yaxisScaleRound
Description: 
Whether the y-axis scale is rounded up or not.
Default: false
Name: yaxisScaleUnitsPre
Description: 
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
Name: yaxisScaleUnitsPost
Description: 
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
Name: yaxisScaleMax
Description: 
The optional maximum Y scale value. If not specified then it will be calculated.
Default: null (It's calculated)
Name: yaxisScaleMin
Description: 
The optional minimum Y scale value. If not specified then it will be 0.
Default:  0
Name: yaxisScaleFormatter
Description: 
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
Name: yaxisScaleRound
Description: 
Whether to round the scale up. eg A maximum value of 59 results in scale to 100.
Default: false
Name: yaxisScaleDecimals
Description: 
The number of decimal places to display for the y-axis scale.
Default:  0
Name: yaxisScalePoint
Description: 
The character that's used as the decimal point.
Default: .
Name: yaxisScaleThousand
Description: 
The character that's used as the thousand separator.
Default: ,
Name: yaxisScaleInvert
Description: 
Whether the y-axis scale is inverted or not.
Default: false

Color properties

Name: colors
Description: 
An array of the colors of the bars.
Default: An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']
Name: colorsStroke
Description: 
The color of the outline of the bars.
Default: rgba(0,0,0,0)
Name: colorsSequential
Description: 
If true, for regular Bar charts, (not stacked or grouped), the colors that you specify will be used sequentially.
Default: false

Margin properties

Name: marginLeft
Description: 
The left margin of the chart, (the margin is where the labels and title are)).
Default: 35
Name: marginRight
Description: 
The right margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginTop
Description: 
The top margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginBottom
Description: 
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginInner
Description: 
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
Name: marginInnerGrouped
Description: 
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

Name: textAccessible
Description: 
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
Name: textAccessibleOverflow
Description: 
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
Name: textAccessiblePointerevents
Description: 
This controls whether the dom text responds to mouse-based events or not (it sets the pointer-events css property to none).
Default: true
Name: textFont
Description: 
The font used to render the text.
Default: Arial, Verdana, sans-serif
Name: textSize
Description: 
The size (in points) of the labels.
Default: 12
Name: textColor
Description: 
The color of the labels.
Default: black
Name: textBold
Description: 
Whether the font used to render the text is bold or not.
Default: false
Name: textItalic
Description: 
Whether the font used to render the text is italic or not.
Default: false
Name: labelsAbove
Description: 
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
Name: labelsAboveDecimals
Description: 
This stipulates how many decimals are used in the labelsAbove labels.
Default:  0
Name: labelsAboveUnitsPre
Description: 
The units to put on the labelsAbove labels. These are positioned before the number.
Default: none
Name: labelsAboveUnitsPost
Description: 
The units to put on the labelsAbove labels. These are positioned after the number.
Default: none
Name: labelsAbovePoint
Description: 
The character that's used as the labelsAbove decimal separator.
Default: .
Name: labelsAboveThousand
Description: 
The character that's used as the labelsAbove thousand separator.
Default: ,
Name: labelsAboveBackground
Description: 
The background color of the labelsAbove labels.
Default: transparent
Name: labelsAboveSize
Description: 
The font size of the labelsAbove labels. Useful if you only have a few bars.
Default: null
Name: labelsAboveColor
Description: 
The color of the labelsAbove labels.
Default: null
Name: labelsAboveBold
Description: 
Whether the labelsAbove labels are bold or not.
Default: null
Name: labelsAboveItalic
Description: 
Whether the labelsAbove labels are italic or not.
Default: null
Name: labelsAboveFont
Description: 
The font face that is used to render the text.
Default: null
Name: labelsAboveOffsetx
Description: 
The horizontal offset of the labels above the bars (in pixels).
Default:  0
Name: labelsAboveOffsety
Description: 
The distance of the labels above the bars (in pixels).
Default: 4
Name: labelsAboveAngle
Description: 
You can use this to angle the text shown above the bars. It can be anything from -90 to 90 (degrees).
Default: null
Name: labelsAboveSpecific
Description: 
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
Name: labelsIngraph
Description: 
An array of labels for the chart that 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
Name: labelsIngraphFont
Description: 
The font that the ingraph labels are rendered in.
Default: null
Name: labelsIngraphSize
Description: 
The size of the ingraph labels.
Default: null
Name: labelsIngraphColor
Description: 
The color of the ingraph labels.
Default: null
Name: labelsIngraphBold
Description: 
Whether the ingraph labels are bold or not.
Default: null
Name: labelsIngraphItalic
Description: 
Whether the ingraph labels are italic or not.
Default: null
Name: labelsIngraphOffsetx
Description: 
This allows you finer-grained control in the horizontal direction over the text positioning if you need it.
Default:  0
Name: labelsIngraphOffsety
Description: 
This allows you finer-grained control in the vertical direction over the text positioning if you need it.
Default:  0
Name: text
Description: 
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

Name: title
Description: 
The title of the chart, if any.
Default: null
Name: titleFont
Description: 
The font that the title is rendered in. If not specified the textFont setting is used (usually Arial).
Default: null
Name: titleSize
Description: 
The size of the title. If not specified the size is usually 4pt bigger than the textSize setting.
Default: null
Name: titleBold
Description: 
Whether the title is bold or not.
Default: null
Name: titleItalic
Description: 
Whether the title is italic or not.
Default: null
Name: titleColor
Description: 
The color of the title.
Default: null
Name: titleX
Description: 
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
Name: titleY
Description: 
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
Name: titleHalign
Description: 
The horizontal alignment of the title.
Default: center (can change depending on other options)
Name: titleValign
Description: 
The vertical alignment of the title.
Default: center (can change depending on other options)
Name: titleOffsetx
Description: 
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
Name: titleOffsety
Description: 
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
Name: titleSubtitle
Description: 
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
Name: titleSubtitleSize
Description: 
The size of the font used to render the subtitle.
Default: null
Name: titleSubtitleColor
Description: 
The color of the subtitle.
Default: #aaa
Name: titleSubtitleFont
Description: 
The font used to render the subtitle.
Default: null
Name: titleSubtitleBold
Description: 
Whether the subtitle is bold or not.
Default: null
Name: titleSubtitleItalic
Description: 
Whether the subtitle is italic or not.
Default: null
Name: titleSubtitleOffsetx
Description: 
Use this property to adjust the horizontal position of the subtitle.
Default:  0
Name: titleSubtitleOffsety
Description: 
Use this property to adjust the vertical position of the subtitle.
Default:  0

Shadow properties

Name: shadow
Description: 
Whether a drop shadow is applied.
Default: false
Name: shadowColor
Description: 
The color of the shadow.
Default: #aaa
Name: shadowOffsetx
Description: 
The horizontal offset of the shadow.
Default:  0
Name: shadowOffsety
Description: 
The vertical offset of the shadow.
Default:  0
Name: shadowBlur
Description: 
The severity of the shadow blurring effect.
Default: 15

Key properties

The key properties are documented on the key documentation page.

Interactive features properties

Name: contextmenu
Description: 
An array of context menu items. More information about context menus is here.
Default: [] (An empty array)
Name: tooltips
Description: 
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain html. This can also be a string - and you can use formatting macros to customise the tooltip. See the tooltips documentation page for further detail.
Default: null
Name: tooltipsEffect
Description: 
The effect used for showing tooltips. Possible values are slide fade or none.
Default: slide
Name: tooltipsEvent
Description: 
This is the event that triggers the tooltips. It can be either click or mousemove.
Default: click
Name: tooltipsOverride
Description: 
If you wish to handle showing tooltips yourself, this should be a function that does just that. There's more information on the tooltips documentation page.
Default: null
Name: tooltipsHighlight
Description: 
Set this to false if you don't want your charts to be highlighted.
Default: true
Name: tooltipsFormattedPoint
Description: 
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .
Name: tooltipsFormattedThousand
Description: 
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,
Name: tooltipsFormattedDecimals
Description: 
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default:  0
Name: tooltipsFormattedUnitsPre
Description: 
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)
Name: tooltipsFormattedUnitsPost
Description: 
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)
Name: tooltipsFormattedKeyColors
Description: 
When using formatted tooltip strings you can give specific colors for the %{key} option to use.
Default: null
Name: tooltipsFormattedKeyColorsShape
Description: 
This is the shape that's used in the tooltip key. It can be square or circle
Default: square
Name: tooltipsFormattedKeyColorsCss
Description: 
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
Name: tooltipsFormattedKeyLabels
Description: 
When using formatted tooltip strings these are the labels that are displayed.
Default: [] (an empty array)
Name: tooltipsFormattedListType
Description: 
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.
Default: ul
Name: tooltipsFormattedListItems
Description: 
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
Name: tooltipsFormattedTableHeaders
Description: 
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
Name: tooltipsFormattedTableData
Description: 
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 to suit. You'll create fewer bugs this way.
Default: null)
Name: tooltipsPointer
Description: 
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
Name: tooltipsPointerCss
Description: 
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
Name: tooltipsPointerOffsetx
Description: 
This allows you to adjust the vertical position of the tooltips pointer.
Default:  0
Name: tooltipsPointerOffsety
Description: 
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
Name: tooltipsPositionStatic
Description: 
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
Name: tooltipsCss
Description: 
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
Name: tooltipsCssClass
Description: 
This is the name of the css class the chart uses.
Default: RGraph_tooltip
Name: tooltipsOffsetx
Description: 
This property allows you to shift the tooltips left or right.
Default:  0
Name: tooltipsOffsety
Description: 
This property allows you to shift the tooltips up or down.
Default:  0
Name: tooltipsHotspotXonly
Description: 
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
Name: tooltipsHotspotIgnore
Description: 
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:
  • 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)
Default: null
Name: crosshairs
Description: 
If true, you will get a crosshair centering on the current mouse position.
Default: false
Name: crosshairsLinewidth
Description: 
This controls the linewidth of the crosshairs.
Default: 1
Name: crosshairsColor
Description: 
The color of the crosshairs.
Default: #333
Name: crosshairsHline
Description: 
This determines whether the horizontal crosshair is shown.
Default: true
Name: crosshairsVline
Description: 
This determines whether the vertical crosshair is shown.
Default: true
Name: crosshairsSnapToScale
Description: 
If set to true the horizontal grid line will snap to the scale values.
Default: false
Name: annotatable
Description: 
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false
Name: annotatableColor
Description: 
If you do not allow the use of the palette, then this will be the only color allowed for annotations.
Default: black
Name: annotatableLinewidth
Description: 
This is the linewidth of the annotations.
Default: 1
Name: adjustable
Description: 
Defaulting to false, this determines whether your Bar chart will be adjustable.
Default: false
Name: adjustableOnly
Description: 
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

Name: highlightStyle
Description: 
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
Name: highlightStroke
Description: 
If you use tooltips, this controls the color of the highlight stroke.
Default: black
Name: highlightFill
Description: 
If you use tooltips, this controls the color of the highlight fill.
Default: rgba(255,255,255,0.5)
Name: variant
Description: 
This stipulates whether you want a regular Bar chart or a 3D Bar chart. In August 2015 the 3D variant has much-improved perspective. Possible values are:
  • bar
  • 3d
Default: bar
Name: variantThreedAngle
Description: 
This is the angle that is used to slant the canvas (it's measured in radians).
Default: 0.1
Name: variantThreedOffsetx
Description: 
This determines the size of the offset in the horizontal direction.
Default: 10
Name: variantThreedOffsety
Description: 
This determines the size of the offset in the vertical direction.
Default: 5
Name: variantThreedXaxis
Description: 
This allows you to turn on/off the 3D x-axis.
Default: true
Name: variantThreedYaxis
Description: 
This allows you to turn on/off the 3D y-axis.
Default: true
Name: variantThreedXaxisColor
Description: 
This allows you to set the color of the 3D x-axis.
Default: #ddd
Name: variantThreedYaxisColor
Description: 
This allows you to set the color of the 3D y-axis.
Default: #ddd
Name: grouping
Description: 
How the bars are grouped, and it should be one of: grouped or stacked.
Default: grouped
Name: beveled
Description: 
If true the bars will be given a 3D beveled appearance.
Default: false
Name: clearto
Description: 
This is used in animations and effects as the default color to use when clearing the canvas.
Default: null
Name: errorbars
Description: 
This should be an array of errorbar information or it can simply be a number instead (see below).
Default: false
Name: errorbarsLinewidth
Description: 
This is the linewidth of the errorbars.
Default: 1
Name: errorbarsColor
Description: 
This is the color of the errorbars. You can also override the color in the errorbars array.
Default: black
Name: errorbarsCapped
Description: 
This dictates whether the errorbars have caps on their ends or not.
Default: true
Name: errorbarsCappedWidth
Description: 
This is the width of the caps (in total) on the end of the errorbars.
Default: 14
Name: combinedEffect
Description: 
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
Name: combinedEffectOptions
Description: 
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
Name: combinedEffectCallback
Description: 
A function that runs when this objects effect has finished.
Default: null
Name: corners
Description: 
This can be square (the default) or round. When it's set to round the tops of the bars will have rounded corners. There's a demo in the download archive that demonstrates this called bar-rounded-corners.html.
Default: square
Name: cornersRoundRadius
Description: 
This is the extent of the rounded corners. Bigger values mean rounder corners.
Default: 10
Name: cornersRoundLeft
Description: 
This allows you to control whether the left-hand-side of the bars are rounded or not.
Default: true
Name: cornersRoundRight
Description: 
This allows you to control whether the right-hand-side of the bars are rounded or not.
Default: true
Name: cornersRoundLeftRadius
Description: 
This property allows you to specify the radius for the left-hand-side of the bars.
Default: null
Name: cornersRoundRightRadius
Description: 
This property allows you to specify the radius for the right-hand-side of the bars.
Default: null
Name: horizontalLines
Description: 
With this property you can add horizontal lines to your chart. This feature was initially designed with adding an average line indicator in mind but can be used to indicate any value with any label. The value of this property should be an array of objects and each object can consist of the following:
  • value: The value you want the line positioned at or the keyword average (default: average)
  • color: The color of the line (default: #666)
  • dashed: Whether the line is dashed or not (default: true)
  • dotted: Whether the line is dotted or not (default: false)
  • linewidth: The linewidth of the line (default: 1)
  • label: this is The label that appears above (by default) the line. If you don't want a label you can set this to an empty string. default: Average (%{value})
  • labelPosition: This can be a string that consists of the following keywords: left/center/right/left-margin/right-margin top/bottom (default: top right)
  • labelFont: The font that the label is drawn in (default: [the same as the textFont property])
  • labelColor: The color that the label is drawn in (default: #666)
  • labelSize: The size of the label (in points) (default: 4 points less than the textSize setting)
  • labelBold: Whether the label is bold or not (default: null [falls back to the textBold setting])
  • labelItalic: Whether the label is italic or not (default: null [falls back to the textItalic setting])
  • labelValueDecimals: How many decimals are shown on the number. (default: 2)
  • labelValuePoint: The character used as the decimal point. (default: .)
  • labelValueThousand: The character used as the thousand separator charactor.(default: ,)
  • labelValueUnitsPre: This string is prended to the number. (default: [an empty string])
  • labelValueUnitsPost: This string is appended to the number. (default: [an empty string])
  • labelOffsetx: The horizontal offset that's applied to the X coordinate. (default: 0)
  • labelOffsety: The vertical offset that's applied to the Y coordinate. (default: 0)
  • labelValueFormatter: This function handles ALL of the formatting of the number. (default: null)
Here's an example:
obj.set('horizontalLines', [
    {
        value: 'average',
        dashed: true,
        labelPosition:'left bottom'
    },
    {
        value: 10.48,
        label:'Value (%{value})',
        labelValueDecimals: 2,
        labelValueThousand: ',',
        labelValuePoint:'.',
        labelValueUnitsPre:'',
        labelValueUnitsPost:''
        //labelValueFormatter: function (opt)
        //{
        //    return opt.number;
        //}
    }
]);
Default: null
Name: responsive
Description: 
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 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 are 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-axis 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-axis 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 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:

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

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

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, the obj.data_arr is available. This is one long array containing all of the individual data points.

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.Bar({
    id: 'cvs',
    data: [4,8,6,3,5,8,9],
    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>
    //
    // 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>