Waterfall chart API reference

• Example
• Properties
• Methods
• The coordinates properties
• Events
• Effects

Example

<script>
    new RGraph.Waterfall({
        id: 'cvs',
        data: [90, -16, -18, -34,43,82,53],
        options: {
            marginLeft: 45,
            marginTop: 50,
            title: 'Each salespersons sales/returns totals',
            titleBold: true,
            backgroundGridVlines: false,
            backgroundGridBorder: false,
            yaxis: false,
            marginInner: 20,
            xaxisLabels: ['Olga','Barry','Pete','Helen','Richard','Jill','Molly','Total'],
            backgroundGridVlinesCount: 5,
            tooltips: '<span style="font-size: 14pt">Todays income</span><br/>%{key}',
            tooltipsFormattedUnitsPre: '£',
            tooltipsCss: {
                fontSize: '18pt',
                textAlign: 'left'
            },
            highlightStyle: 'invert',
            highlightStroke:'white',
            responsive: [
                {maxWidth: null, width: 700, height: 300,options: {textSize: 16,titleSize: 22,textSize: 16}},
                {maxWidth: 900, width: 500,  height: 200,options: {textSize: 12,titleSize: 16,textSize: 10}}
            ]
        }
    }).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 above.

• Background properties
• X-axis properties
• Y-axis properties
• Color properties
• Margin properties
• Labels and text properties
• Title properties
• Shadow properties
• Key properties
• Interactive features properties
• Miscellaneous properties

obj.set(
    'backgroundHbars',
    [[75, 10, 'yellow'], [85, 15, 'red']]);

function myFormatter(opt)
{
    var num = Number(opt.number) * 5;

    return String(num)
}
obj.set('yaxisScaleFormatter', myFormatter);

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

labelsAboveFormatter: function (opt)
{
    var obj = opt.object,
        val = opt.value,
        idx = opt.index;
    
    return val;
}

labelsAboveTotalFormatter: function (opt)
{
    var obj = opt.object,
        val = opt.value,
        idx = opt.index;

    return val;
}

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

<script>
    obj.canvas.onclick = function (e)
    {
        RGraph.redraw();
    
        var canvas  = e.target,
            obj     = canvas.__object__,
            shape   = obj.getShape(e);

        if (shape) {
            var x      = shape.x,
                y      = shape.y,
                width  = shape.width,
                height = shape.height;
            
            obj.path(
                'b r % % % % s black f red',
                x, y, width, height
            );
        }
    }
</script>

This method can be used to get an appropriate Y coordinate 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 similarly to the jquery on function. The first argument is the event that you wish to attach to and the second is the handler function. For example:

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

The function is useful if you use method chaining when creating your charts, for example:

var obj = new RGraph.Waterfall({
    id: 'cvs',
    data: [5,8,6,4,3,5],
    options: {
        marginLeft: 55,
        marginInner: 5,
        xaxisLabels: ['Hoolio','Jill','Pete','Kevin','Lucy','John']
    }
}).on('mousemove', function (e, shape)
{
    e.target.style.cursor = 'pointer';
}).on('click', function (e, shape)
{
    // Put your click event code here
}).draw()

The exec function is documented 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.

The coordinates properties

The Waterfall has just two coordinates properties - the obj.coords property and the obj.coordsText property.

• obj.coords This is a record of all of the bars that have been drawn on the chart.
• obj.coordsText This holds the coordinates of all of the text that has been added to the chart. Even if the text is blank (ie no text) then the coordinates will be added to this variable.

Events

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

• annotatebegin This event fires at the start of annotating - like the standard mousedown event.
• annotate This event fires (repeatedly) during annotating - like the standard mousemove event.
• annotateend This event fires at the end of annotating - like the standard mouseup event.
• annotateclear This event fires at the end of the RGraph.clearAnnotations function.
• beforeclear This event fires at the start of the RGraph.clear function.
• clear This event fires at the end of the RGraph.clear function.
• click This is similar to the standard canvas click event but this only fires when you click on a bar - not the whole canvas.
• beforecontextmenu This event fires when you have the contextmenu enabled and it is about to appear.
• contextmenu This event fires when you have the contextmenu enabled and it has been displayed.
• beforedraw This event fires at the start of the draw method before anything has been done.
• firstdraw This event fires at the end of the draw function - but only the first time that the draw function is called.
• draw This event fires at the end of the draw function.
• beforeinteractivekey When you're using the interactive key this event fires just before the key and chart are highlighted.
• afterinteractivekey When you're using the interactive key this event fires just after the key and chart are highlighted.
• keyclick This event fires when you click on the key - you don't have to be using the interactive key however.
• mousemove This event is similar to the standard mousemove event but only fires when you move the mouse over a bar on the chart.
• mouseover This event is similar to the standard mouseover event but only fires when you move the mouse over a bar on the chart.
• mouseout This event is similar to the standard mouseout event but only fires when you move the mouse away from a bar on the chart that you've previously hovered over.
• beforetooltip This event fires at the start of the tooltip showing process.
• tooltip This event fires after a tooltip has been shown.
• beforebackground This event fires before the background (grid, image, bars etc) has been drawn.
• background This event fires after the background (grid, image, bars etc) has been drawn.

new RGraph.Waterfall({
    id: 'cvs',
    data: [4,8,6,3,5,8,9],
    options: {
    }
}).on('draw', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();

Effects

There's a stopAnimation() function that you can use to stop an animation immediately if you need to. There's a line chart demo called demos/line-effects-stop-animation.html in the download archive that demonstrates the use of this function.

• The grow effect (effects-waterfall-grow.html in the download archive)

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

    var obj = new RGraph.Waterfall({
        id: 'cvs',
        data: [8,5,6,26,-5,-5,-4,-8,7],
        options: {
            marginLeft: 35,
            marginInner: 5
        }
    }).grow({frames: 60}, myCallback)
</script>