Horizontal Progress bars API reference

Summary: Documentation about the Horizontal Progress Bar including information about all of the options that are available to you. This is simply a horizontal version of the vertical progress bar so it may suit your design better. It can show one or more values. The Horizontal Bar chart can also be configured to look like a progress bar.

Example

<script>
    new RGraph.HProgress({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 78,
        options: {
            colors: ['red'],
            marginInner: 10
        }
    }).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 above.

Margin properties

PropertyDescriptionDefault
marginLeftThe left margin of the chart, (the margin is where the labels and title are)).25
marginRightThe right margin of the chart, (the margin is where the labels and title are).25
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
marginInnerThis is the margin that can be applied to the inside of the progress bar.0
marginLeft
The left margin of the chart, (the margin is where the labels and title are)).
Default: 25

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

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

marginBottom
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 25

marginInner
This is the margin that can be applied to the inside of the progress bar.
Default: 0

Tickmark properties

PropertyDescriptionDefault
tickmarksColorThe color used for tickmarks.black
tickmarksOuterCountHow many outer tickmarks there are.0
tickmarksInnerCountHow many inner tickmarks there are.0
tickmarksColor
The color used for tickmarks.
Default: black

tickmarksOuterCount
How many outer tickmarks there are.
Default: 0

tickmarksInnerCount
How many inner tickmarks there are.
Default: 0

Color properties

PropertyDescriptionDefault
colorsThe colors of the bar(s). This can be a solid color, or a gradient that you create.[#0c0]
colorsStrokeInnerThis is the stroke color used for the inner part of the chart.#999
colorsStrokeOuterThis is the stroke color used for the outer part of the chart.#999
backgroundColorThe background color.#eee
colors
The colors of the bar(s). This can be a solid color, or a gradient that you create.
Default: [#0c0]

colorsStrokeInner
This is the stroke color used for the inner part of the chart.
Default: #999

colorsStrokeOuter
This is the stroke color used for the outer part of the chart.
Default: #999

backgroundColor
The background color.
Default: #eee

Shadow properties

PropertyDescriptionDefault
shadowWhether 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).false
shadowOffsetxThe X offset of the progress bar shadow.3
shadowOffsetyThe Y offset of the progress bar shadow.3
shadowColorThe color of the shadow.rgba(0,0,0,0.5)
shadowBlurThe blurring effect that is applied to the shadow.3
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

shadowOffsetx
The X offset of the progress bar shadow.
Default: 3

shadowOffsety
The Y offset of the progress bar shadow.
Default: 3

shadowColor
The color of the shadow.
Default: rgba(0,0,0,0.5)

shadowBlur
The blurring effect that is applied to the shadow.
Default: 3

Labels and text properties

PropertyDescriptionDefault
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
textFontThe font used to render the text.Arial, Verdana, sans-serif
textColorThe color of the labels.black
textSizeThe size of the text (in points).12
textBoldWhether text on the chart is bold or not.false
textItalicWhether text on the chart is italic or not.false
labelsPositionThis determines whether the labels are placed on the top or the bottom of the progress bar.bottom
labelsSpecificIf you want to specify your own labels, which can be textual, you can use this.null
labelsCountThis controls how many labels are shown as part of the scale. If you don't want any labels at all you should use this code instead of setting this property to 0: obj.set('labelsSpecific', []);.10
labelsOffsetxThis can be used to move the labels in the X direction.0
labelsOffsetyThis can be used to move the labels in the Y direction.0
labelsFontThe font used by the labels.null
labelsSizeThe size of the labels.null
labelsColorThe color of the labels.null
labelsBoldWhether the labels are bold or not.null
labelsItalicWhether the labels are italic or not.null
labelsInnerWhether a label is displayed just above the progress bar.false
labelsInnerFontThe font used by the inner label.null
labelsInnerSizeThe size of the inner label.null
labelsInnerColorThe color of the inner label.null
labelsInnerBoldWhether the inner label is bold or not.null
labelsInnerItalicWhether the inner label is italic or not.null
labelsInnerBackgroundFillThis is used as the color of the background of the label.rgba(255,255,255,0.7)
labelsInnerDecimalsThe number of decimals on the inner label.0
labelsInnerUnitsPreThe units that are prepended to the inner label.[an empty string]
labelsInnerUnitsPostThe units that are appended to the inner label.[an empty string]
labelsInnerPointThe decimal point separator for the inner label.null
labelsInnerThousandThe thousand separator for the inner label.null
labelsInnerBorderWhether the inner labels has a border or not.true
labelsInnerBorderColorThe color of the inner border.#ccc
labelsInnerBorderLinewidthThe linewidth of the inner labels border.1
labelsInnerSpecificThis can be a string that's used as the label instead of the value.null
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 margins 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

textFont
The font used to render the text.
Default: Arial, Verdana, sans-serif

textColor
The color of the labels.
Default: black

textSize
The size of the text (in points).
Default: 12

textBold
Whether text on the chart is bold or not.
Default: false

textItalic
Whether text on the chart is italic or not.
Default: false

labelsPosition
This determines whether the labels are placed on the top or the bottom of the progress bar.
Default: bottom

labelsSpecific
If you want to specify your own labels, which can be textual, you can use this.
Default: null

labelsCount
This controls how many labels are shown as part of the scale. If you don't want any labels at all you should use this code instead of setting this property to 0: obj.set('labelsSpecific', []);.
Default: 10

labelsOffsetx
This can be used to move the labels in the X direction.
Default: 0

labelsOffsety
This can be used to move the labels in the Y direction.
Default: 0

labelsFont
The font used by the labels.
Default: null

labelsSize
The size of the labels.
Default: null

labelsColor
The color of the labels.
Default: null

labelsBold
Whether the labels are bold or not.
Default: null

labelsItalic
Whether the labels are italic or not.
Default: null

labelsInner
Whether a label is displayed just above the progress bar.
Default: false

labelsInnerFont
The font used by the inner label.
Default: null

labelsInnerSize
The size of the inner label.
Default: null

labelsInnerColor
The color of the inner label.
Default: null

labelsInnerBold
Whether the inner label is bold or not.
Default: null

labelsInnerItalic
Whether the inner label is italic or not.
Default: null

labelsInnerBackgroundFill
This is used as the color of the background of the label.
Default: rgba(255,255,255,0.7)

labelsInnerDecimals
The number of decimals on the inner label.
Default: 0

labelsInnerUnitsPre
The units that are prepended to the inner label.
Default: [an empty string]

labelsInnerUnitsPost
The units that are appended to the inner label.
Default: [an empty string]

labelsInnerPoint
The decimal point separator for the inner label.
Default: null

labelsInnerThousand
The thousand separator for the inner label.
Default: null

labelsInnerBorder
Whether the inner labels has a border or not.
Default: true

labelsInnerBorderColor
The color of the inner border.
Default: #ccc

labelsInnerBorderLinewidth
The linewidth of the inner labels border.
Default: 1

labelsInnerSpecific
This can be a string that's used as the label instead of the value.
Default: null

Scale properties

PropertyDescriptionDefault
scaleUnitsPreThe units that the Y scale is measured in (these are prepended to the number).none
scaleUnitsPostThe units that the Y scale is measured in (these are appended to the number).none
scaleDecimalsThe number of decimal places to display for the Y scale.0
scalePointThe character used as the decimal point..
scaleThousandThe character used as the thousand separator.,
scaleUnitsPre
The units that the Y scale is measured in (these are prepended to the number).
Default: none

scaleUnitsPost
The units that the Y scale is measured in (these are appended to the number).
Default: none

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

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

scaleThousand
The character used as the thousand separator.
Default: ,

Title properties

PropertyDescriptionDefault
titleThe title of the progress bar.An empty string
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
titleColorThe color of the title.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleBackgroundThe background color (if any) for the title.null
title
The title of the progress bar.
Default: An empty string

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

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

titleColor
The color of the title.
Default: null

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

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

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

Interactive features properties

PropertyDescriptionDefault
tooltipsAn array, albeit one element only. This is shown when the progress bar is clicked on. This can contain HTML.An empty array
tooltipsEffectThe effect used for showing tooltips. Can be either fade or none.fade
tooltipsCssClassThis is the name of the CSS class the tooltips use.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 the tooltips do not get hidden.false
contextmenuAn array of context menu items. More information about context menus is here.An empty array
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 color allowed for annotations.black
annotatableLinewidthThis is the linewidth of the annotations.1
adjustableDefaulting to false, this determines whether your progress bar will be adjustable (click the bar and drag it).false
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

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 tooltips use.
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 the tooltips do not get hidden.
Default: false

contextmenu
An array of context menu items. More information about context menus is here.
Default: An empty array

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

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

annotatableLinewidth
This is the linewidth of the annotations.
Default: 1

adjustable
Defaulting to false, this determines whether your progress bar will be adjustable (click the bar and drag it).
Default: false

Event properties

PropertyDescriptionDefault
eventsClickIf you want to add your own click function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own mousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own mouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own mouseout function you can do so by assigning it to this property. See here for details.null
eventsClick
If you want to add your own click 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 mousemove 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 mouseover 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 mouseout function you can do so by assigning it to this property. See here for details.
Default: null

Key properties

The key properties are documented on the key documentation page.

Miscellaneous properties

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. It's passed the shape object as an argument.null
highlightStrokeIf you use tooltips, this controls the color of the highlight stroke.black
highlightFillIf you use tooltips, this controls the color of the highlight fill.rgba(255,255,255,0.5)
borderInnerThis controls the inner border of the bar. If you're using a gradient you may wish to turn this off.true
cleartoThis is used in animations and effects as the default color to use when the canvas.null
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. It's passed the shape object as an argument.
Default: null

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

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

borderInner
This controls the inner border of the bar. If you're using a gradient you may wish to turn this off.
Default: true

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

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 returns the details of a focused bar (ie clicked or hovered over. It returns:

The shape also includes textual indexes like this: shape['object'] And they are:

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 that you wish to attach to and the second is the handler function. For example:

.on('draw', function (obj)
{
    // Put your event code here
});
The exec option and method

The exec function is documented here.

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)
    {
        // ...
    }

    obj = new RGraph.HProgress({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 56,
        options: {
            marginLeft: 35
        }
    }).grow({frames: 60}, myCallback)
</script>