Horizontal progress bar documentation

  Read comments...

 

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.

 

Chart configuration

tickmarks
Whether the tickmarks are drawn.
Default: true

tickmarksColor
The color used for tickmarks.
Default: black

tickmarksInner
This controls whether the bar has inner tickmarks
Default: false

tickmarksZerostart
If true, labels and tickmarks will start at and show zero.
Default: true

numticks
How many tick marks there are.
Default: 10

numticksInner
How many inner tick marks there are.
Default: 50

arrows
This stipulates that two indicator arrows are drawn. It works best if you have tickmarks off, and no title.
Default: false

 

Margins

gutterLeft
The left gutter of the chart, (the gutter is where the labels and title are)).
Default: 25

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

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

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

 

Colors

colors
The colors of the bar(s). This can be a solid color, or a gradient that you create.
Default: [#0c0]

strokestyleInner
This is the strokestyle used for the inner part of the chart.
Default: #999

strokestyleOuter
This is the strokestyle used for the outer part of the chart.
Default: #999

backgroundColor
The background color.
Default: #eee

 

Shadow

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

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

textColor
The color of the labels.
Default: black

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

labels
Labels that are applied to the chart.
Default: An empty array

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('labels.specific', []);
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

 

Scale

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

unitsPost
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: ,

 

Titles

title
The title of the progress bar.
Default: An empty string

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

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

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

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

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

titleColor
The color of the title.
Default: black

 

Interactive features

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 tooltip DO NOT get hidden.
Default: false

contextmenu
An array of context menu items. More information on 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

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

annotateLinewidth
This is the line width of the annotations.
Default: 1

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

resizeHandleBackground
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

resizableMaxwidth
This allows you to set a maximum width that the chart can be resized to.
Default: null

resizableMaxheight
This allows you to set a maximum height that the chart can be resized to.
Default: null

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

 

Zoom

zoomFactor
This is the factor that the chart will be zoomed by (bigger values means more zoom)
Default: 1.5

zoomFadeIn
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

zoomFadeOut
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

zoomHdir
The horizontal direction of the zoom. Possible values are: left, center, right
Default: right

zoomVdir
The vertical direction of the zoom. Possible values are: up, center, down
Default: down

zoomDelay
The delay (in milliseconds) between frames.
Default: 50

zoomFrames
The number of frames in the zoom animation.
Default: 10

zoomShadow
Whether or not the zoomed canvas has a shadow or not.
Default: true

 

Events

eventsClick
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

eventsMousemove
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

eventsMouseover
If you want to add your own onmouseover 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 onmouseout function you can do so by assigning it to this property. See here for details.
Default: null

 

Key

The key properties are documented on the key documentation page.

 

Miscellaneous

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. Its passed the shape object as an argument.
Default: null

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

highlightFill
If you use tooltips, this controls the colour 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 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>
Share RGraph
X

Comments