Waterfall chart API reference

• Example
• The coordinates properties
• Properties
• Methods
• Data properties that are used on the bars
• Events
• Effects

Example

<script>
    data = [59,15,-50,-68,20,4,7];
    
    function getDay (index)
    {
        var days = ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday','Total'];
        
        // Add a crlf
        if (index % 2 === 1) {
            days[index] = '\r\n' + days[index];
        }

        return days[index];
    }
    
    function trim (str)
    {
        return str.trim();
    }

    waterfall = new RGraph.SVG.Waterfall({
        id: 'chart-container',
        data: data,
        options: {
            yaxisScaleMin: 'mirror',
            xaxisLabels: '%{function:getDay(%{index})}',
            xaxisColor: 'gray',
            yaxis: false,
            labelsAbove: true,
            labelsAboveUnitsPost: '%',
            labelsAboveLastBold: true,
            tooltips: '%{function:trim("%{property:xaxisLabels[%{index}]}")}: <br />%{key}',
            tooltipsFormattedKeyLabels: ['Incoming', 'Outgoing','Total'],
            tooltipsFormattedUnitsPost: 'm',
            colors: ['black','red','blue'],
            backgroundGridVlines: false,
            backgroundGridBorder: false,
            yaxisScaleMax: 100,
            marginBottom: 50,
            marginLeft: 40,
            marginInner: 10,
            labelsAboveSize: 12,
            textSize: 12,
            tooltipsCss: {
                backgroundColor: '#333',
                fontWeight: 'bold',
                fontSize: '14pt',
                opacity: 0.85
            }
        }
    }).draw();
</script>

The coordinates properties

The coordinates of the bars on the Waterfall chart are held in the obj.coords array. Each element in the array is an object that consists of these properties:

• object - A reference to the chart object
• element - A reference to the svg rect element
• x - The x-axis coordinate for the bar
• y - The y-axis coordinate for the bar
• width - The width of the bar
• height - The height of the bar

So you could, for example, use this to get the width of the first bar on the chart:

obj.coords[0].width

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
• Margin properties
• Color properties
• X-axis properties
• Y-axis properties
• Other text properties
• Tooltip properties
• Shadow properties
• Key properties
• Title properties
• Other properties

yaxisFormatter: 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;
}

tooltips: {
    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 method can be used to get an appropriate y-axis coordinate for a value when you're doing custom drawing on the chart. It returns null if the value is out of range.

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.

Data properties that are used on the bars

The svg elements that represent the bars on the Waterfall chart have various data attributes added to them that hold various bits of information. These are:

• data-index
• data-original-x
• data-original-y
• data-original-width
• data-original-height
• data-original-stroke
• data-original-fill
• data-value

These can be retrieved by using standard dom methods:

obj.coords[0].element.getAttribute('data-index');

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.Waterfall({
    id: 'chart-container',
    data: [1,5,6,-4,2,5,-3,5],
    options: {
    }
}).on('tooltip', function (obj)
{
    console.log('The draw event has fired');
    
}).draw();

Effects

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

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

    obj = new RGraph.SVG.Waterfall({
        id: 'chart-container',
        data: [3,4,7,-5,6,-9,8],
        options: {
        }
    }).grow({frames: 60, callback: myCallback});
</script>