SVG Semi-circular Progress bar API reference

Documentation about the SVG Semi-circular Progress bar including information about all of the options and methods that are available to you.

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

Example

The code below produces a chart like this:

<script>
    new RGraph.SVG.SemiCircularProgress({
        id: 'chart-container',
        min: 0,
        max: 100,
        value:50,
        options: {
            labelsCenterDecimals: 1,
            tooltips: 'Progress: %{value}%',
            tooltipsCss: {
                backgroundColor: '#333',
                fontWeight: 'bold',
                fontSize: '14pt',
                opacity: 0.85
            }
        }
    }).draw();
</script>

The obj.nodes property

Instead of coordinates the Semi-circular Progress maintains 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 is shown above.

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

Chart configuration properties

Margin properties

Background properties

Color properties

Labels and text properties

scaleFormatter: function (obj, num)
{
}

labelsMinFormatter: function (obj, num)
{
}

labelsMaxFormatter: function (obj, num)
{
}

labelsCenterFormatter: function (obj, num)
{
}

scaleFormatter: function (obj, num)
{
}

labelsMinFormatter: function (obj, num)
{
}

labelsMaxFormatter: function (obj, num)
{
}

labelsCenterFormatter: function (obj, num)
{
}

Title properties

Tooltip properties

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

tooltipsFormattedKeyColorsCss : {
    border: "1 px 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;
}

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

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

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

tooltipsFormattedKeyColorsCss : {
    border: "1 px 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;
}

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

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

Highlight properties

Other properties

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

The responsive() function is documented on its 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>