# Horizontal progress bar documentation

- Example
- Properties
- Methods

## Example

    <script>
        window.onload = function ()
        {
            // Create the progress bar. The arguments are: the canvas tag ID, the value and the
            // maximum value.
            var myProgress = new OfficeExcel.HProgress('myProgress', 78, 100);

            // Configure the progress bar to appear as requested.
            myProgress.Set('chart.colors', ['red']);

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

The example file is here.

## Properties

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

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

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

### Chart configuration

chart.tickmarks
Whether the tickmarks are drawn.
Default: true
chart.tickmarks.color
The color used for tickmarks.
Default: black
chart.tickmarks.inner
This controls whether the bar has inner tickmarks
Default: false
chart.tickmarks.zerostart
If true, labels and tickmarks will start at and show zero.
Default: false
chart.numticks
How many tick marks there are.
Default: 10
chart.numticks.inner
How many inner tick marks there are.
Default: 50
chart.arrows
This stipulates that two indicator arrows are drawn. It works best if you have tickmarks off, and no title.
Default: false

### Margins

chart.gutter.left
The left gutter of the chart, (the gutter is where the labels and title are)).
Default: 25
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
The colors of the bar(s). This can be a solid color, or a gradient that you create.
Default: [#0c0]
chart.background.color
The background color.
Default: #eee

### Shadow

chart.shadow
Whether the progress bar has a shadow. This uses the canvas shadow API and therefore is only supported on Chrome 2, Safari 3.1 and Firefox 3.1 (and above).
Default: false
chart.shadow.offsetx
The X offset of the progress bar shadow.
Default: 3
chart.shadow.offsety
The Y offset of the progress bar shadow.
Default: 3
chart.shadow.color
The color of the shadow.
Default: rgba(0,0,0,0.5)
chart.shadow.blur
The blurring effect that is applied to the shadow.
Default: 3

### Labels and text

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 of the text (in points).
Default: 10
chart.labels
Labels that are applied to the chart.
Default: An empty array
chart.labels.position
This determines whether the labels are placed on the top or the bottom of the progress bar.
Default: bottom

### Scale

chart.units.pre
The units that the Y scale is measured in (these are preppend to the number).
Default: none
chart.units.post
The units that the Y scale is measured in (these are appended to the number).
Default: none
chart.scale.decimals
The number of decimal places to display for the Y scale.
Default: 0
chart.scale.point
The character used as the decimal point.
Default: .
chart.scale.thousand
The character used as the thousand separator
Default: ,

### Titles

chart.title
The title of the progress bar.
Default: An empty string
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.color
The color of the title.
Default: black

### Interactive features

chart.tooltips
An array, albeit one element only. This is shown when the progress bar is clicked on. This can contain HTML.
Default: An empty array
chart.tooltips.effect
The animated effect used for showing the tooltip. Can be either fade or expand.
Default: fade
chart.tooltips.css.class
This is the name of the CSS class the tooltips use.
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.contextmenu
An array of context menu items. More information on context menus is here.
Default: [] (An empty array)
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
chart.adjustable
Defaulting to false, this determines whether your progress bar will be adjustable (click the bar and drag it).
Default: false

### Zoom

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.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

### Miscellaneous

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)

### 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 or gutter (default).
Default: gutter
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: false
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: true
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

## Methods

obj.getBar(event)

This method returns the details of a focused bar (ie clicked or mouseover'ed. It returns:

- The chart object
- The X coordinate
- The Y coordinate
- The width of the bar
- The height of the bar
- The index of the bar (starting from 0)

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

        // ...
    }