SemiCircular Progress bar documentation

Recommend RGraph:  
    Read comments...

 

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.

 

Chart configuration

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

 

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 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.
Default: [#0c0]

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

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

 

Shadow

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

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

textFont
The font used to render the text.
Default: Segoe UI, Arial, Verdana, sans-serif

textColor
The color of the labels.
Default: black

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

labelsMinColor
The color of the minimum label
Default: null (same as textColor)

labelsMinFont
The font of the minimum label
Default: null (same as textFont)

labelsMinBold
Whether the minimum label is bold or not
Default: false

labelsMinSize
The size of the minimum label
Default: null (same as textSize)

labelsMinItalic
Whether the minimum label is italic or not
Default: false

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

labelsMaxColor
The color of the maximum label
Default: null (same as textColor)

labelsMaxFont
The font of the maximum label
Default: null (same as textFont)

labelsMaxBold
Whether the maximum label is bold or not
Default: false

labelsMaxSize
The size of the maximum label
Default: null (same as textSize)

labelsMaxItalic
Whether the maximum label is italic or not
Default: false

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

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

labelsCenterFont
The font used to draw the center label
Default: null (same as textFont)

labelsCenterBold
Whether the center label is bold or not
Default: false

labelsCenterItalic
Whether the center label is italic or not
Default: false

labelsCenterSize
The size of the center label
Default: 40

labelsCenterColor
The color of the center label
Default: black

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

 

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

 

Titles

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

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

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

 

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)

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

Comments