Vertical Progress bar API reference

Documentation about the Vertical Progress bar including information about all of the options that are available to you. The Vertical Progress bar can be used to show one or more values or quantities. The standard Bar chart can also be configured to look like a progress bar.

Example

<script>
    new RGraph.VProgress({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 78,
        options: {
            colors: ['Gradient(white:red)'],
            marginRight: 50,
            hmargin: 15
        }
    }).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).25
marginRightThe right margin of the chart.25
marginTopThe top margin of the chart.25
marginBottomThe bottom margin of the chart.25
marginInnerThe inner margin of the progress bar.0

Background properties

PropertyDescriptionDefault
backgroundColorThe background colour.#eee

Colour properties

PropertyDescriptionDefault
colorThe colour of the bar. This can be a solid colour, or a gradient that you create.#0c0
colorsStrokeInnerThis is the stroke colour used for the inner part of the chart.#999
colorsStrokeOuterThis is the stroke colour used for the outer part of the chart.#999

Tickmark properties

PropertyDescriptionDefault
tickmarksOuterCountHow many outer tick marks there are.0
tickmarksInnerCountHow many inner tick marks there are.0

Shadow properties

PropertyDescriptionDefault
shadowWhether a drop shadow is applied.false
shadowColorThe colour of the shadow.rgba(0,0,0,0.5)
shadowOffsetxThe X offset of the shadow.3
shadowOffsetyThe Y offset of the shadow.3
shadowBlurThe severity of the shadow blurring effect.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 colour of the labels.black
textSizeThe size of the text (in points).12
textBoldWhether the text on the chart is bold or not.false
textItalicWhether the text on the chart is bold or not.false
labelsFontThe font used to render the labels.null
labelsColorThe colour of the labels.null
labelsSizeThe size of the labels (in points).null
labelsBoldWhether the labels on the chart are bold or not.null
labelsItalicWhether the labels on the chart are italic or not.null
labelsInnerWhether a label is displayed just above the progress bar.false
labelsInnerFontThe font used for the inner label.null
labelsInnerSizeThe size of the inner label.null
labelsInnerColorThe colour of the inner label.null
labelsInnerBoldWhether the inner labels is bold or not.null
labelsInnerItalicWhether the inner labels is italic or not.null
labelsInnerBackgroundFillThe background colour of the inner label.rgba(255,255,255,0.75)
labelsInnerBorderWhether the background label has a border or not.true
labelsInnerBorderLinewidthThe linewidth of the border of the label.1
labelsInnerBorderColorThe colour of the border of the label.#ccc
labelsInnerDecimalsHow many decimals the inner labels has.0
labelsInnerUnitsPreUnits which are PREPENDED to the label.(an empty string)
labelsInnerUnitsPostUnits which are APPENDED to the label.(an empty string)
labelsInnerPointThe character that is used as the decimal separator..
labelsInnerThousandThe character that is used as the thousand separator.,
labelsInnerSpecificThis can be a specific label that you want to show instead of the value.null
labelsPositionCan be left or right and controls which side the labels are positioned on.right
labelsSpecificIf you want to specify your own labels, which can be textual, you can use this.null
labelsCountThis controls how many labels there are.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 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
scaleDecimalsThis stipulates how many decimal places there are.0
scalePointThe character used as the decimal point..
scaleThousandThe character used as the thousand separator,

Title properties

PropertyDescriptionDefault
titleThe title of the progress bar.An empty string
titleFontThe font that the title is rendered in.null
titleSizeThe size of the title.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleColorThe colour of the title.null
titleSideUsing this property you can specify a title for the chart that is displayed in the left hand margin (vertically).null
titleSideFontThe font used to draw the side title.null
titleSideSizeThe font size of the side title.null
titleSideColorThe colour used for the side title.null
titleSideBoldWhether the side title is bold or not.null
titleSideItalicWhether the side title is italic or not.null

Interactive features properties

PropertyDescriptionDefault
tooltipsAn array, albeit one element only. This is shown when the progress bar is clicked on. Tooltips 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 chart uses.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 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 colour allowed for annotations.black
annotatableLinewidthThis 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
resizableHandleBackgroundWith this you can specify the background colour 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
resizableMinwidthThis allows you to set a minimum width that the chart can be resized to.null
resizableMinheightThis allows you to set a minimum height that the chart can be resized to.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 bar chart will be adjustable.false

Event properties

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 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. 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)
cleartoThis is used in animations and effects as the default colour to use when clearing the canvas.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 details of any focused bar. 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.getYCoord(value)

This method can be used to retrieve the correct Y coordinate for the given Y value.

<script>
    coord = myVProgress.getYCoord(27);
</script>
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 event code here
});

The function is useful if you use method chaining when creating your charts:

var obj = new RGraph.VProgress('cvs', 0,100,56)
    .on('draw', function (e, shape)
    {
        // Put ondraw code here
    })
    .on('click', function (e, shape)
    {
        // Handle click event
    })
    .draw();
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.VProgress({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 56,
        options: {
            marginLeft: 35
        }
    }).grow({frames: 60}, myCallback);
</script>