Gauge chart API reference

Summary: Documentation about the Gauge chart including information about all of the options that are available to you. The Gauge chart is a meter type chart that can show a value. It can also show multiple values at once.

• Example
• Properties
• Methods
• Effects

Example

<script>
    new RGraph.Gauge({
        id: 'cvs',
        min: 0,
        max: 100,
        value: 46,
        options: {
            title: 'Bandwidth'
        }
    }).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 shown in the example code above.

• Chart configuration properties
• Background properties
• Margin properties
• Labels and text properties
• Scale properties
• Color properties
• Needle properties
• Title properties
• Shadow properties
• Interactive features properties
• Miscellaneous properties

Chart configuration properties

Margin properties

Background properties

Labels and text properties

<div style="margin-left: 50px; display: inline-block">
    <canvas id="cvs" width="650" height="250"></canvas>
</div>

<div style="margin-left: 50px; display: inline-block">
    <canvas id="cvs" width="650" height="250"></canvas>
</div>

Title properties

Scale properties

Color properties

Shadow properties

Needle properties

Interactive Features properties

Miscellaneous properties

Methods

obj.set(name, value)
An accessor that you can use to set the values of properties.

obj.getValue(event)

This method can be used to get the value at a particular point (eg in a click or other event listener). That value could then be used to set the value of the Gauge. Like this:

myGauge.canvas.onmousedown = function (e)
{
    var obj   = e.target.__object__;
    var value = obj.getValue(e);
    obj.value = value;
    
    obj.grow();
}

This method can be used to get an appropriate angle for a value when you're doing custom drawing on the chart. It returns null if the value is out of range.

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 the function 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:

obj = new RGraph.Gauge({
    id: 'cvs',
    min: 0,
    max: 100,
    value:52,
    options: {
    }
}).on('mousemove', function (e, shape)
{
    // Handle the mousemove event
})
.on('click', function (e, shape)
{
    // Handle the click event
}).draw();

The exec function is documented here.

Animation Effects

• The Grow effect (effects-gauge-grow.html in the download archive

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

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