Horizontal Bar chart API reference

Summary: Documentation about the Horizontal Bar chart including information about all of the options that are available to you. The Horizontal Bar chart can be used when you need a different aesthetic for your page or when you have longer labels (which the Horizontal Bar chart is better suited to).

Example

<script>
    data = [280,45,133];
    
    // To show a stacked or grouped chart each element of the data array should
    // be an array containing the data to be shown.
    // data = [[120,80,60],[30,12,13],[50,50,33]]

    new RGraph.HBar({
        id: 'cvs',
        data: data,
        options: {
            backgroundBarsColor1: 'white',
            backgroundBarsColor2: 'white',
            backgroundGrid: true,
            colors: ['red'],
            yaxisLabels: ['Richard','Gulliver','John']
        }
    }).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).white
backgroundBarsColor2The color of the background bars, (2 of 2).white
backgroundGridWhether to show the background grid or not.true
backgroundGridColorThe color of the background grid.#ddd
backgroundGridLinewidthThe width that the background grid lines are. Decimals (eg 0.5) are permitted.0.5
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
backgroundGridVlinesCountWhen using autofit this allows you to specify how many vertical grid lines you want.20
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
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: white

backgroundBarsColor2
The color of the background bars, (2 of 2).
Default: white

backgroundGrid
Whether to show the background grid or not.
Default: true

backgroundGridColor
The color of the background grid.
Default: #ddd

backgroundGridLinewidth
The width that the background grid lines are. Decimals (eg 0.5) are permitted.
Default: 0.5

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

backgroundGridVlinesCount
When using autofit this allows you to specify how many vertical grid lines you want.
Default: 20

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

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

General axis properties

PropertyDescriptionDefault
axesInstead of the above two properties you can specify this to turn off both the X and Y axes.true
axisColorThe color of the axes.black
axisLinewidthThe linewidth of the axes.1
axes
Instead of the above two properties you can specify this to turn off both the X and Y axes.
Default: true

axisColor
The color of the axes.
Default: black

axisLinewidth
The linewidth of the axes.
Default: 1

X axis properties

PropertyDescriptionDefault
xaxisSet this to true if you don't want an X axis.true
xaxisTickmarksUsing this property you can turn off the X tickmarks.false
xaxisTickmarksCountAllows you to stipulate how many X axis tickmarks are displayed.10
xaxisLabelsA boolean controlling whether the X labels are shown.true
xaxisLabelsCountThis determines how many labels are shown on the scale.5
xaxisLabelsSpecificYou can use this option to give your own X labels (eg ['Low', 'Medium', 'High'].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
xaxisTitleSizeThis allows you to specify a size for the X axis title.null
xaxisTitleFontThis allows to specify a font for the X axis title.null
xaxisTitleBoldThis controls whether the X axis title is bold or not.true
xaxisTitleColorThis controls the color of the X axis title.black
xaxisTitlePosThis is multiplied with the margin to give the position of the X axis title.0.25
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
xaxisScaleUnitsPreThe units that the X axis is measured in. This string is displayed before the actual number, allowing you to specify values such as "$50".none
xaxisScaleUnitsPostThe units that the X axis is measured in. This string is displayed after the actual number, allowing you to specify values such as "50ms".none
xaxisScaleDecimalsThe number of decimal places to display for the X scale.0
xaxisScalePointThe character used as the decimal point..
xaxisScaleThousandThe character used as the thousand separator.,
xaxisScaleRoundWhether to round the maximum scale value up or not. This will produce slightly better scales in some instances.null
xaxisScaleZerostartWhether the scale starts at zero or not.false
xaxisScaleMax(Optional) An optional max figure for the X scale.none (one is calculated)
xaxisScaleMinAn optional minimum figure for the X scale.0
xaxis
Set this to true if you don't want an X axis.
Default: true

xaxisTickmarks
Using this property you can turn off the X tickmarks.
Default: false

xaxisTickmarksCount
Allows you to stipulate how many X axis tickmarks are displayed.
Default: 10

xaxisLabels
A boolean controlling whether the X labels are shown.
Default: true

xaxisLabelsCount
This determines how many labels are shown on the scale.
Default: 5

xaxisLabelsSpecific
You can use this option to give your own X labels (eg ['Low', 'Medium', 'High'].
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

xaxisTitleSize
This allows you to specify a size for the X axis title.
Default: null

xaxisTitleFont
This allows to specify a font for the X axis title.
Default: null

xaxisTitleBold
This controls whether the X axis title is bold or not.
Default: true

xaxisTitleColor
This controls the color of the X axis title.
Default: black

xaxisTitlePos
This is multiplied with the margin to give the position of the X axis title.
Default: 0.25

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

xaxisScaleUnitsPre
The units that the X axis is measured in. This string is displayed before the actual number, allowing you to specify values such as "$50".
Default: none

xaxisScaleUnitsPost
The units that the X axis is measured in. This string is displayed after the actual number, allowing you to specify values such as "50ms".
Default: none

xaxisScaleDecimals
The number of decimal places to display for the X scale.
Default: 0

xaxisScalePoint
The character used as the decimal point.
Default: .

xaxisScaleThousand
The character used as the thousand separator.
Default: ,

xaxisScaleRound
Whether to round the maximum scale value up or not. This will produce slightly better scales in some instances.
Default: null

xaxisScaleZerostart
Whether the scale starts at zero or not.
Default: false

xaxisScaleMax
(Optional) An optional max figure for the X scale.
Default: none (one is calculated)

xaxisScaleMin
An optional minimum figure for the X scale.
Default: 0

Y axis properties

PropertyDescriptionDefault
yaxisSet this to true if you don't want a Y axis.true
yaxisPositionThe position of the Y axis. Works with regular and grouped charts. Can be either center or left.left
yaxisTickmarksUsing this property you can turn off the Y tickmarks.true
yaxisTickmarksCountAllows you to stipulate how many Y axis tickmarks are displayed.[Depends on how many data values given]
yaxisLabelsAn array of the labels to be used on the chart.An empty array
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
yaxisLabelsBoldWhether the labels are bold or not.false
yaxisLabelsColorThe color of the labels.null (same as textColor)
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.true
yaxisTitleColorThis controls what color the Y axis is.black
yaxisTitlePosThis is multiplied with the margin to give the position of the Y axis title.0.5
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
yaxis
Set this to true if you don't want a Y axis.
Default: true

yaxisPosition
The position of the Y axis. Works with regular and grouped charts. Can be either center or left.
Default: left

yaxisTickmarks
Using this property you can turn off the Y tickmarks.
Default: true

yaxisTickmarksCount
Allows you to stipulate how many Y axis tickmarks are displayed.
Default: [Depends on how many data values given]

yaxisLabels
An array of the labels to be used on the chart.
Default: An empty array

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

yaxisLabelsBold
Whether the labels are bold or not.
Default: false

yaxisLabelsColor
The color of the labels.
Default: null (same as textColor)

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

yaxisTitleColor
This controls what color the Y axis is.
Default: black

yaxisTitlePos
This is multiplied with the margin to give the position of the Y axis title.
Default: 0.5

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

Margin properties

PropertyDescriptionDefault
marginLeftThe left margin of the chart, (the margin is where the labels and title are)).75
marginLeftAutoIf set to true this will automatically size the left margin to accommodate your labels).true
marginRightThe right margin of the chart, (the margin is where the labels and title are).25
marginRightAutoIf set to true this will automatically size the right margin to accommodate your labels).false
marginTopThe top margin of the chart, (the margin is where the labels and title are).25
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).25 (in 3D charts if you leave this at 25 it will change to 80)
marginInnerThe vertical margin that is applied to each individual bar.3
marginLeft
The left margin of the chart, (the margin is where the labels and title are)).
Default: 75

marginLeftAuto
If set to true this will automatically size the left margin to accommodate your labels).
Default: true

marginRight
The right margin of the chart, (the margin is where the labels and title are).
Default: 25

marginRightAuto
If set to true this will automatically size the right margin to accommodate your labels).
Default: false

marginTop
The top margin of the chart, (the margin is where the labels and title are).
Default: 25

marginBottom
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 25 (in 3D charts if you leave this at 25 it will change to 80)

marginInner
The vertical margin that is applied to each individual bar.
Default: 3

Color properties

PropertyDescriptionDefault
colorsAn array of the colors of the bars.['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']
colorsStrokeThe color of the outlines of the bars.black
colorsSequentialIf true, for regular bar charts, the colors that you specify will be used in a sequential fashion.false
colors
An array of the colors of the bars.
Default: ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']

colorsStroke
The color of the outlines of the bars.
Default: black

colorsSequential
If true, for regular bar charts, the colors that you specify will be used in a sequential fashion.
Default: false

Other label properties

PropertyDescriptionDefault
labelsAboveThis is a boolean which if true, will cause labels to be shown to the right of the bars. (It's called "above" for API compatibility).false
labelsAboveDecimalsThis is a number which controls how many decimals are shown. It defaults to 0, and since it was added (4th December 2010) you may need to set this, otherwise no decimals will be shown.0
labelsAbovePointThe character used for the decimal point..
labelsAboveThousandThe character used for the thousand separator.,
labelsAboveUnitsPreIf you wish you can specify units that are prepended to the text label (separately to the main xaxisScaleUnitsPre setting)null
labelsAboveUnitsPostIf you wish you can specify units that are appended to the text label (separately to the main xaxisScaleUnitsPost setting)null
labelsAbovePointThe character used for the decimal point.null
labelsAboveThousandThe character used for the thousand separator.null
labelsAboveFontThe font used for the above labels. It defaults to the textFont settingnull
labelsAboveSizeThe size of the above labels. It defaults to the textSize settingnull
labelsAboveBoldWhether the above labels are bold or notnull
labelsAboveItalicWhether the above labels are italic or notnull
labelsAboveColorThe color of the above labels. It defaults to the main textColor optionnull
textFontThe font used to render the text.Arial, Verdana, sans-serif
textColorThe color of the labels.black
textSizeThe size (in points) of the labels.12
textBoldWhether the text is bold or not.false
textItalicWhether the text is italic or not.false
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
labelsAbove
This is a boolean which if true, will cause labels to be shown to the right of the bars. (It's called "above" for API compatibility).
Default: false

labelsAboveDecimals
This is a number which controls how many decimals are shown. It defaults to 0, and since it was added (4th December 2010) you may need to set this, otherwise no decimals will be shown.
Default: 0

labelsAbovePoint
The character used for the decimal point.
Default: .

labelsAboveThousand
The character used for the thousand separator.
Default: ,

labelsAboveUnitsPre
If you wish you can specify units that are prepended to the text label (separately to the main xaxisScaleUnitsPre setting)
Default: null

labelsAboveUnitsPost
If you wish you can specify units that are appended to the text label (separately to the main xaxisScaleUnitsPost setting)
Default: null

labelsAbovePoint
The character used for the decimal point.
Default: null

labelsAboveThousand
The character used for the thousand separator.
Default: null

labelsAboveFont
The font used for the above labels. It defaults to the textFont setting
Default: null

labelsAboveSize
The size of the above labels. It defaults to the textSize setting
Default: null

labelsAboveBold
Whether the above labels are bold or not
Default: null

labelsAboveItalic
Whether the above labels are italic or not
Default: null

labelsAboveColor
The color of the above labels. It defaults to the main textColor option
Default: null

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

textColor
The color of the labels.
Default: black

textSize
The size (in points) of the labels.
Default: 12

textBold
Whether the text is bold or not.
Default: false

textItalic
Whether the text is italic or not.
Default: false

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

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.true
titleItalicWhether the title is italic or not.false
titleBackgroundThe background color (if any) for the title.null
titleColorThe color of the title.black
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
xaxisTitleThis allows you to specify a title for the X axis.none
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: true

titleItalic
Whether the title is italic or not.
Default: false

titleBackground
The background color (if any) for the title.
Default: null

titleColor
The color of the title.
Default: black

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

xaxisTitle
This allows you to specify a title for the X axis.
Default: none

Shadow properties

PropertyDescriptionDefault
shadowWhether a small drop shadow is applied.false
shadowColorThe color of the shadow.#666
shadowOffsetxThe X offset of the shadow.3
shadowOffsetyThe Y offset of the shadow.3
shadowBlurThe severity of the shadow blurring effect.3
shadow
Whether a small drop shadow is applied.
Default: false

shadowColor
The color of the shadow.
Default: #666

shadowOffsetx
The X offset of the shadow.
Default: 3

shadowOffsety
The Y offset of the shadow.
Default: 3

shadowBlur
The severity of the shadow blurring effect.
Default: 3

Key properties

The key properties are documented on the key documentation page.

Interactive features properties

PropertyDescriptionDefault
contextmenuAn array of context menu items. You cannot have context menus AND tooltips, only one or the other. More information about context menus is here.[] (An empty array)
tooltipsAn array of tooltips for the chart.An empty array
tooltipsEventThis is the event that triggers the tooltips. It can be click or mousemove.onclick
tooltipsEffectThe effect used for showing tooltips. Can be either fade or none.fade
tooltipsCssClassThis is the name of the CSS class the chart uses.RGraph_tooltip
tooltipsOverrideIf you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more information on the tooltips documentation page.null
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 tooltips DO NOT get hidden.false
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
adjustableBy setting this you can allow your chart to be adjustable. There's a documentation page about adjusting the Horizontal Bar chart here.false
adjustableOnlyThis should be an array of values that determine whether a Bar is adjustable or not. A truthy value for when it is, a falsey value for when it's not.null
contextmenu
An array of context menu items. You cannot have context menus AND tooltips, only one or the other. More information about context menus is here.
Default: [] (An empty array)

tooltips
An array of tooltips for the chart.
Default: An empty array

tooltipsEvent
This is the event that triggers the tooltips. It can be click or mousemove.
Default: onclick

tooltipsEffect
The effect used for showing tooltips. Can be either fade or none.
Default: fade

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

tooltipsOverride
If you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more information on the tooltips documentation page.
Default: null

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 tooltips DO NOT get hidden.
Default: false

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
By setting this you can allow your chart to be adjustable. There's a documentation page about adjusting the Horizontal Bar chart here.
Default: false

adjustableOnly
This should be an array of values that determine whether a Bar is adjustable or not. A truthy value for when it is, a falsey value for when it's not.
Default: null

Event properties

PropertyDescriptionDefault
eventsClickIf you want to add your own click function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own mousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own mouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own mouseout function you can do so by assigning it to this property. See here for details.null
eventsClick
If you want to add your own click function you can do so by assigning it to this property. See here for details.
Default: null

eventsMousemove
If you want to add your own mousemove function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseover
If you want to add your own mouseover function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseout
If you want to add your own mouseout function you can do so by assigning it to this property. See here for details.
Default: null

Miscellaneous properties

PropertyDescriptionDefault
groupingHow the bars are grouped, and it should be one of: grouped or stacked.grouped
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)
cleartoThis is used in animations and effects as the default color to use when the canvas.null
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
variantThis stipulates whether you want a regular Horizontal Bar chart or a 3D chart. Possible values are:
  • hbar
  • 3d
hbar
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
grouping
How the bars are grouped, and it should be one of: grouped or stacked.
Default: grouped

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)

clearto
This is used in animations and effects as the default color to use when the canvas.
Default: 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

variant
This stipulates whether you want a regular Horizontal Bar chart or a 3D chart. Possible values are:
Default: hbar

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

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 easier for you to get hold of which bar has been clicked on, or hovered over. It returns an array of:

The shape also includes textual indexes like this: shape['object'] And they are:

An example usage is:
<canvas id="cvs" width="600" height="250">[No canvas support]</canvas>

<script src="RGraph.common.core.js"></script>
<script src="RGraph.hbar.js"></script>

<script>
    myGraph = new RGraph.HBar({
        id: 'cvs',
        data: [1.2, 1.3, 1.4, 1.5,6,1.9,2,2.1,2.5],
        options: {
            yaxisLabels: ['John', 'Barry', 'Rich', 'Craig', 'Tom', 'Frank', 'Helen', 'Joyce', 'Fred']
        }
    }).draw();
    
    myGraph.canvas.onclick = function (e)
    {
        RGraph.redraw();
    
        var ca  = e.target;
        var co  = ca.getContext('2d');
        var obj = ca.__object__;
        var bar = obj.getShape(e);
        
        if (bar) {

            var top    = bar[0];
            var left   = bar[1];
            var width  = bar[2];
            var height = bar[3];
            var idx    = bar[4];
            
            co.beginPath();
                co.strokeStyle = 'black';
                co.fillStyle = 'rgba(255,255,255,0.5)';
                co.strokeRect(top, left, width, height);
                co.fillRect(top, left, width, height);
            co.stroke();
            co.fill();
        }
    }
</script>
obj.getShapeByY(event[, object])

This method is similar to the getShape() method described above but when comparing the mouse position to the bar coordinates this method only takes into account the mouse Y position. This method is used when the Horizontal Bar chart is made adjustable.

The second argument is optional and allows you to specify the (RGraph) object to be used in the checks.

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 necessarily in an event listener). It returns null if the mouse or coordinates are in the margin areas. An example:

myChart.canvas.onclick = function (e)
{
    var obj   = e.target.__object__;
    var value = obj.getValue(e);
    
    // ...
}
obj.getXCoord(value)

This method can be used to get an appropriate X coordinate for a value when you're doing custom drawing on the chart. It returns 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 event code here
});

The function is useful if you use method chaining when creating your charts:

var obj = new RGraph.HBar({
    id: 'cvs',
    data: [5,8,6,4,3,5],
    options: {
        marginLeft: 55,
        marginInner: 5,
        yaxisLabels: ['Hoolio','Jill','Pete','Kevin','Lucy','John']
    }
}).on('mousemove', function (e, shape)
{
    // Handle mousemove event
})
.on('click', function (e, shape)
{
    // Handle the click event
})
.draw()
The exec option and method

The exec function is documented here.

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>
    /**
    * Optional callback function that's called when the effect is complete
    */
    function myCallback (obj)
    {
        // ...
    }

    var obj = new RGraph.HBar({
        id: 'cvs',
        data: [4,8,6,3,5,2,4],
        options: {
            marginLeft: 35,
            marginInner: 5
        }
    }).grow({frames: 60}, myCallback)
</script>