Horizontal Bar chart

Example

View example on CodePen
<script>
    labels = ['Richard','Gulliver','John'];
    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: {
            marginInner: 15,
            backgroundBarsColor1: 'white',
            backgroundBarsColor2: 'white',
            backgroundGrid: true,
            backgroundGridHlines: false,
            backgroundGridBorder: false,
            colors: ['red','green','blue'],
            xaxis: false,
            yaxisLabels: labels,
            yaxisTickmarksCount: 0,
            yaxisLinewidth: 3,
            tooltips: '<b>Results:</b><br />%{key}',
            tooltipsFormattedKeyLabels: ['Sales','Sales','Sales'],
            tooltipsCss: {
                fontSize: '16pt',
                textAlign: 'left'
            },
            corners: 'round',
            cornersRoundRadius: 50
        }
    }).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 gridlines 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 gridlines 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

X-axis properties

PropertyDescriptionDefault
xaxisSet this to true if you don't want an x-axis.true
xaxisPositionWhether the x-axis is shown at the top or at the bottom of the chart - possible values are top and bottom.bottom
xaxisLinewidthThe linewidth of the x-axis.1
xaxisColorThe color of the x-axis.black
xaxisTickmarksUsing this property you can turn off the X tickmarks.true
xaxisTickmarksCountThis allows you to stipulate how many x-axis tickmarks are displayed.null
xaxisTickmarksLengthUse this to stipulate the length of the x-axis tickmarks.3
xaxisTickmarksLastLeftWhether the last tickmark on the left-hand-side is shown.null
xaxisTickmarksLastRightWhether the last tickmark on the right-hand-side is shown.null
xaxisLabelsIf you prefer to use labels on the x-axis instead of a scale then this should be an array of those labels. You can use the xaxisLabelsPosition option to control their positioning.null
xaxisLabelsCountThis determines how many labels are shown on the scale if it's being used instead of textual labels.5
xaxisLabelsAngleIf you want your labels to be at an angle then this is the property to specify it (in degrees). If you use this then you may also need to use the xaxisLabelsOffsety property. 0
xaxisLabelsPositionIf you use labels instead of a scale this controls the positioning of them.edge
xaxisLabelsSpecificAlignThis determines the alignment of the specific labels. You probably won't need this.left
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
xaxisLabelsHalignIf desired you can specify the horizontal alignment with this.null
xaxisLabelsValignIf desired you can specify the vertical alignment with this.null
xaxisLabelsFontThe font used for the x-axis labels. It defaults to the textFont settingnull
xaxisLabelsSizeThe size of the x-axis labels. It defaults to the textSize settingnull
xaxisLabelsBoldWhether the x-axis labels are bold or notnull
xaxisLabelsItalicWhether the x-axis labels are italic or notnull
xaxisLabelsColorThe color of the x-axis labels. It defaults to the main textColor optionnull
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
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
xaxisTitleOffsetxUse this property to adjust the X position of the title. 0
xaxisTitleOffsetyUse this property to adjust the Y position of the title. 0
xaxisTitleHalignUse this property to specify the horizontal alignment of the title. 0
xaxisTitleValignUse this property to specify the vertical alignment of the title. 0
xaxisScaleWhether the scale should be drawn or not.true
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 that's used as the decimal point..
xaxisScaleThousandThe character that's 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
xaxisScaleMax(Optional) An optional max figure for the X scale.none (one is calculated)
xaxisScaleMinAn optional minimum figure for the X scale. 0
xaxisScaleFormatterThis can be a function, which is passed the object and the number and should return a formatted number (formatted as you wish).
function myFormatter(opt)
{
    var obj = opt.object,
        num = opt.number;

    return num + 'F'; // An example of formatting
}
null
xaxis
Set this to true if you don't want an x-axis.
Default: true

xaxisPosition
Whether the x-axis is shown at the top or at the bottom of the chart - possible values are top and bottom.
Default: bottom

xaxisLinewidth
The linewidth of the x-axis.
Default: 1

xaxisColor
The color of the x-axis.
Default: black

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

xaxisTickmarksCount
This allows you to stipulate how many x-axis tickmarks are displayed.
Default: null

xaxisTickmarksLength
Use this to stipulate the length of the x-axis tickmarks.
Default: 3

xaxisTickmarksLastLeft
Whether the last tickmark on the left-hand-side is shown.
Default: null

xaxisTickmarksLastRight
Whether the last tickmark on the right-hand-side is shown.
Default: null

xaxisLabels
If you prefer to use labels on the x-axis instead of a scale then this should be an array of those labels. You can use the xaxisLabelsPosition option to control their positioning.
Default: null

xaxisLabelsCount
This determines how many labels are shown on the scale if it's being used instead of textual labels.
Default: 5

xaxisLabelsAngle
If you want your labels to be at an angle then this is the property to specify it (in degrees). If you use this then you may also need to use the xaxisLabelsOffsety property.
Default: 0

xaxisLabelsPosition
If you use labels instead of a scale this controls the positioning of them.
Default: edge

xaxisLabelsSpecificAlign
This determines the alignment of the specific labels. You probably won't need this.
Default: left

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
If desired you can specify the horizontal alignment with this.
Default: null

xaxisLabelsValign
If desired you can specify the vertical alignment with this.
Default: null

xaxisLabelsFont
The font used for the x-axis labels. It defaults to the textFont setting
Default: null

xaxisLabelsSize
The size of the x-axis labels. It defaults to the textSize setting
Default: null

xaxisLabelsBold
Whether the x-axis labels are bold or not
Default: null

xaxisLabelsItalic
Whether the x-axis labels are italic or not
Default: null

xaxisLabelsColor
The color of the x-axis labels. It defaults to the main textColor option
Default: null

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

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

xaxisTitleOffsetx
Use this property to adjust the X position of the title.
Default: 0

xaxisTitleOffsety
Use this property to adjust the Y position of the title.
Default: 0

xaxisTitleHalign
Use this property to specify the horizontal alignment of the title.
Default: 0

xaxisTitleValign
Use this property to specify the vertical alignment of the title.
Default: 0

xaxisScale
Whether the scale should be drawn or not.
Default: true

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 that's used as the decimal point.
Default: .

xaxisScaleThousand
The character that's 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

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

xaxisScaleFormatter
This can be a function, which is passed the object and the number and should return a formatted number (formatted as you wish).
function myFormatter(opt)
{
    var obj = opt.object,
        num = opt.number;

    return num + 'F'; // An example of formatting
}

Default: null

Y-axis properties

PropertyDescriptionDefault
yaxisWhether the y-axis is drawn.true
yaxisLinewidthThe linewidth of the y-axis.1
yaxisColorThe color of the y-axis.black
yaxisPositionSpecifies the y-axis position. Can be left or right.left
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)
yaxisLabelsGive this property an array of your labels that want to appear on your chart. You can also give this option a string if you prefer and use formatted labelsnull
yaxisLabelsPositionThis controls how the specific labels are positioned on the y-axis. Typically you wouldn't use for a Horizontal Bar chart.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
yaxisLabelsFormattedDecimalsWhen using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. 0
yaxisLabelsFormattedPointWhen using formatted labels this is the decimal point character that's used with the %{value_formatted} macro..
yaxisLabelsFormattedThousandWhen using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.,
yaxisLabelsFormattedUnitsPreWhen using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.(an empty string)
yaxisLabelsFormattedUnitsPostWhen using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.(an empty string)
yaxisLabelsClassThis property allows you to add your own css class to the y-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.[none]
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
yaxisTitleAccessibleWith this property you can control whether the y-axis title is accessible or not.true
yaxis
Whether the y-axis is drawn.
Default: true

yaxisLinewidth
The linewidth of the y-axis.
Default: 1

yaxisColor
The color of the y-axis.
Default: black

yaxisPosition
Specifies the y-axis position. Can be left or right.
Default: left

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)

yaxisLabels
Give this property an array of your labels that want to appear on your chart. You can also give this option a string if you prefer and use formatted labels
Default: null

yaxisLabelsPosition
This controls how the specific labels are positioned on the y-axis. Typically you wouldn't use for a Horizontal Bar chart.
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

yaxisLabelsFormattedDecimals
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default: 0

yaxisLabelsFormattedPoint
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .

yaxisLabelsFormattedThousand
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,

yaxisLabelsFormattedUnitsPre
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)

yaxisLabelsFormattedUnitsPost
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)

yaxisLabelsClass
This property allows you to add your own css class to the y-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]

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

yaxisTitleAccessible
With this property you can control whether the y-axis title is accessible or not.
Default: true

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).35
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).35
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).35 (in 3D charts if you leave this at 25 it will change to 80)
marginInnerThe vertical margin that is applied to each 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: 35

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

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

marginInner
The vertical margin that is applied to each 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 sequentially.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 sequentially.
Default: false

Labels and text 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 that 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 that's used for the decimal point..
labelsAboveThousandThe character that's 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
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
labelsAboveOffsetxThis allows you finer-grained control in the horizontal direction over the text positioning if you need it. 0
labelsAboveOffsetyThis allows you finer-grained control in the vertical direction over the text positioning if you need it. 0
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>
false
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
labelsInBarWhether to show the labelsInbar style labels.false
labelsInBarPointThe decimal point character to use for the labelsInBar labels.null
labelsInBarThousandThe thousand separator character to use for the labelsInBar labels.null
labelsInBarDecimalsThe number of decimals to use for the labelsInBar labels. 0
labelsInBarPreA string to prepend to the labelsInBar labels.null
labelsInBarPostA string to append to the labelsInBar labels.null
labelsInBarOffsetxThe horizontal offset of the labelsInBar labels. 0
labelsInBarOffsetyThe vertical offset of the labelsInBar labels. 0
labelsInbarHalignThe horizontal alignment of the labelsInbar labels.center
labelsInbarValignThe vertical alignment of the labelsInbar labels.center
labelsInBarFontThe font of the labelsInBar labels.null
labelsInBarSizeThe size of the labelsInBar labels.null
labelsInBarBoldWhether the labelsInBar labels are bold or not.null
labelsInBarItalicWhether the labelsInBar labels are italic or not.null
labelsInBarColorThe color of the labelsInBar labels.null
labelsInBarBackgroundThe background color of the labelsInBar labels.null
labelsInBarSpecificThis property allows you to make the labelsInBar labels specific strings instead of numbers.null
labelsInBarFormatterA function that handles ALL of the formatting of the number. The function is passed a single object as an argument which contains these keys: number object point thousand unitspre unitspost formatternull
textThis allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.null
labelsAbove
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 that 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 that's used for the decimal point.
Default: .

labelsAboveThousand
The character that's 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

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

labelsAboveOffsetx
This allows you finer-grained control in the horizontal direction over the text positioning if you need it.
Default: 0

labelsAboveOffsety
This allows you finer-grained control in the vertical direction over the text positioning if you need it.
Default: 0

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

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

labelsInBar
Whether to show the labelsInbar style labels.
Default: false

labelsInBarPoint
The decimal point character to use for the labelsInBar labels.
Default: null

labelsInBarThousand
The thousand separator character to use for the labelsInBar labels.
Default: null

labelsInBarDecimals
The number of decimals to use for the labelsInBar labels.
Default: 0

labelsInBarPre
A string to prepend to the labelsInBar labels.
Default: null

labelsInBarPost
A string to append to the labelsInBar labels.
Default: null

labelsInBarOffsetx
The horizontal offset of the labelsInBar labels.
Default: 0

labelsInBarOffsety
The vertical offset of the labelsInBar labels.
Default: 0

labelsInbarHalign
The horizontal alignment of the labelsInbar labels.
Default: center

labelsInbarValign
The vertical alignment of the labelsInbar labels.
Default: center

labelsInBarFont
The font of the labelsInBar labels.
Default: null

labelsInBarSize
The size of the labelsInBar labels.
Default: null

labelsInBarBold
Whether the labelsInBar labels are bold or not.
Default: null

labelsInBarItalic
Whether the labelsInBar labels are italic or not.
Default: null

labelsInBarColor
The color of the labelsInBar labels.
Default: null

labelsInBarBackground
The background color of the labelsInBar labels.
Default: null

labelsInBarSpecific
This property allows you to make the labelsInBar labels specific strings instead of numbers.
Default: null

labelsInBarFormatter
A function that handles ALL of the formatting of the number. The function is passed a single object as an argument which contains these keys: number object point thousand unitspre unitspost formatter
Default: null

text
This allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.
Default: null

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 4pt 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
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)
titleOffsetxYou 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). 0
titleOffsetyYou 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). 0
titleSubtitleThe 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.null
titleSubtitleSizeThe size of the font used to render the subtitle.null
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleBoldWhether the subtitle is bold or not.null
titleSubtitleItalicWhether the subtitle is italic or not.null
titleSubtitleOffsetxUse this property to adjust the horizontal position of the subtitle. 0
titleSubtitleOffsetyUse this property to adjust the vertical position of the subtitle. 0
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 4pt 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

titleX
To give the exact X coordinate for the title - use this. This can also be a string like this: "-5" - in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.
Default: null

titleY
To give the exact Y coordinate for the title - use this. This can also be a string like this: "-5" - in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.
Default: null

titleHalign
The horizontal alignment of the title.
Default: center (can change depending on other options)

titleValign
The vertical alignment of the title.
Default: center (can change depending on other options)

titleOffsetx
You can use this property to adjust the positioning of the title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left).
Default: 0

titleOffsety
You can use this property to adjust the positioning of the title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards).
Default: 0

titleSubtitle
The subtitle of the chart. If a subtitle is specified the title is moved up to accommodate it. As such you might need to give a larger marginTop value.
Default: null

titleSubtitleSize
The size of the font used to render the subtitle.
Default: null

titleSubtitleColor
The color of the subtitle.
Default: #aaa

titleSubtitleFont
The font used to render the subtitle.
Default: null

titleSubtitleBold
Whether the subtitle is bold or not.
Default: null

titleSubtitleItalic
Whether the subtitle is italic or not.
Default: null

titleSubtitleOffsetx
Use this property to adjust the horizontal position of the subtitle.
Default: 0

titleSubtitleOffsety
Use this property to adjust the vertical position of the subtitle.
Default: 0

Shadow properties

PropertyDescriptionDefault
shadowWhether a small drop shadow is applied.false
shadowColorThe color of the shadow.#666
shadowOffsetxThe horizontal offset of the shadow.3
shadowOffsetyThe vertical 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 horizontal offset of the shadow.
Default: 3

shadowOffsety
The vertical 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.

Line properties

PropertyDescriptionDefault
lineEnabling this will draw a line across the tops of the bars on the chart. So by setting this to true and setting the color of the bars to transparent (ie colors: ['transparent']) you can get a vertical line chart. There are examples of this in the download archive called demos/hbar-vertical-line.html and demos/hbar-vertical-line-multiple.html The latter uses multiple Horizontal Bar chart objects to show multiple lines (one per object) drawn on the same canvas tag.false
lineColorWith this property you can specify the color of the line. Note that it should be a string (because you can only have one line per Horizontal Bar object).black
lineLinejoinThis property controls how the joins of lines are drawn - it can be miter, bevel or round. For a visualisation of these options you can refer to the lineJoin reference page.round
lineLinecapThis property controls how the ends of lines are drawn - it can be butt, square or round. For a visualisation of these options you can refer to the lineCap reference page.round
lineLinewidthThe linewidth of the line on the chart.1
lineShadowWhether a shadow is cast by the line or not.true
lineShadowColorThe color of the shadow. Most (if not all) color definitions can be used here - learn about the different color definitions on this page.#666
lineShadowBlurThe magnitude of the blurring effect of the shadow. If you're having issues with animation frame rates with canvas-based animations on slower devices - try reducing, or turning off completely, the blur.2
lineShadowOffsetxThe horizontal offset in pixels of the shadow.2
lineShadowOffsetyThe vertical offset in pixels of the shadow.2
lineSplineWhether or not the line is drawn as a spline (curvy).false
lineTickmarksStyleThis determines the style of the Line chart tooltips. It can be one of: circle endcircle filledcircle filledendcircle square endsquare filledsquare filledendsquarenull
lineTickmarksSizeThis determines the size of the tickmarks5
lineTickmarksDrawNullIf you have null values shown on your chart this will allow you to show tickmarks for them. The tickmarks will be drawn at zerofalse
lineTickmarksDrawNonNullIf you have a point, with null values on both sides, there wouldn't normally be a tickmark drawn either for the null values or the valid point in the middle. This is because you need two consecutive non-null values for a line to be drawn. With this setting though you can tell RGraph to draw the tickmark for the non-null point so that you can at least see it on the chart (despite there being no connecting line).false
line
Enabling this will draw a line across the tops of the bars on the chart. So by setting this to true and setting the color of the bars to transparent (ie colors: ['transparent']) you can get a vertical line chart. There are examples of this in the download archive called demos/hbar-vertical-line.html and demos/hbar-vertical-line-multiple.html The latter uses multiple Horizontal Bar chart objects to show multiple lines (one per object) drawn on the same canvas tag.
Default: false

lineColor
With this property you can specify the color of the line. Note that it should be a string (because you can only have one line per Horizontal Bar object).
Default: black

lineLinejoin
This property controls how the joins of lines are drawn - it can be miter, bevel or round. For a visualisation of these options you can refer to the lineJoin reference page.
Default: round

lineLinecap
This property controls how the ends of lines are drawn - it can be butt, square or round. For a visualisation of these options you can refer to the lineCap reference page.
Default: round

lineLinewidth
The linewidth of the line on the chart.
Default: 1

lineShadow
Whether a shadow is cast by the line or not.
Default: true

lineShadowColor
The color of the shadow. Most (if not all) color definitions can be used here - learn about the different color definitions on this page.
Default: #666

lineShadowBlur
The magnitude of the blurring effect of the shadow. If you're having issues with animation frame rates with canvas-based animations on slower devices - try reducing, or turning off completely, the blur.
Default: 2

lineShadowOffsetx
The horizontal offset in pixels of the shadow.
Default: 2

lineShadowOffsety
The vertical offset in pixels of the shadow.
Default: 2

lineSpline
Whether or not the line is drawn as a spline (curvy).
Default: false

lineTickmarksStyle
This determines the style of the Line chart tooltips. It can be one of: circle endcircle filledcircle filledendcircle square endsquare filledsquare filledendsquare
Default: null

lineTickmarksSize
This determines the size of the tickmarks
Default: 5

lineTickmarksDrawNull
If you have null values shown on your chart this will allow you to show tickmarks for them. The tickmarks will be drawn at zero
Default: false

lineTickmarksDrawNonNull
If you have a point, with null values on both sides, there wouldn't normally be a tickmark drawn either for the null values or the valid point in the middle. This is because you need two consecutive non-null values for a line to be drawn. With this setting though you can tell RGraph to draw the tickmark for the non-null point so that you can at least see it on the chart (despite there being no connecting line).
Default: false

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. Possible values are slide fade or none.slide
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
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
tooltipsFormattedKeyColorsShapeThis is the shape that's used in the tooltip key. It can be square or circlesquare
tooltipsFormattedKeyColorsCss By using this property you can add css values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of css properties like this:
tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}
null
tooltipsFormattedKeyLabelsWhen using formatted tooltip strings these are the labels that are displayed.[] (an empty array)
tooltipsFormattedListTypeWith this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.ul
tooltipsFormattedListItemsThis should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]
You can use css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}
null
tooltipsFormattedTableHeadersWhen showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.null
tooltipsFormattedTableDataThis is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example, copy the code from it and then modify it suit. You'll create fewer bugs this way.null)
tooltipsPointerBy default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.true
tooltipsPointerCssIf you want any css values applied to the tooltips pointer (a css border, for example) then specify an object containing those values to this property. For example:
tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}
null
tooltipsPointerOffsetxThis allows you to adjust the vertical position of the tooltips pointer. 0
tooltipsPointerOffsetyThis 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). 0
tooltipsPositionStaticThe new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.true
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'
}
null
tooltipsCssClassThis is the name of the css class the chart uses.RGraph_tooltip
tooltipsOffsetxThis property allows you to shift the tooltips left or right. 0
tooltipsOffsetyThis property allows you to shift the tooltips up or down. 0
tooltipsHotspotYonlyIf set to true the hotspot for the tooltips will ignore the width of the bar and extend from the left margin across to the right margin. This can be useful when you have zero value bars but still want to see the tooltips.false
tooltipsHotspotIgnoreThis 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)
null
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 (and other chart types too) 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. Possible values are slide fade or none.
Default: slide

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

tooltipsFormattedPoint
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .

tooltipsFormattedThousand
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,

tooltipsFormattedDecimals
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default: 0

tooltipsFormattedUnitsPre
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedUnitsPost
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedKeyColors
When using formatted tooltip strings you can give specific colors for the %{key} option to use.
Default: null

tooltipsFormattedKeyColorsShape
This is the shape that's used in the tooltip key. It can be square or circle
Default: square

tooltipsFormattedKeyColorsCss
By using this property you can add css values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of css properties like this:
tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}

Default: null

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

tooltipsFormattedListType
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.
Default: ul

tooltipsFormattedListItems
This should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]
You can use css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}

Default: null

tooltipsFormattedTableHeaders
When showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.
Default: null

tooltipsFormattedTableData
This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)

tooltipsPointer
By default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.
Default: true

tooltipsPointerCss
If you want any css values applied to the tooltips pointer (a css border, for example) then specify an object containing those values to this property. For example:
tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

Default: null

tooltipsPointerOffsetx
This allows you to adjust the vertical position of the tooltips pointer.
Default: 0

tooltipsPointerOffsety
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

tooltipsPositionStatic
The new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.
Default: true

tooltipsCss
If you want to specify some css that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object css for the tooltips. These are css styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}

Default: null

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

tooltipsOffsetx
This property allows you to shift the tooltips left or right.
Default: 0

tooltipsOffsety
This property allows you to shift the tooltips up or down.
Default: 0

tooltipsHotspotYonly
If set to true the hotspot for the tooltips will ignore the width of the bar and extend from the left margin across to the right margin. This can be useful when you have zero value bars but still want to see the tooltips.
Default: false

tooltipsHotspotIgnore
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:
Default: null

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 (and other chart types too) 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

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 clearing 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. As of version 5.23 you can also set this to invert as well. If you do this on a dark background you may find that you need to change the highlightFill color setting as well.null
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
cornersThis can be (the default) square 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 hbar-rounded.html.square
cornersRoundRadiusThis is the extent of the rounded corners. Bigger values means rounder corners.10
cornersRoundTopWhether the top corner of the bar is rounded or not.true
cornersRoundBottomWhether the bottom corner of the bar is rounded or not.true
cornersRoundTopRadiusIf you want to specify the corner radius values separately - you can use this property to give the top corner radius.null
cornersRoundBottomRadiusIf you want to specify the corner radius values separately - you can use this property to give the bottom corner radius.null
responsiveThis 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.null
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 clearing 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. 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

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

corners
This can be (the default) square 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 hbar-rounded.html.
Default: square

cornersRoundRadius
This is the extent of the rounded corners. Bigger values means rounder corners.
Default: 10

cornersRoundTop
Whether the top corner of the bar is rounded or not.
Default: true

cornersRoundBottom
Whether the bottom corner of the bar is rounded or not.
Default: true

cornersRoundTopRadius
If you want to specify the corner radius values separately - you can use this property to give the top corner radius.
Default: null

cornersRoundBottomRadius
If you want to specify the corner radius values separately - you can use this property to give the bottom corner radius.
Default: null

responsive
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 Horizontal 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 Horizontal Bar chart, this is always zero. Note that in a stacked chart the counting starts from the top-most segment (which is zero).
sequentialIndex The zero-indexed sequential index of the bar. For example, in a grouped chart where there are three groups of three bars 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.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 to be 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 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:

obj.on('draw', function (obj)
{
    // Put your event code here
});

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

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)
{
    // Put your mousemove event code here

}).on('click', function (e, shape)
{
    // Put your click event code here
})
.draw()

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.

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

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