Semi-circular Progress bar API reference

Summary: Documentation about the Semi-circular Progress bar including information about all of the options that are available to you. The Semi-circular Progress bar can be used instead of a Vertical or Horizontal Progress bar or a Thermometer chart.

Example

<script>
    new RGraph.SemiCircularProgress({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 84,
        options: {
            colors: ['Gradient(white:blue)'],
            adjustable: true,
            labelsMinSize: 16,
            labelsMaxSize: 16,
            labelsCenterSize: 50
        }
    }).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 is shown above.

Chart configuration properties

PropertyDescriptionDefault
centerxYou can use this to stipulate exactly the X coordinate where the chart should appear.null
centeryYou can use this to stipulate exactly the Y coordinate where the chart should appear.null
radiusYou can use this to specify the radius of the chart.null
anglesStartYou can specify the angle that the progress should start at with this property. Keep in mind though - that by default the progress is positioned at the bottom of the canvas. Remember that there are three "constants" available for you to use: RGraph.HALFPI RGraph.PI RGraph.TWOPIPi (3.14...)
anglesEndYou can specify the angle that the progress should end at with this property. Keep in mind though - that by default the progress is positioned at the bottom of the canvas. Remember that there are three "constants" available for you to use: RGraph.HALFPI RGraph.PI RGraph.TWOPI2 * Pi (6.28...)
centerx
You can use this to stipulate exactly the X coordinate where the chart should appear.
Default: null

centery
You can use this to stipulate exactly the Y coordinate where the chart should appear.
Default: null

radius
You can use this to specify the radius of the chart.
Default: null

anglesStart
You can specify the angle that the progress should start at with this property. Keep in mind though - that by default the progress is positioned at the bottom of the canvas. Remember that there are three "constants" available for you to use: RGraph.HALFPI RGraph.PI RGraph.TWOPI
Default: Pi (3.14...)

anglesEnd
You can specify the angle that the progress should end at with this property. Keep in mind though - that by default the progress is positioned at the bottom of the canvas. Remember that there are three "constants" available for you to use: RGraph.HALFPI RGraph.PI RGraph.TWOPI
Default: 2 * Pi (6.28...)

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

Color properties

PropertyDescriptionDefault
colorsThe color of the bar. This can be a solid color, or a gradient that you create. It should be an array consisting of the color. As of v4.57 you can also add a second color which will be used as the background of the bar. If you specify a background it won't be faded for you - you'll need to do that yourself if it's desired.[#0c0]
colorsStrokeThis is the stroke color that's used for the inner part of the chart.#999
colors
The color of the bar. This can be a solid color, or a gradient that you create. It should be an array consisting of the color. As of v4.57 you can also add a second color which will be used as the background of the bar. If you specify a background it won't be faded for you - you'll need to do that yourself if it's desired.
Default: [#0c0]

colorsStroke
This is the stroke color that's used for the inner part of the chart.
Default: #999

Background properties

PropertyDescriptionDefault
backgroundColorThe background color (of the entire canvas).rgba(0,0,0,0)
backgroundColor
The background color (of the entire canvas).
Default: rgba(0,0,0,0)

Shadow properties

PropertyDescriptionDefault
shadowWhether a drop shadow is applied.false
shadowColorThe color of the shadow.rgba(220,220,220,1)
shadowOffsetxThe X offset of the shadow.2
shadowOffsetyThe Y offset of the shadow.2
shadowBlurThe severity of the shadow blurring effect.2
shadow
Whether a drop shadow is applied.
Default: false

shadowColor
The color of the shadow.
Default: rgba(220,220,220,1)

shadowOffsetx
The X offset of the shadow.
Default: 2

shadowOffsety
The Y offset of the shadow.
Default: 2

shadowBlur
The severity of the shadow blurring effect.
Default: 2

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>
false
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).false
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 the text is bold or not.false
textItalicWhether the text is italic or not.false
labelsMinColorThe color of the minimum label.null
labelsMinFontThe font of the minimum label.null
labelsMinBoldWhether the minimum label is bold or not.null
labelsMinSizeThe size of the minimum label.null
labelsMinItalicWhether the minimum label is italic or not.null
labelsMinOffsetAngleAny offset to add to the angle that the minimum label uses (measured in radians).0
labelsMinOffsetxAny X offset to add to the X coordinate that the minimum label uses.0
labelsMinOffsetyAny Y offset to add to the Y coordinate that the minimum label uses.5
labelsMinUnitsPreUnits which are prepended to the number. If left as null this falls back to the scaleUnitsPre property.null
labelsMinUnitsPostUnits which are appended to the number. If left as null this falls back to the scaleUnitsPost property.null
labelsMinPointThe decimal point separator for the minimum label. If left as null this falls back to the scalePoint property.null
labelsMinThousandThe thousand separator for the minimum label. If left as null this falls back to the scaleThousand property.null
labelsMinDecimalsThe number of decimals that displayed. If left as null this falls back to the scaleDecimals property.null
labelsMaxColorThe color of the maximum label.null
labelsMaxFontThe font of the maximum label.null
labelsMaxBoldWhether the maximum label is bold or not.null
labelsMaxSizeThe size of the maximum label.null
labelsMaxItalicWhether the maximum label is italic or not.null
labelsMaxOffsetAngleAny offset to add to the angle that the maximum label uses (measured in radians).0
labelsMaxOffsetxAny X offset to add to the X coordinate that the maximum label uses.0
labelsMaxOffsetyAny Y offset to add to the Y coordinate that the maximum label uses.5
labelsMaxUnitsPreUnits which are prepended to the number. If left as null this falls back to the scaleUnitsPre property.null
labelsMaxUnitsPostUnits which are appended to the number. If left as null this falls back to the scaleUnitsPost property.null
labelsMaxPointThe decimal point separator for the maximum label. If left as null this falls back to the scalePoint property.null
labelsMaxThousandThe thousand separator for the maximum label. If left as null this falls back to the scaleThousand property.null
labelsMaxDecimalsThe number of decimals that displayed. If left as null this falls back to the scaleDecimals property.null
labelsCenterWhether the center label is displayed or not.true
labelsCenterFontThe font used to draw the center label.null
labelsCenterBoldWhether the center label is bold or not.null
labelsCenterItalicWhether the center label is italic or not.null
labelsCenterSizeThe size of the center label.40
labelsCenterColorThe color of the center label.null
labelsCenterFadeIf true, and you're using the grow effect, this will cause the center label to fade-in after the grow effect has run (but only the first time).false
labelsCenterUnitsPreUnits which are prepended to the number. If left as null this falls back to the scaleUnitsPre property.null
labelsCenterUnitsPostUnits which are appended to the number. If left as null this falls back to the scaleUnitsPost property.null
labelsCenterPointThe decimal point separator for the center label. If left as null this falls back to the scalePoint property.null
labelsCenterThousandThe thousand separator for the center label. If left as null this falls back to the scaleThousand property.null
labelsCenterDecimalsThe number of decimals that displayed. If left as null this falls back to the scaleDecimals property.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: false

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: false

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 the text is bold or not.
Default: false

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

labelsMinColor
The color of the minimum label.
Default: null

labelsMinFont
The font of the minimum label.
Default: null

labelsMinBold
Whether the minimum label is bold or not.
Default: null

labelsMinSize
The size of the minimum label.
Default: null

labelsMinItalic
Whether the minimum label is italic or not.
Default: null

labelsMinOffsetAngle
Any offset to add to the angle that the minimum label uses (measured in radians).
Default: 0

labelsMinOffsetx
Any X offset to add to the X coordinate that the minimum label uses.
Default: 0

labelsMinOffsety
Any Y offset to add to the Y coordinate that the minimum label uses.
Default: 5

labelsMinUnitsPre
Units which are prepended to the number. If left as null this falls back to the scaleUnitsPre property.
Default: null

labelsMinUnitsPost
Units which are appended to the number. If left as null this falls back to the scaleUnitsPost property.
Default: null

labelsMinPoint
The decimal point separator for the minimum label. If left as null this falls back to the scalePoint property.
Default: null

labelsMinThousand
The thousand separator for the minimum label. If left as null this falls back to the scaleThousand property.
Default: null

labelsMinDecimals
The number of decimals that displayed. If left as null this falls back to the scaleDecimals property.
Default: null

labelsMaxColor
The color of the maximum label.
Default: null

labelsMaxFont
The font of the maximum label.
Default: null

labelsMaxBold
Whether the maximum label is bold or not.
Default: null

labelsMaxSize
The size of the maximum label.
Default: null

labelsMaxItalic
Whether the maximum label is italic or not.
Default: null

labelsMaxOffsetAngle
Any offset to add to the angle that the maximum label uses (measured in radians).
Default: 0

labelsMaxOffsetx
Any X offset to add to the X coordinate that the maximum label uses.
Default: 0

labelsMaxOffsety
Any Y offset to add to the Y coordinate that the maximum label uses.
Default: 5

labelsMaxUnitsPre
Units which are prepended to the number. If left as null this falls back to the scaleUnitsPre property.
Default: null

labelsMaxUnitsPost
Units which are appended to the number. If left as null this falls back to the scaleUnitsPost property.
Default: null

labelsMaxPoint
The decimal point separator for the maximum label. If left as null this falls back to the scalePoint property.
Default: null

labelsMaxThousand
The thousand separator for the maximum label. If left as null this falls back to the scaleThousand property.
Default: null

labelsMaxDecimals
The number of decimals that displayed. If left as null this falls back to the scaleDecimals property.
Default: null

labelsCenter
Whether the center label is displayed or not.
Default: true

labelsCenterFont
The font used to draw the center label.
Default: null

labelsCenterBold
Whether the center label is bold or not.
Default: null

labelsCenterItalic
Whether the center label is italic or not.
Default: null

labelsCenterSize
The size of the center label.
Default: 40

labelsCenterColor
The color of the center label.
Default: null

labelsCenterFade
If true, and you're using the grow effect, this will cause the center label to fade-in after the grow effect has run (but only the first time).
Default: false

labelsCenterUnitsPre
Units which are prepended to the number. If left as null this falls back to the scaleUnitsPre property.
Default: null

labelsCenterUnitsPost
Units which are appended to the number. If left as null this falls back to the scaleUnitsPost property.
Default: null

labelsCenterPoint
The decimal point separator for the center label. If left as null this falls back to the scalePoint property.
Default: null

labelsCenterThousand
The thousand separator for the center label. If left as null this falls back to the scaleThousand property.
Default: null

labelsCenterDecimals
The number of decimals that displayed. If left as null this falls back to the scaleDecimals property.
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
scaleDecimalsThis stipulates how many decimal places there are.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
This stipulates how many decimal places there are.
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 meter.An empty string
titleFontThe font that the title is rendered in. If not specified the textFont setting is used.null
titleSizeThe size of the title. If not specified the size is usually 2pt bigger than the textSize setting.null
titleBoldWhether the title is bold or not.true
titleItalicWhether the title is italic or not.false
titleColorThe color of the title.black
title
The title of the meter.
Default: An empty string

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

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

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

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

titleColor
The color of the title.
Default: black

Interactive features properties

PropertyDescriptionDefault
tooltipsAn array, albeit one element only. This is shown when the progress 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 page.null
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
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 bar chart will be adjustable.false
tooltips
An array, albeit one element only. This is shown when the progress is clicked on. Tooltips 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 chart uses.
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

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

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 bar chart will be adjustable.
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)
cleartoThis is used in animations and effects as the default color to use when clearing 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)

clearto
This is used in animations and effects as the default color to use when clearing 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 details of the positive portion of the Meter when it's focused (eg when you hover over it or click on it). It returns:

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

obj.getValue(event)

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. You pass it an event object.

myChart.canvas.onclick = function (e)
{
    var obj   = e.target.__object__;
    var value = obj.getValue(e);
    
    // ...
}
obj.getAngle(value)

This method can be used to retrieve the correct angle (in radians) for the given value.

<script>
    angle = mySCP.getAngle(7);
</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 draw event 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)
    {
        // ...
    }

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