# Horizontal bar charts documentation

- Example
- Properties
- Methods

## Example

    <script>
        window.onload = function ()
        {
            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 OfficeExcel.HBar('myCanvas', data);

            // Configure the chart to appear as wished.
            hbar.Set('chart.labels', ['Richard', 'Alex', 'Nick']);
            hbar.Set('chart.gutter.left', 45);
            hbar.Set('chart.background.barcolor1', 'white');
            hbar.Set('chart.background.barcolor2', 'white');
            hbar.Set('chart.background.grid', true);
            hbar.Set('chart.colors', ['red']);

            // Now call the .Draw() method to draw the chart.
            hbar.Draw();
        }
    </script>

The example file is here.

## Properties

You can use these properties to control how the bar chart apears. You can set them by using the Set() method. Eg:

myHBar.Set('name', 'value');

- Chart configuration
- Margins
- Colors
- Background
- Labels and text
- Titles
- Scale and axes
- Miscellaneous
- Shadow
- Key
- Interactive features
- Zoom
- Events

### Margins

chart.gutter.left
The left gutter of the chart, (the gutter is where the labels and title are)).
Default: 75
chart.gutter.right
The right gutter of the chart, (the gutter is where the labels and title are).
Default: 25
chart.gutter.top
The top gutter of the chart, (the gutter is where the labels and title are).
Default: 25
chart.gutter.bottom
The bottom gutter of the chart, (the gutter is where the labels and title are).
Default: 25

### Colors

chart.colors
An array of the colors of the actual bars.
Default: An array - ['rgb(0,0,255)', '#0f0', '#00f', '#ff0', '#0ff', '#0f0']
chart.colors.sequential
If true, for regular bar charts, the colors that you specify will be used in a sequential fashion.
Default: false

### Background

chart.background.barcolor1
The color of the background bars, (1 of 2).
Default: white
chart.background.barcolor2
The color of the background bars, (2 of 2).
Default: white
chart.background.grid
Whether to show the background grid or not.
Default: true
chart.background.grid.color
The color of the background grid.
Default: #ddd
chart.background.grid.hsize
The horizontal background grid size.
Default: 40
chart.background.grid.vsize
The vertical background grid size.
Default: 18
chart.background.grid.width
The width that the background grid lines are. Decimals (eg 0.5) are permitted.
Default: 0.5
chart.background.grid.border
Determines whether a border line is drawn around the grid.
Default: true
chart.background.grid.hlines
Determines whether to draw the horizontal grid lines.
Default: true
chart.background.grid.vlines
Determines whether to draw the vertical grid lines.
Default: true
chart.background.grid.autofit
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
chart.background.grid.autofit.numhlines
When using autofit this allows you to specify how many horizontal grid lines you want.
Default: 14
chart.background.grid.autofit.numvlines
When using autofit this allows you to specify how many vertical grid lines you want.
Default: 20

### Labels and text

chart.xlabels
A boolean controlling whether the X labels are shown.
Default: true
chart.labels
An array of the labels to be used on the chart.
Default: An empty array
chart.labels.above
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
chart.labels.above.decimals
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
chart.text.font
The font used to render the text.
Default: Verdana
chart.text.color
The color of the labels.
Default: black
chart.text.size
The size (in points) of the labels.
Default: 10

### Titles

chart.title
The title of the chart, if any.
Default: null
chart.title.font
The font that the title is rendered in. If not specified the chart.text.font setting is used (usually Verdana)
Default: null
chart.title.size
The size of the title. If not specified the size is usually 2pt bigger than the chart.text.size setting.
Default: null
chart.title.bold
Whather the title is bold or not.
Default: true
chart.title.background
The background color (if any) for the title.
Default: null
chart.title.hpos
This allows you to completely override the horizontal positioning of the title. It should be a number between 0 and 1, and is multiplied with the whole width of the canvas and then used as the horizontal position.
Default: null
chart.title.vpos
This allows you to completely override the vertical positioning of the title. It should be a number between 0 and 1, and is multiplied with the gutter and then used as the vertical position. It can be useful if you need to have a large gutter.
Default: null
chart.title.xaxis
This allows to specify a title for the X axis.
Default: none
chart.title.xaxis.size
This allows you to specify a size for the X axis title.
Default: null
chart.title.xaxis.font
This allows to specify a font for the X axis title.
Default: null
chart.title.xaxis.bold
This controls whether the X axis title is bold or not.
Default: true
chart.title.yaxis
This allows to specify a title for the Y axis.
Default: none
chart.title.yaxis.size
This allows you to specify a size for the Y axis title.
Default: null
chart.title.yaxis.font
This allows to specify a font for the Y axis title.
Default: null
chart.title.yaxis.bold
This controls whether the Y axis title is bold or not.
Default: true
chart.title.xaxis.pos
This is multiplied with the gutter to give the position of the X axis title.
Default: 0.25
chart.title.yaxis.pos
This is multiplied with the gutter to give the position of the Y axis title.
Default: 0.5
chart.title.color
The color of the title.
Default: black

### Scale and axes

chart.scale.point
The character used as the decimal point.
Default: .
chart.scale.thousand
The character used as the thousand separator
Default: ,
chart.scale.round
Whether to round the maximum scale value up or not. This will produce slightly better scales in some instances.
Default: null
chart.xmax
(Optional) An optional max figure for the X scale.
Default: none (one is calculated)
chart.xmin
An optional minimum figure for the X scale.
Default: 0
chart.yaxispos
The position of the Y axis. Works with regular and grouped charts. Can be either center or left.
Default: left
chart.axis.color
The color of the axes.
Default: black
chart.units.pre
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
chart.units.post
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
chart.units.ingraph
If your units are long, setting this stipulates them to be used for ingraph labels only.
Default: false

### Miscellaneous

chart.grouping
How the bars are grouped, and it should be one of: grouped or stacked
Default: grouped
chart.vmargin
The vertical margin that is applied to each individual bar.
Default: 3
chart.strokestyle
The color of the outlines of the bars.
Default: black
chart.highlight.stroke
If you use tooltips, this controls the colour of the highlight stroke.
Default: black
chart.highlight.fill
If you use tooltips, this controls the colour of the highlight fill.
Default: rgba(255,255,255,0.5)

### Shadow

chart.shadow
Whether a small drop shadow is applied.
Default: false
chart.shadow.color
The color of the shadow.
Default: #666
chart.shadow.offsetx
The X offset of the shadow.
Default: 3
chart.shadow.offsety
The Y offset of the shadow.
Default: 3
chart.shadow.blur
The severity of the shadow blurring effect.
Default: 3

### Key

chart.key
An array of key information.
Default: [] (An empty array)
chart.key.background
The color of the key background. Typically white, you could set this to something like rgba(255,255,255,0.7) to allow people to see things behind it.
Default: white
chart.key.halign
Instead of specifying the exact x/y coordinates, you can use this property to simply specify whether the key hould be aligned left or right.
Default: right
chart.key.position
Determines the position of the key.Either graph (default), or gutter.
Default: graph
chart.key.position.x
This allows you to specify a specific X coordinate for the key.
Default: null
chart.key.position.y
This allows you to specify a specific Y coordinate for the key.
Default: null
chart.key.position.gutter.boxed
If you have the key in gutter mode (ie horizontal), this allows you to give a background color.
Default: true
chart.key.shadow
Whether a small drop shadow is applied to the key.
Default: false
chart.key.shadow.color
The color of the shadow.
Default: #666
chart.key.shadow.blur
The extent of the blurring effect used on the shadow.
Default: 3
chart.key.shadow.offsetx
The X offset of the shadow.
Default: 2
chart.key.shadow.offsety
The Y offset of the shadow.
Default: 2
chart.key.rounded
This controls whether the corners of the key (in graph mode) are curved. If the key is gutter mode, this has no effect.
Default: false
chart.key.color.shape
This can be square, circle or line and controls how the color indicators in the key appear.
Default: square
chart.key.linewidth
The line width of the surrounding border on the key.
Default: 1

### Interactive features

chart.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)
chart.tooltips
An array of tooltips for the chart.
Default: An empty array
chart.tooltips.event
This is the event that triggers the tooltips. It can be onclick or onmousemove.
Default: onclick
chart.tooltips.effect
The visual effect used when showing tooltips. Can be either fade or expand.
Default: fade
chart.tooltips.css.class
This is the name of the CSS class the chart uses.
Default: OfficeExcel_tooltip
chart.tooltips.override
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
chart.annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false
chart.annotate.color
If you do not allow the use of the palette, then this will be the only colour allowed for annotations.
Default: black
chart.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
chart.resize.handle.background
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

### Zoom

chart.zoom.mode
Can be used to control whether the zoom is in thumbnail or canvas mode. Possible values are: thumbnail and canvas.
Default: canvas
chart.zoom.factor
This is the factor that the chart will be zoomed by (bigger values means more zoom)
Default: 1.5
chart.zoom.fade.in
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
chart.zoom.fade.out
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
chart.zoom.hdir
The horizontal direction of the zoom. Possible values are: left, center, right
Default: right
chart.zoom.vdir
The vertical direction of the zoom. Possible values are: up, center, down
Default: down
chart.zoom.delay
The delay (in milliseconds) between frames.
Default: 50
chart.zoom.frames
The number of frames in the zoom animation.
Default: 10
chart.zoom.shadow
Whether or not the zoomed canvas has a shadow or not.
Default: true
chart.zoom.thumbnail.width
When the zoom is in thumbnail mode, this is the width (in pixels) of the thumbnail.
Default: 75
chart.zoom.thumbnail.height
When the zoom is in thumbnail mode, this is the height (in pixels) of the thumbnail.
Default: 75
chart.zoom.thumbnail.fixed
When the zoom is in thumbnail mode, you can use this property to fix the zoom in the top left corner instead of it following the cursor around.
Default: false
chart.zoom.background
Defaulting to true, this determines whether the zoom has a dark, semi-opaque background that covers the entire web page.
Default: true

### Events

chart.events.click
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
chart.events.mousemove
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

## Methods

obj.getBar(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 X coordinate
- The Y coordinate
- The width of the bar
- The height of the bar
- The numerical index of the bar. This corresponds (for example) to the tooltips array, and the coordinates array

An example usage is:

    <canvas id="cvs" width="600" height="250">[No canvas support]</canvas>

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

    <script>
        myGraph = new OfficeExcel.HBar('myCanvas', [1.2, 1.3, 1.4, 1.5,6,1.9,2,2.1,2.5]);
        myGraph.Set('chart.labels', ['John', 'Barry', 'Rich', 'Craig', 'Tom', 'Frank', 'Helen', 'Joyce', 'Fred'])
        myGraph.Draw();

        OfficeExcel.Register(myGraph);

        myGraph.canvas.onclick = function (e)
        {
            OfficeExcel.Redraw();

            var canvas  = e.target;
            var context = canvas.getContext('2d');
            var obj     = canvas.__object__;
            var bar     = obj.getBar(e);

            if (bar) {

                var top    = bar[0];
                var left   = bar[1];
                var width  = bar[2];
                var height = bar[3];
                var idx    = bar[4];

                context.beginPath();
                    context.strokeStyle = 'black';
                    context.fillStyle = 'rgba(255,255,255,0.5)';
                    context.strokeRect(top, left, width, height);
                    context.fillRect(top, left, width, height);
                context.stroke();
                context.fill();
            }
        }
    </script>

obj.getShape(event)

This method is an alternate name for the above method but has a generic name that is the same acoss the various libraries.

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);

        // ...
    }