SemiCircular Progress bar documentation

Share RGraph:  

 

Example

<script>
    new RGraph.SemiCircularProgress({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 84,
        options: {
            textAccessible: true,
            colors: ['Gradient(white:blue)'],
            adjustable: true,
            unitsPost: '%',
            labelsMinSize: 16,
            labelsMaxSize: 16,
            labelsCenterSize: 50
        }
    }).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
centerxYou can use this to stipulate exactly the X coordinate where the chart should appearnull
centeryYou can use this to stipulate exactly the Y coordinate where the chart should appearnull
radiusYou can use this to specify the radius of the chartnull
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...)

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 color of the bar. This can be a solid color, or a gradient that you create. It should be an array consiting 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]
strokestyleThis is the strokestyle used for the inner part of the chart.#999
backgroundColorThe background color (of the entire canvas).rgba(0,0,0,0)

Shadow

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

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>
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 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).false
textFontThe font used to render the text.Segoe UI, Arial, Verdana, sans-serif
textColorThe color of the labels.black
textSizeThe size of the text (in points).10
labelsMinColorThe color of the minimum labelnull (same as textColor)
labelsMinFontThe font of the minimum labelnull (same as textFont)
labelsMinBoldWhether the minimum label is bold or notfalse
labelsMinSizeThe size of the minimum labelnull (same as textSize)
labelsMinItalicWhether the minimum label is italic or notfalse
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 uses0
labelsMinOffsetyAny Y offset to add to the Y coordinate that the minimum label uses0
labelsMaxColorThe color of the maximum labelnull (same as textColor)
labelsMaxFontThe font of the maximum labelnull (same as textFont)
labelsMaxBoldWhether the maximum label is bold or notfalse
labelsMaxSizeThe size of the maximum labelnull (same as textSize)
labelsMaxItalicWhether the maximum label is italic or notfalse
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 uses0
labelsMaxOffsetyAny Y offset to add to the Y coordinate that the maximum label uses0
labelsCenterWhether the center label is displayed or nottrue
labelsCenterFontThe font used to draw the center labelnull (same as textFont)
labelsCenterBoldWhether the center label is bold or notfalse
labelsCenterItalicWhether the center label is italic or notfalse
labelsCenterSizeThe size of the center label40
labelsCenterColorThe color of the center labelblack
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

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
scaleDecimalsThis stipulates how many decimal places there are.0
scalePointThe character used as the decimal point..
scaleThousandThe character used as the thousand separator,

Titles

PropertyDescriptionDefault
titleThe title of the meter.An empty string
titleFontThe font that the title is rendered in. If not specified the textFont setting is usednull
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

Interactive features

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 pagenull
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 bar chart will be adjustable.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

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)
cleartoThis is used in animations and effects as the default color to use when clearing 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 details of the positive portion of the Meter when it's focused (eg when you mouseover 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 n 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, 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 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.SemiCircularProgress({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 56,
        options: {
            gutterLeft: 35
        }
    }).grow({frames: 60}, myCallback);
</script>