Horizontal bar charts documentation

  Read comments...

 

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.

 

Margins

gutterLeft
The left gutter of the chart, (the gutter is where the labels and title are)).
Default: 75

gutterLeftAutosize
If set to true this will automatically size the left gutter to accomodate your labels).
Default: false

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

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

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

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

 

Colors

colors
An array of the colors of the bars.
Default: ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']

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

 

Background

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

backgroundBarcolor2
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

backgroundGridWidth
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

backgroundGridAutofit
Instead of specifying a pixel width/height for the background grid, you can use autofit and specify how many horizontal and vertical lines you want.
Default: true

backgroundGridAutofitNumhlines
When using autofit this allows you to specify how many horizontal grid lines you want.
Default: 14

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

backgroundGridDotted
If you want to have your background grid dashed then set this to true.
Default: false

backgroundGridDashed
If you want to have your background grid dotted then set this to true. This takes precedence over dashed lines.
Default: false

backgroundColor
If you want to have a single background color for your chart you can use this. It doesn't cover the gutters. If you want that then you can simply apply a CSS background color to the canvas tag.
Default: null

 

Labels and text

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

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

xlabelsSpecific
You can use this option to give your own X labels (eg ['Low', 'Medium', 'High'].
Default: null

xlabelsOffsetx
This allows you finer grained control in the horizontal direction over the X label positioning if you need it.
Default: 0

xlabelsOffsety
This allows you finer grained control in the vertical direction over the X label positioning if you need it.
Default: 0

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

labelsOffsetx
This allows you finer grained control in the horizontal direction over the Y label positioning if you need it.
Default: 0

labelsOffsety
This allows you finer grained control in the vertical direction over the Y label positioning if you need it.
Default: 0

labelsBold
Whether the labels are bold or not
Default: false

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

labelsOffsetx
This moves the labels in the X direction
Default: 0

labelsOffsety
This moves the labels in the Y direction
Default: 0

labelsAbove
This is a boolean which if true, will cause labels to be shown to the right of the bars. (It's called "above" for API compatibility).
Default: false

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

labelsAboveSpecific
This is an array of specific above labels that will be shown in place of the relevant value.
Default: null

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

labelsAboveUnitsPre
If you wish you can specify units that are prepended to the text label (seperately to to the main unitsPre ssetting)
Default: null

labelsAboveUnitsPost
If you wish you can specify units that are appended to the text label (seperately to to the main unitsPost ssetting)
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: false

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

textFont
The font used to render the text.
Default: Arial

textColor
The color of the labels.
Default: black

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

textAccessible
A new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:
<div style="margin-left: 50px; display: inline-block">
<canvas id="cvs" width="650" height="250"></canvas>
</div>

Default: true

textAccessibleOverflow
This can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small gutters 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

 

Titles

title
The title of the chart, if any.
Default: null

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

titleSize
The size of the title. If not specified the size is usually 2pt bigger than the text.size setting.
Default: null

titleBold
Whether the title is bold or not.
Default: true

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

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

titleColor
The color of the title.
Default: black

titleX
To give the exact X coordinate for the title - use this
Default: null

titleY
To give the exact Y coordinate for the title - use this
Default: null

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

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

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

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

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

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

titleXaxisX
By giving this you can specifically set the X position of the X axis title
Default: null

titleXaxisY
By giving this you can specifically set the Y position of the X axis title
Default: null

titleYaxis
This allows to specify a title for the Y axis.
Default: none

titleYaxisSize
This allows you to specify a size for the Y axis title.
Default: null

titleYaxisFont
This allows to specify a font for the Y axis title.
Default: null

titleYaxisBold
This controls whether the Y axis title is bold or not.
Default: true

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

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

titleYaxisX
By giving this you can specifically set the X position of the Y axis title
Default: null

titleYaxisY
By giving this you can specifically set the Y position of the Y axis title
Default: null

 

Scale and axes

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

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

scaleThousand
The character used as the thousand separator
Default: ,

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

scaleZerostart

Default: false

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

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

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

axisColor
The color of the axes.
Default: black

axisLinewidth
The linewidth of the axes.
Default: 1

noxaxis
Set this to true if you don't want a X axis.
Default: false

noaxes
Instead of the above two properties you can specify this to turn off both the X and Y axes.
Default: false

noyaxis
Set this to true if you don't want a Y axis.
Default: false

unitsPre
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

unitsPost
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

unitsIngraph
If your units are long, setting this stipulates them to be used for ingraph labels only.
Default: false

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

noytickmarks
Using this property you can turn off the Y tickmarks.
Default: false

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

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

 

Miscellaneous

grouping
How the bars are grouped, and it should be one of: grouped or stacked
Default: grouped

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

highlightStroke
If you use tooltips, this controls the colour of the highlight stroke.
Default: black

highlightFill
If you use tooltips, this controls the colour of the highlight fill.
Default: rgba(255,255,255,0.5)

clearto
This is used in animations and effects as the default color to use when the canvas.
Default: null

 

Shadow

shadow
Whether a small drop shadow is applied.
Default: false

shadowColor
The color of the shadow.
Default: #666

shadowOffsetx
The X offset of the shadow.
Default: 3

shadowOffsety
The Y offset of the shadow.
Default: 3

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

 

Key

The key properties are documented on the key documentation page.

 

Interactive features

contextmenu
An array of context menu items. You cannot have context menus AND tooltips, only one or the other. More information on 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 onclick or onmousemove.
Default: onclick

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

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

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

tooltipsNohideonclear
Not an option that you'll need particularly often if at all. Setting this to true means that when you call the RGraph.clear() API function tooltip DO NOT get hidden.
Default: false

annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false

annotateColor
If you do not allow the use of the palette, then this will be the only colour allowed for annotations.
Default: black

annotateLinewidth
This is the line width of the annotations.
Default: 1

resizable
Defaulting 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).
Default: false

resizeHandleBackground
With 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.
Default: null

resizableMaxwidth
This allows you to set a maximum width that the chart can be resized to.
Default: null

resizableMaxheight
This allows you to set a maximum height that the chart can be resized to.
Default: null

adjustable
By setting this you can allow your chart to be adjustable. There's a documentation page about adjusting the HBar chart here.
Default: false

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

 

Zoom

zoomFactor
This is the factor that the chart will be zoomed by (bigger values means more zoom)
Default: 1.5

zoomFadeIn
Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true

zoomFadeOut
Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true

zoomHdir
The horizontal direction of the zoom. Possible values are: left, center, right
Default: right

zoomVdir
The vertical direction of the zoom. Possible values are: up, center, down
Default: down

zoomDelay
The delay (in milliseconds) between frames.
Default: 50

zoomFrames
The number of frames in the zoom animation.
Default: 10

zoomShadow
Whether or not the zoomed canvas has a shadow or not.
Default: true

 

Events

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

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

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

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

 

Miscellaneous

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. Its passed the shape object as an argument.
Default: null

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

variantThreedOffsetx
This determines the size of the offset in the X direction
Default: 10

variantThreedOffsety
This determines the size of the offset in the Y direction
Default: 5

variantThreedXaxis
This allows you to turn on/off the threed X axis
Default: true

variantThreedYaxis
This allows you to turn on/off the threed Y axis
Default: true

 

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
X

Comments