Horizontal bar charts documentation

 

Example

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

    // Create the HBar object giving it the canvas ID and the data just defined.
    var hbar = new RGraph.HBar({
        id: 'cvs',
        data: data,
        options: {
            backgroundBarcolor1: 'white',
            backgroundBarcolor2: 'white',
            backgroundGrid: true,
            colors: ['red'],
            labels: ['Richard','Gulliver','John']
        }
    }).draw();
</script>

The example file is here.

 

Properties

You can use these properties to control how the chart apears. You can set them by including them in the options section of the configuration as above.

Layout style:     
  

Margins

PropertyDescriptionDefault
gutterLeftThe left gutter of the chart, (the gutter is where the labels and title are)).75
gutterLeftAutosizeIf set to true this will automatically size the left gutter to accomodate your labels).false
gutterRightThe right gutter of the chart, (the gutter is where the labels and title are).25
gutterTopThe top gutter of the chart, (the gutter is where the labels and title are).25
gutterBottomThe bottom gutter of the chart, (the gutter 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

Colors

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

Background

PropertyDescriptionDefault
backgroundBarcolor1The color of the background bars, (1 of 2).white
backgroundBarcolor2The 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
backgroundGridWidthThe 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
backgroundGridAutofitInstead of specifying a pixel width/height for the background grid, you can use autofit and specify how many horizontal and vertical lines you want.true
backgroundGridAutofitNumhlinesWhen using autofit this allows you to specify how many horizontal grid lines you want.14
backgroundGridAutofitNumvlinesWhen 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 gutters. If you want that then you can simply apply a CSS background color to the canvas tag.null

Labels and text

PropertyDescriptionDefault
xlabelsA boolean controlling whether the X labels are shown.true
xlabelsCountThis determines how many labels are shown on the scale.5
xlabelsSpecificYou can use this option to give your own X labels (eg ['Low', 'Medium', 'High'].null
xlabelsOffsetxThis allows you finer grained control in the horizontal direction over the X label positioning if you need it.0
xlabelsOffsetyThis allows you finer grained control in the vertical direction over the X label positioning if you need it.0
labelsAn array of the labels to be used on the chart.An empty array
labelsOffsetxThis allows you finer grained control in the horizontal direction over the Y label positioning if you need it.0
labelsOffsetyThis allows you finer grained control in the vertical direction over the Y label positioning if you need it.0
labelsBoldWhether the labels are bold or notfalse
labelsColorThe color of the labelsnull (same as textColor)
labelsOffsetxThis moves the labels in the X direction0
labelsOffsetyThis moves the labels in the Y direction0
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
labelsAboveSpecificThis is an array of specific above labels that will be shown in place of the relevant value.null
labelsAboveColorThe color of the above labels. It defaults to the main textColor optionnull
labelsAboveUnitsPreIf you wish you can specify units that are prepended to the text label (seperately to to the main unitsPre ssetting)null
labelsAboveUnitsPostIf you wish you can specify units that are appended to the text label (seperately to to the main unitsPost ssetting)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 notfalse
labelsAboveItalicWhether the above labels are italic or notfalse
textFontThe font used to render the text.Arial
textColorThe color of the labels.black
textSizeThe size (in points) of the labels.10
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 gutters 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

Titles

PropertyDescriptionDefault
titleThe title of the chart, if any.null
titleFontThe font that the title is rendered in. If not specified the text.font setting is used (usually Arial)null
titleSizeThe size of the title. If not specified the size is usually 2pt bigger than the text.size 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 thisnull
titleYTo give the exact Y coordinate for the title - use thisnull
titleXaxisThis allows to specify a title for the X axis.none
titleXaxisSizeThis allows you to specify a size for the X axis title.null
titleXaxisFontThis allows to specify a font for the X axis title.null
titleXaxisBoldThis controls whether the X axis title is bold or not.true
titleXaxisColorThis controls the color of the X axis title.black
titleXaxisPosThis is multiplied with the gutter to give the position of the X axis title.0.25
titleXaxisXBy giving this you can specifically set the X position of the X axis titlenull
titleXaxisYBy giving this you can specifically set the Y position of the X axis titlenull
titleYaxisThis allows to specify a title for the Y axis.none
titleYaxisSizeThis allows you to specify a size for the Y axis title.null
titleYaxisFontThis allows to specify a font for the Y axis title.null
titleYaxisBoldThis controls whether the Y axis title is bold or not.true
titleYaxisColorThis controls what color the Y axis is.black
titleYaxisPosThis is multiplied with the gutter to give the position of the Y axis title.0.5
titleYaxisXBy giving this you can specifically set the X position of the Y axis titlenull
titleYaxisYBy giving this you can specifically set the Y position of the Y axis titlenull

Scale and axes

PropertyDescriptionDefault
scaleDecimalsThe number of decimal places to display for the X scale.0
scalePointThe character used as the decimal point..
scaleThousandThe character used as the thousand separator,
scaleRoundWhether to round the maximum scale value up or not. This will produce slightly better scales in some instances.null
scaleZerostartfalse
xmax(Optional) An optional max figure for the X scale.none (one is calculated)
xminAn optional minimum figure for the X scale.0
yaxisposThe position of the Y axis. Works with regular and grouped charts. Can be either center or left.left
axisColorThe color of the axes.black
axisLinewidthThe linewidth of the axes.1
noxaxisSet this to true if you don't want a X axis.false
noaxesInstead of the above two properties you can specify this to turn off both the X and Y axes.false
noyaxisSet this to true if you don't want a Y axis.false
unitsPreThe 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
unitsPostThe 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
unitsIngraphIf your units are long, setting this stipulates them to be used for ingraph labels only.false
noxtickmarksUsing this property you can turn off the X tickmarks.false
noytickmarksUsing this property you can turn off the Y tickmarks.false
numxticksAllows you to stipulate how many X axis tickmarks are displayed10
numyticksAllows you to stipulate how many Y axis tickmarks are displayed[Depends on how many data values given]

Miscellaneous

PropertyDescriptionDefault
groupingHow the bars are grouped, and it should be one of: grouped or stackedgrouped
strokestyleThe color of the outlines of the bars.black
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 color to use when the canvas.null

Shadow

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

Key

The key properties are documented on the key documentation page.

Interactive features

PropertyDescriptionDefault
contextmenuAn array of context menu items. You cannot have context menus AND tooltips, only one or the other. More information on 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 pagenull
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 tooltip DO NOT get hidden.false
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotateColorIf you do not allow the use of the palette, then this will be the only colour allowed for annotations.black
annotateLinewidthThis 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
resizeHandleBackgroundWith this you can specify the background color 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
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 HBar 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 its not.null

Zoom

PropertyDescriptionDefault
zoomFactorThis is the factor that the chart will be zoomed by (bigger values means more zoom)1.5
zoomFadeInWhether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.true
zoomFadeOutWhether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.true
zoomHdirThe horizontal direction of the zoom. Possible values are: left, center, rightright
zoomVdirThe vertical direction of the zoom. Possible values are: up, center, downdown
zoomDelayThe delay (in milliseconds) between frames.50
zoomFramesThe number of frames in the zoom animation.10
zoomShadowWhether or not the zoomed canvas has a shadow or not.true

Events

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

PropertyDescriptionDefault
highlightStyleBy default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. Its 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 direction10
variantThreedOffsetyThis determines the size of the offset in the Y direction5
variantThreedXaxisThis allows you to turn on/off the threed X axistrue
variantThreedYaxisThis allows you to turn on/off the threed Y axistrue

 

Methods

 

obj.get(name)
An accessor that you can use to retrieve the value of properties.

 

obj.set(name, value)
An accessor that you can use to set the value of properties.

 

obj.getShape(event)

This method makes it easier 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: {
            labels', ['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 HBar 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 gutter 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, func)

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: {
        gutterLeft: 55,
        vmargin: 5,
        labels: ['Hoolio','Jill','Pete','Kevin','Lucy','John']
    }
}).on('mousemove', function (e, shape)
{
    // Handle mousemove event
})
.on('click', function (e, shape)
{
    // Handle 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: {
            gutterLeft: 35,
            vmargin: 5
        }
    }).grow({frames: 60}, myCallback)
</script>
Share RGraph!