Horizontal Bar chart API reference

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 colour of the background bars, (1 of 2).white
backgroundBarsColor2The colour of the background bars, (2 of 2).white
backgroundGridWhether to show the background grid or not.true
backgroundGridColorThe colour 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 colour 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 colour to the canvas tag.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 colour of the axes.black
axisLinewidthThe linewidth of the axes.1

X axis properties

PropertyDescriptionDefault
xaxisSet this to true if you don't want a X axis.true
xaxisTickmarksUsing this property you can turn off the X tickmarks.false
xaxisTickmarksCountAllows you to stipulate how many X axis tick marks 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 colour 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

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 tick marks 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 colour 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 colour 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

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)
vmarginThe vertical margin that is applied to each individual bar.3

Colour properties

PropertyDescriptionDefault
colorsAn array of the colours of the bars.['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']
colorsStrokeThe colour of the outlines of the bars.black
colorsSequentialIf true, for regular bar charts, the colours that you specify will be used in a sequential fashion.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 colour of the above labels. It defaults to the main textColor optionnull
textFontThe font used to render the text.Arial, Verdana, sans-serif
textColorThe colour 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

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 colour (if any) for the title.null
titleColorThe colour 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

Shadow properties

PropertyDescriptionDefault
shadowWhether a small drop shadow is applied.false
shadowColorThe colour 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

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 onclick or onmousemove.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 colour allowed for annotations.black
annotatableLinewidthThis is the line width of the annotations.1
resizableDefaulting to false, this determines whether your chart will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).false
resizableHandleBackgroundWith this you can specify the background colour for the resize handle. If you're adjusting the position of the handle then you may need this to make the handle stand out more.null
resizableMinwidthThis allows you to set a minimum width that the chart can be resized to.null
resizableMinheightThis allows you to set a minimum height that the chart can be resized to.null
resizableMaxwidthThis allows you to set a maximum width that the chart can be resized to.null
resizableMaxheightThis allows you to set a maximum height that the chart can be resized to.null
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

Event properties

PropertyDescriptionDefault
eventsClickIf you want to add your own onclick function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own onmousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own onmouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own onmouseout function you can do so by assigning it to this property. See here for details.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 colour of the highlight stroke.black
highlightFillIf you use tooltips, this controls the colour of the highlight fill.rgba(255,255,255,0.5)
cleartoThis is used in animations and effects as the default colour 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

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 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,
        vmargin: 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,
            vmargin: 5
        }
    }).grow({frames: 60}, myCallback)
</script>