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

[No canvas support]
<script>
    data = [[3,5,6],[8,4,5],[4,9,6]];
    labels = ['Richard', 'Alex', 'Nick'];

    new RGraph.Bar({
        id: 'cvs',
        data: data,
        options: {
            xaxisLabels: labels,
            marginLeft: 45,
            backgroundGrid: true,
            colors: ['red','blue','yellow'],
            marginInner: 50,
            tooltips: '<b>Results</b><br />%{key}',
            tooltipsFormattedKeyLabels: ['06:00','12:00','18:00'],
            tooltipsFormattedUnitsPost: '%',
            tooltipsCss: {
                fontSize: '16pt',
                backgroundColor: 'black',
                color:'white',
                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

PropertyDescriptionDefault
backgroundBarsCountThe number of background bars.5
backgroundBarsColor1The color of the background bars, (1 of 2).rgba(0,0,0,0)
backgroundBarsColor2The color of the background bars, (2 of 2).rgba(0,0,0,0)
backgroundGridWhether to show the background grid or not.true
backgroundGridColorThe color of the background grid.#ddd
backgroundGridHsizeThe horizontal background grid size.40
backgroundGridVsizeThe vertical background grid size.18
backgroundGridLinewidthThe width that the background grid lines are. Decimals (eg 0.5) are permitted.1
backgroundGridBorderDetermines whether a border line is drawn around the grid.true
backgroundGridHlinesDetermines whether to draw the horizontal grid lines.true
backgroundGridVlinesDetermines whether to draw the vertical grid lines.true
backgroundGridAutofitInstead of specifying a pixel width/height for the background grid, you can use autofit and specify how many horizontal and vertical lines you want.true
backgroundGridHlinesCountWhen using autofit this allows you to specify how many horizontal grid lines you want.5
backgroundGridVlinesCountWhen using autofit this allows you to specify how many vertical grid lines you want.20
backgroundGridAlignIf 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.false
backgroundGridDottedIf you want to have your background grid dashed then set this to true.false
backgroundGridDashedIf you want to have your background grid dotted then set this to true. This takes precedence over dashed lines.false
backgroundHbarsAn 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.null
backgroundImageIf 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.null
backgroundImageStretchBy 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.true
backgroundImageXThe X position of the image. The coordinates are the top left corner of the image.null
backgroundImageYThe Y position of the image. The coordinates are the top left corner of the image.null
backgroundImageWThe width of the image. If you have a large canvas with many charts - you may need to specify this.null
backgroundImageHThe height of the image. If you have a large canvas with many charts - you may need to specify this.null
backgroundImageAlignInstead 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
null
backgroundImageAlphaThe alpha value (the opacity) of the image.1
backgroundColorIf 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.null
backgroundBarsCount
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:

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

PropertyDescriptionDefault
xaxisSet this to true if you don't want an X axis.true
xaxisPositionThis 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.bottom
xaxisLinewidthThe linewidth used for the X axis and the X axis tickmarks.1
xaxisColorThe color of the X axis (and its tickmarks.black
xaxisTickmarksWhether the X axis tickmarks are shown.true
xaxisTickmarksLastLeftWhether the last tickmark on the left is displayed.null
xaxisTickmarksLastRightWhether the last tickmark on the right is displayed.null
xaxisTickmarksLengthThe length of the tickmarks.3
xaxisTickmarksCountThe number of tickmarks that are shown on the X axis.null
xaxisLabelsAn array of the labels to be used on the chart.An empty array
xaxisLabelsFontThe font used to render the labels.null
xaxisLabelsSizeThe size of the labels.null
xaxisLabelsColorThe color of the labels.null
xaxisLabelsBoldWhether the labels are bold or not.null
xaxisLabelsItalicWhether the labels are italic or not.null
xaxisLabelsOffsetxThis allows you finer grained control in the horizontal direction over the X label positioning if you need it.0
xaxisLabelsOffsetyThis allows you finer grained control in the vertical direction over the X label positioning if you need it.0
xaxisLabelsHalignThe horizontal alignment of the labels.center
xaxisLabelsValignThe vertical alignment of the labels.top
xaxisLabelsAngleThe angle of the X axis labels. For example you could set this to 45 to get angled labels.0 (Horizontal)
xaxisLabelsPositionThis 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.section
xaxisTitleThis allows you to specify a title for the X axis.none
xaxisTitleSizeThis allows you to specify a size for the X axis title.null
xaxisTitleFontThis allows you to specify a font for the X axis title.null
xaxisTitleBoldThis controls whether the X axis title is bold or not.null
xaxisTitleItalicThis controls whether the X axis title is italic or not.null
xaxisTitleColorThis controls the color of the X axis title.null
xaxisTitleXBy giving this you can specifically set the X position of the X axis title.null
xaxisTitleYBy giving this you can specifically set the Y position of the X axis title.null
xaxisTitleOffsetxThe X pixel offset that's applied to the title.0
xaxisTitleOffsetyThe Y pixel offset that's applied to the title.0
xaxisTitleHalignThe horizontal alignment of the title.center
xaxisTitleValignThe vertical alignment of the title.top
xaxisTitlePosThis 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.null
xaxis
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

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

PropertyDescriptionDefault
yaxisWhether the Y axis is drawn.true
yaxisPositionSpecifies the Y axis position. Can be left or right.left
yaxisLinewidthThe linewidth of the Y axis.1
yaxisColorThe color of the Y axis.black
yaxisTickmarks.Whether the Y axis tickmarks are drawn.true
yaxisTickmarksLengthThe length of the Y axis tickmarks.3
yaxisTickmarksCountThis allows you to stipulate how many Y axis tickmarks there are.null (related to how many labels there are)
yaxisTickmarksLastTopWhether the top-most tickmark is drawn.null (displayed if the X axis position warrants it)
yaxisTickmarksLastBottomWhether the bottom-most tickmark is drawn.null (displayed if the X axis position warrants it)
yaxisLabelsCountA 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.5
yaxisLabelsSpecificYou 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.null
yaxisLabelsPositionThis controls how the specific labels are positioned on the Y axis. It has no effect on a scale.edge
yaxisLabelsOffsetxThis allows you finer grained control in the horizontal direction over the Y label positioning if you need it.0
yaxisLabelsOffsetyThis allows you finer grained control in the vertical direction over the Y label positioning if you need it.0
yaxisLabelsFontThe font that's used by the Y axis labels.null
yaxisLabelsSizeThe size of the Y axis labels.null
yaxisLabelsColorThe color of the Y axis labels.null
yaxisLabelsBoldWhether the Y axis labels are bold or not.null
yaxisLabelsItalicWhether the Y axis labels are italic or not.null
yaxisLabelsHalignThe horizontal alignment of the Y axis labels.null
yaxisLabelsValignThe vertical alignment of the Y axis labels.null
yaxisTitleThis allows you to specify a title for the Y axis.none
yaxisTitleSizeThis allows you to specify a size for the Y axis title.null
yaxisTitleFontThis allows you to specify a font for the Y axis title.null
yaxisTitleBoldThis controls whether the Y axis title is bold or not.null
yaxisTitleColorThis controls what color the Y axis title is.null
yaxisTitleItalicThis controls whether the Y axis title is italic or not.null
yaxisTitlePosThis is multiplied with the margin to give the position of the Y axis title.0.25
yaxisTitleOffsetxThe pixel offset that's added to the Y axis titles X coordinate.0
yaxisTitleOffsetyThe pixel offset that's added to the Y axis titles Y coordinate.0
yaxisTitleXBy giving this you can specifically set the X position of the Y axis title.null
yaxisTitleYBy giving this you can specifically set the Y position of the Y axis title.null
yaxisTitleHalignThe horizontal alignment of the Y axis title.0
yaxisTitleValignThe vertical alignment of the Y axis title.0
yaxisScaleWhether the Y axis scale is displayed or not.true
yaxisScaleRoundWhether the Y axis scale is rounded up or not.false
yaxisScaleUnitsPreThe units that the Y axis is measured in. This string is displayed before the actual number, allowing you to specify values such as "$50".none
yaxisScaleUnitsPostThe units that the Y axis is measured in. This string is displayed after the actual number, allowing you to specify values such as "50ms".none
yaxisScaleMaxThe optional maximum Y scale value. If not specified then it will be calculated.null (It's calculated)
yaxisScaleMinThe optional minimum Y scale value. If not specified then it will be 0.0
yaxisScaleFormatterTo 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);
null
yaxisScaleRoundWhether to round the scale up. eg A maximum value of 59 results in scale to 100.false
yaxisScaleDecimalsThe number of decimal places to display for the Y scale.0
yaxisScalePointThe character used as the decimal point..
yaxisScaleThousandThe character used as the thousand separator.,
yaxisScaleInvertWhether the Y axis scale is inverted or not.false
yaxis
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: 0

yaxisTitleValign
The vertical alignment of the Y axis title.
Default: 0

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

PropertyDescriptionDefault
colorsAn array of the colors of the bars.An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']
colorsStrokeThe color of the outline of the bars.rgba(0,0,0,0)
colorsSequentialIf true, for regular bar charts, (not stacked or grouped), the colors that you specify will be used in a sequential fashion.false
colors
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

PropertyDescriptionDefault
marginLeftThe left margin of the chart, (the margin is where the labels and title are)).35
marginRightThe right margin of the chart, (the margin is where the labels and title are).35
marginTopThe top margin of the chart, (the margin is where the labels and title are).35
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).35
marginInnerThe horizontal margin (in pixels) of the chart. The horizontal margin is on the inside of the axes.5
marginInnerGroupedIn 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).1
marginLeft
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 the inside of the axes.
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

Other label properties

PropertyDescriptionDefault
textAccessibleA new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:
<div style="margin-left: 50px; display: inline-block">
<canvas id="cvs" width="650" height="250"></canvas>
</div>
true
textAccessibleOverflowThis can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish.visible
textAccessiblePointereventsThis controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).true
textFontThe font used to render the text.Arial, Verdana, sans-serif
textSizeThe size (in points) of the labels.12
textColorThe color of the labels.black
textBoldWhether the font used to render the text is bold or not.false
textItalicWhether the font used to render the text is italic or not.false
labelsAboveIf 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
labelsAboveDecimalsThis stipulates how many decimals are used in the labelsAbove labels.0
labelsAboveUnitsPreThe units to put on the labelsAbove labels. These are positioned before the number.none
labelsAboveUnitsPostThe units to put on the labelsAbove labels. These are positioned after the number.none
labelsAbovePointThe character used as the labelsAbove decimal separator..
labelsAboveThousandThe character used as the labelsAbove thousand separator.,
labelsAboveBackgroundThe background color of the labelsAbove labels.rgba(0,0,0,0)
labelsAboveSizeThe font size of the labelsAbove labels. Useful if you only have a few bars.null
labelsAboveColorThe color of the labelsAbove labels.null
labelsAboveBoldWhether the labelsAbove labels are bold or not.null
labelsAboveItalicWhether the labelsAbove labels are italic or not.null
labelsAboveFontThe font face that is used to render the text.null
labelsAboveOffsetThe distance of the labels above the bars (in pixels).4
labelsAboveAngleYou can use this to angle the text shown above the bars. It can be anything from -90 to 90 (degrees).null
labelsAboveSpecificIf 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
labelsIngraphAn 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
labelsIngraphFontThe font that the ingraph labels are rendered in.null
labelsIngraphSizeThe size of the ingraph labels.null
labelsIngraphColorThe color of the ingraph labels.null
labelsIngraphBoldWhether the ingraph labels are bold or not.null
labelsIngraphItalicWhether the ingraph labels are italic or not.null
textAccessible
A new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:
<div style="margin-left: 50px; display: inline-block">
<canvas id="cvs" width="650" height="250"></canvas>
</div>

Default: true

textAccessibleOverflow
This can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish.
Default: visible

textAccessiblePointerevents
This controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).
Default: true

textFont
The font used to render the text.
Default: Arial, Verdana, sans-serif

textSize
The size (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

labelsAboveOffset
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

Title properties

PropertyDescriptionDefault
titleThe title of the chart, if any.null
titleFontThe font that the title is rendered in. If not specified the textFont setting is used (usually Arial).null
titleSizeThe size of the title. If not specified the size is usually 2pt bigger than the textSize setting.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleColorThe color of the title.null
titleBackgroundThe background color (if any) for the title.null
titleXTo give the exact X coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null
titleYTo give the exact Y coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null
titleHalignThe horizontal alignment of the title.center (can change depending on other options)
titleValignThe vertical alignment of the title.center (can change depending on other options)
title
The title of the chart, if any.
Default: null

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

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

Shadow properties

PropertyDescriptionDefault
shadowWhether a drop shadow is applied.false
shadowColorThe color of the shadow.#aaa
shadowOffsetxThe X offset of the shadow.0
shadowOffsetyThe Y offset of the shadow.0
shadowBlurThe severity of the shadow blurring effect.15
shadow
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

PropertyDescriptionDefault
contextmenuAn array of context menu items. More information about context menus is here.[] (An empty array)
tooltipsA numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.null
tooltipsEffectThe effect used for showing tooltips. Can be either or none.fade
tooltipsEventThis is the event that triggers the tooltips. It can be either click or mousemove.click
tooltipsOverrideIf 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
tooltipsHighlightSet this to false if you don't want your charts to be highlighted.true
tooltipsNohideonclearNot 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
tooltipsHotspotXonlyIf set to true the hotspot for the tooltips will ignore the height of the bar and extend from 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
tooltipsFormattedPointWhen using formatted tooltip strings this is used as the point when using the %{value_formatted} option..
tooltipsFormattedThousandWhen using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.,
tooltipsFormattedDecimalsWhen using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.0
tooltipsFormattedUnitsPreWhen using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedUnitsPostWhen using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedKeyColorsWhen using formatted tooltip strings you can give specific colors for the %{key} option to use.null
tooltipsFormattedKeyLabelsWhen using formatted tooltip strings these are the labels that are displayed.[] (an empty array)
tooltipsCssIf you want to specify some CSS that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object CSS for the tooltips. These are CSS styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt',
    backgroundColor: 'black',
    color: 'white'
}
null
tooltipsCssClassThis is the name of the CSS class the chart uses.RGraph_tooltip
crosshairsIf true, you will get a crosshair centering on the current mouse position.false
crosshairsLinewidthThis controls the linewidth of the crosshairs.1
crosshairsColorThe color of the crosshairs.#333
crosshairsHlineThis determines whether the horizontal crosshair is shown.true
crosshairsVlineThis determines whether the vertical crosshair is shown.true
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotatableColorIf you do not allow the use of the palette, then this will be the only color allowed for annotations.black
annotatableLinewidthThis is the linewidth of the annotations.1
adjustableDefaulting to false, this determines whether your bar chart will be adjustable.false
adjustableOnlyThis 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
contextmenu
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 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

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

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

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

PropertyDescriptionDefault
highlightStyleBy default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument.null
highlightStrokeIf you use tooltips, this controls the color of the highlight stroke.black
highlightFillIf you use tooltips, this controls the color of the highlight fill.rgba(255,255,255,0.5)
variantThis 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
bar
variantThreedOffsetxThis determines the size of the offset in the X direction.10
variantThreedOffsetyThis determines the size of the offset in the Y direction.5
variantThreedXaxisThis allows you to turn on/off the 3D X axis.true
variantThreedYaxisThis allows you to turn on/off the 3D Y axis.true
groupingHow the bars are grouped, and it should be one of: grouped or stacked.grouped
bevelledIf true the bars will be given a 3D bevelled appearance.false
cleartoThis is used in animations and effects as the default color to use when clearing the canvas.null
errorbarsThis should be an array of errorbar information or it can simply be a number instead (see below).false
errorbarsLinewidthThis is the linewidth of the errorbars.1
errorbarsColorThis is the color of the errorbars. You can also override the color in the errorbars array.black
errorbarsCappedThis dictates whether the errorbars have caps on their ends or not.true
errorbarsCappedWidthThis is the width of the caps (in total) on the end of the errorbars.14
combinedEffectSet 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
combinedEffectOptionsThis 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
combinedEffectCallbackA function that runs when this objects effect has completed.null
highlightStyle
By default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument.
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:
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.


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.

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

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.

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