Semi-circular Progress bar API reference

• Example
• The obj.coords property
• The obj.nodes property
• Properties
• Methods
• Events
• Effects

Example

<script>
    scp = new RGraph.SVG.SemiCircularProgress({
        id: 'chart-container',
        min: 0,
        max: 200,
        value: [50,30,60],
        options: {
            colors: ['rgba(0,255,0,0.25)',
                'rgba(255,0,0,0.25)',
                'rgba(255,255,0,0.25)'
            ],
            marginRight: 75,
            marginLeft: 75,
            marginTop: 50,
            scale: true,
            backgroundColor: '#E8FAE8',
            backgroundColorOpacity: 1,
            backgroundGrid: true,
            scaleLabelsSize: 10,
            scaleLabelsCount: 20,
            scaleUnitsPost: '%',
            backgroundGridRadialsCount: 20,
            labelsCenterUnitsPost: '%',
            labelsCenterDecimals: 1,
            tooltips: 'Amount: %{value_formatted} boxes',
            tooltipsCss: {
                fontSize: '20pt',
                fontWeight: 'bold'
            }
        }
    }).draw();
</script>

The obj.coords property

The obj.coords array is new for version 6.05 and provides an alternative to the obj.nodes properties - being more like the canvas way of storing coordinates to shapes. The object is an array of objects which each contain the details of the segments that are drawn on the chart. If you want to, you can replay these coordinates by using the RGraph api method RGraph.SVG.TRIG.getArcPath3 and then using the resulting path as the argument when you create a path node, like this:

// Create the outer arc path
var arcPath1 = RGraph.SVG.TRIG.getArcPath3({
    cx:     scp.coords[0].cx,
    cy:     scp.coords[0].cy,
    radius: scp.coords[0].radiusOuter,
    start:  scp.coords[0].start,
    end:    scp.coords[0].end,
    anticlockwise: false,
    lineto:false
});

// Crete the inner arc path
var arcPath2 = RGraph.SVG.TRIG.getArcPath3({
    cx:     scp.coords[0].cx,
    cy:     scp.coords[0].cy,
    radius: scp.coords[0].radiusInner,
    start:  scp.coords[0].end,
    end:    scp.coords[0].start,
    anticlockwise: true,
    lineto: true
});

// Now create an SVG path object out of the two paths created above
var path = scp.create('path', null, {
    d: '{1} {2} z'.format(arcPath1, arcPath2),
    stroke: 'black',
    fill: 'transparent'
});

The obj.nodes property

As well as coordinates, the Semi-circular Progress mmeter aintains references to the nodes that are created - such as the bar, the background and text nodes. For example:

• obj.nodes.background
• obj.nodes.bar
• obj.nodes.labelsCenter
• obj.nodes.labelsMax
• obj.nodes.labelsMin

You could, for example, add your own event listeners like this:

<script>
    obj.nodes.labelsCenter.onclick = function (e)
    {
        alert('The value is: ' + scp.value);
    }

    obj.nodes.labelsCenter.onmousemove = function (e)
    {
        e.target.style.cursor = 'pointer';
    }
</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 shown above.

• Chart configuration properties
• Margin properties
• Background properties
• Color properties
• Labels and text properties
• Scale properties
• Title properties
• Tooltip properties
• Highlight properties
• Other properties

labelsMinFormatter: function (obj, num)
{
}

labelsMaxFormatter: function (obj, num)
{
}

labelsCenterFormatter: function (obj, num)
{
}

tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}

tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}

tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]

.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}

tooltipsPointerCss: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}

Methods

This can be used to get properties if necessary. It's normally used after the chart is drawn if you need to get parameters (if you're doing custom coding for example).

This can be used to set properties if necessary. It's normally used after the chart is drawn if you need to set additional parameters or change them.

This function adds an event listener (such as beforedraw or draw) to the chart object. For example:

obj.on('draw', function (obj)
{
    // Put your code here
});

This function can be used to execute a function (immediately). It's not event-based (ie it doesn't run when something happens) - it just runs immediately - and only once. You might use it when you need to get something from the chart when it's drawn and then call the RGraph.SVG.redraw function. Because this function only runs once the RGraph.SVG.redraw function would not cause a loop - which would happen if you used the draw event.

obj.exec(function (obj)
{
    // Put your code here
});

The responsive function helps your charts respond to different browser window sizes and screen resolutions. For example, for smaller screens, you might want to have angled labels or show shorter versions of them completely.

Update: There is now the responsive configuration option available to you and this is now the preferred method of configuration.

The responsive function and configuration option are documented on their own page here.

Events

RGraph supports custom events that allow you to easily add interactivity to your charts if required. The following events are available:

• beforedraw This event fires at the start of the draw method before anything has been done.
• draw This event fires at the end of the draw function.
• firstdraw This event fires at the end of the draw function - but only the first time and so it fires only once after the first draw call.
• beforetooltip This event fires at the start of the tooltip showing process.
• tooltip This event fires after a tooltip has been shown.

new RGraph.SVG.SemiCircularProgress({
    id: 'chart-container',
    min: 0,
    max: 100,
    value:50,
    options: {
    }
}).on('tooltip', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();

Effects

• The grow effect (demo available in the download archive)

<script>
    //
    // Optional callback function that's called when the effect is complete
    //
    function myCallback (obj)
    {
        // ...
    }

    new RGraph.SVG.SemiCircularProgress({
        id: 'chart-container',
        min: 0,
        max: 100,
        value: 84.99,
        options: {
            colors: ['Gradient(#faa:pink)'],
            labelsCenterUnitsPre: '$',
            labelsCenterDecimals: 2
        }
    }).grow({frames: 60, callback: myCallback});
</script>