Horizontal progress bar documentation

 

Example

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

Chart configuration

PropertyDescriptionDefault
tickmarksWhether the tickmarks are drawn.true
tickmarksColorThe color used for tickmarks.black
tickmarksInnerThis controls whether the bar has inner tickmarksfalse
tickmarksZerostartIf true, labels and tickmarks will start at and show zero.true
numticksHow many tick marks there are.10
numticksInnerHow many inner tick marks there are.50
arrowsThis stipulates that two indicator arrows are drawn. It works best if you have tickmarks off, and no title.false

Margins

PropertyDescriptionDefault
gutterLeftThe left gutter of the chart, (the gutter is where the labels and title are)).25
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

Colors

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

Shadow

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

Labels and text

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 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
textFontThe font used to render the text.Arial
textColorThe color of the labels.black
textSizeThe size of the text (in points).10
labelsLabels that are applied to the chart.An empty array
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('labels.specific', []);10
labelsOffsetxThis can be used to move the labels in the X direction0
labelsOffsetyThis can be used to move the labels in the Y direction0

Scale

PropertyDescriptionDefault
unitsPreThe units that the Y scale is measured in (these are preppend to the number).none
unitsPostThe 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,

Titles

PropertyDescriptionDefault
titleThe title of the progress bar.An empty string
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

Interactive features

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 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
contextmenuAn array of context menu items. More information on context menus is here.An empty array
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
adjustableDefaulting to false, this determines whether your progress bar will be adjustable (click the bar and drag it).false

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

Key

The key properties are documented on the key documentation page.

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

 

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 returns the details of a focused bar (ie clicked or mouseover'ed. 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 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 coord 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 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)
    {
        // ...
    }

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