Waterfall chart API reference

Documentation about the Waterfall chart including information about all of the options that are available to you. Waterfall charts can be used to show the increase or decrease of a quantity over a period of time or as a result of a series of events.

Example

<script>
    new RGraph.Waterfall({
        id: 'cvs',
        data: [90, -16, -18, -34],
        options: {
            xaxisLabels: ['Sales','Bills','Expenses','Stock','Gross profit'],
            backgroundGridVlinesCount: 5
        }
    }).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

PropertyDescriptionDefault
backgroundBarsCountThe number of background bars.5
backgroundBarsColor1The colour of the background bars, (1 of 2).white
backgroundBarsColor2The colour of the background bars, (2 of 2).white
backgroundGridWhether to show the background grid or not.true
backgroundGridColorThe colour of the background grid.#ddd
backgroundGridLinewidthThe width that the background grid lines are. Decimals (eg 0.5) are permitted.1
backgroundGridBorderDetermines whether a border line is drawn around the grid.true
backgroundGridHlinesDetermines whether to draw the horizontal grid lines.true
backgroundGridVlinesDetermines whether to draw the vertical grid lines.true
backgroundGridHlinesCountWhen using autofit this allows you to specify how many horizontal grid lines you want.7
backgroundGridDottedIf you want to have your background grid dashed then set this to true.false
backgroundGridDashedIf you want to have your background grid dotted then set this to true. This takes precedence over dashed lines.false
backgroundHbarsAn array of information stipulating horizontal coloured bars. You can use these to indicate limits. Eg: myBar.set('backgroundHbars', [[75, 10, 'yellow'], [85, 15, 'red']]); This would give you two bars, one red and a lower yellow bar. The units correspond to your scale, and are the starting point and the height.null
backgroundColorIf you want to have a single background colour for your chart you can use this. It doesn't cover the margins. If you want that then you could alternatively simply apply a CSS background colour to the canvas tag.null
backgroundImageIf you want to specify a background image to use on your chart, specify it with this property.null
backgroundImageStretchIf you want to specify a background image to use on your chart, specify it with this property.null
backgroundImageAlignThe alignment of the background image. This is a string that can contain the words: top bottom left right.top left
backgroundImageXIf you want to you can specify the X coordinate of the image.null
backgroundImageYIf you want to you can specify the Y coordinate of the image.null
backgroundImageWIf you want to you can specify the width of the image.null
backgroundImageHIf you want to you can specify the height of the image.null

General axis properties

PropertyDescriptionDefault
axesWhether the axes are drawn.true
axesColorThe colour of the axis.black
axesLinewidthThe linewidth of the axes.1

X axis properties

PropertyDescriptionDefault
xaxisSet this to true if you don't want an X axis.true
xaxisPositionThis determines where the X axis is positioned. If you wish to show negative values then you should set this to center OR you can now (Jul 2016) use an offset X axis by leaving this property at the default bottom and using the yaxisScaleMax and yaxisScaleMin properties.bottom
xaxisLabelsAn array of the labels to be used on the chart.An empty array
xaxisLabelsFontThe font used to render the labels.null
xaxisLabelsSizeThe size of the labels.null
xaxisLabelsColorThe colour of the labels.null
xaxisLabelsBoldWhether the labels are bold or not.null
xaxisLabelsItalicWhether the labels are italic or not.null
xaxisLabelsOffsetxThis allows you finer grained control in the horizontal direction over the X label positioning if you need it.0
xaxisLabelsOffsetyThis allows you finer grained control in the vertical direction over the X label positioning if you need it.0
xaxisTitleThis allows you to specify a title for the X axis.none
xaxisTitleSizeThis allows you to specify a size for the X axis title.null
xaxisTitleFontThis allows you to specify a font for the X axis title.null
xaxisTitleBoldThis controls whether the X axis title is bold or not.null
xaxisTitleItalicThis controls whether the X axis title is italic or not.null
xaxisTitleColorThis controls the colour of the X axis title.null
xaxisTitleXBy giving this you can specifically set the X position of the X axis title.null
xaxisTitleYBy giving this you can specifically set the Y position of the X axis title.null
xaxisTitlePosThis is a multiplier (ie a digit usually between 0 and 1) that gets multiplied with the margin to get the Y position of the title.null

Y axis properties

PropertyDescriptionDefault
yaxisSet this to true if you don't want a Y axis.true
yaxisTitleXBy giving this you can specifically set the X position of the Y axis title.null
yaxisTitleYBy giving this you can specifically set the Y position of the Y axis title.null
yaxisTitleThis allows you to specify a title for the Y axis.none
yaxisTitleSizeThis allows you to specify a size for the Y axis title.null
yaxisTitleFontThis allows you to specify a font for the Y axis title.null
yaxisTitleBoldThis controls whether the Y axis title is bold or not.null
yaxisTitleItalicWhether the Y axis title is italic or not.null
yaxisTitleColorThis controls what colour the Y axis is.null
yaxisTitlePosThis is multiplied with the margin to give the position of the Y axis title.0.25
yaxisTitleAlignInstead of using the option above you can instead use this option, specifying left or right.left
yaxisLabelsWhether the Y axis labels are shown or not.true
yaxisLabelsCountThis determines how many Y scale labels are shown.true
yaxisLabelsOffsetxThis allows you finer grained control in the horizontal direction over the Y label positioning if you need it.0
yaxisLabelsOffsetyThis allows you finer grained control in the vertical direction over the Y label positioning if you need it.0
yaxisLabelsFontThe font family used to render the labels.null
yaxisLabelsSizeThe size of the Y axis labels.null
yaxisLabelsColorThe colour of the Y axis labels.null
yaxisLabelsBoldWhether the Y axis labels are bold or not.null
yaxisLabelsItalicWhether the Y axis labels are italic or not.null
yaxisTickmarksCountThe number of Y tick marks. If you have changed the number of Y labels, you may also want to change this to match.10
yaxisScaleCan be true or false and determines whether the chart has Y axis labels.true
yaxisScaleMaxThe optional maximum Y scale value. If not specified then it will be calculated.null (It's calculated)
yaxisScaleMinThis can be used when using an offset Y axis to specify the minimum value. Leave the xaxispos at the default bottom setting when you want an offset Y axis. For example you could set the yaxisScaleMax setting to 4000 and this to -1000.0
yaxisScaleUnitsPreThe units (if any) that the Y axis is measured in (these are prepended to the number).none
yaxisScaleUnitsPostThe units (if any) that the Y axis is measured in (these are appended to the number).none
yaxisScaleZerostartWhether the scale starts at zero or not.true
yaxisScaleThousandThe character used as the thousand separator.,
yaxisScalePointThe character used as the decimal point..
yaxisScaleDecimalsThe number of decimal places to display for the Y scale.0
yaxisScaleFormatterTo allow thoroughly custom formats of numbers in the scale, you can use this option to specify a function that is used by RGraph to format numbers. This function should handle ALL of the formatting. Eg:

function myFormatter(obj, num)
{
    return num + 'F'; // An example of formatting
}
myGraph.set('scale.formatter', myFormatter);
null

Colour properties

PropertyDescriptionDefault
colorsAn array of the colours of the actual bars.['green', 'red', 'blue']
colorsStrokeThe colour of the outline of the bars.#666
colorsSequentialSet this to true if you want the colours to be used in a sequential fashion.false

Margin properties

PropertyDescriptionDefault
hmarginThe horizontal margin (in pixels) of the chart.5
marginLeftThe left margin of the chart, (the margin is where the labels and title are)).25
marginRightThe right margin of the chart, (the margin is where the labels and title are).25
marginTopThe top margin of the chart, (the margin is where the labels and title are).25
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).25

Other labels properties

PropertyDescriptionDefault
textAccessibleA new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:
<div style="margin-left: 50px; display: inline-block">
<canvas id="cvs" width="650" height="250"></canvas>
</div>
true
textAccessibleOverflowThis can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish.visible
textAccessiblePointereventsThis controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).true
textColorThe colour of the text on the chart.black
textSizeThe size of the text on the chart.12
textFontThe font used to render the text on the chart.Arial, Verdana, sans-serif
textBoldWhether the text on the chart is bold or not.false
textItalicWhether the text on the chart is italic or not.false
textAngleThe angle of the horizontal text labels (at the bottom of the chart). This can be one of three values - 0, 45 or 90.0 (Horizontal)
labelsAboveWhether the labelsAbove labels are enabled. These sit just above the bars (or below them if the bars are negative).false
labelsAboveFontThe font to use when rendering the labelsAbove text.null
labelsAboveSizeThe size of the labelsAbove text.null
labelsAboveColorThe colour of the labelsAbove text. This can be either a string defining a single colour or an array of three strings - one for the up colour, one for the down colour and one for the total colour.null
labelsAboveBoldWhether the labelsAbove labels are bold or not.null
labelsAboveItalicWhether the labelsAbove labels are italic or not.null
labelsAboveUnitsPreA string that is appended to the number.(An empty string)
labelsAboveUnitsPostA string that is prepended to the number.(An empty string)
labelsAboveDecimalsThe number of decimals that are displayed.0
labelsAbovePointThis can be a character (or multiple characters) that is to be used as the decimal separator in the labels..
labelsAboveThousandThis can be a character (or multiple characters) that is to be used as the thousand separator in the labels.,
labelsAboveFormatterThis can be a a function that handles the formatting of the numbers. eg:
labelsAboveFormatter: function (opt)
{
var obj = opt.object,
val = opt.value,
idx = opt.index;

return val;
}
null
labelsAboveSpecificIf you don't want numbers to appear above the bars but instead want to specify your own text you can do so using this property. It should be an array of strings that you want to use as the labels.null
labelsAboveOffsetxIf you want to alter the position of the labels in the horizontal direction you can use this property.0
labelsAboveOffsetyIf you want to alter the position of the labels in the vertical direction you can use this property. This value is negatived for values below zero - so if you specify the Y offset to be 10 then labels for both positive AND negative bars will be moved away from the bar (ie upwards for positive values and downwards for negative values).0
labelsAboveTotalFontThe font to use when rendering the final labelsAbove label.null
labelsAboveTotalSizeThe size of the final labelsAbove label.null
labelsAboveTotalColorThe colour of the final labelsAbove label. This can be either a string defining a single colour or an array of two strings - one for the up colour, one for the down colour.null
labelsAboveTotalBoldWhether the final labelsAbove label is bold or not.null
labelsAboveTotalItalicWhether the fnal labelsAbove label is italic or not.null
labelsAboveTotalDecimalsThe number of decimals that are displayed on the final label.null
labelsAboveTotalUnitsPreA string that is appended to the number on the final labelsAbove label.null
labelsAboveTotalUnitsPostA string that is prepended to the number on the final labelsAbove label.null
labelsAboveTotalPointThis can be a character (or multiple characters) that is to be used as the decimal separator in the final label.null
labelsAboveTotalThousandThis can be a character (or multiple characters) that is to be used as the thousand separator in the final label.null
labelsAboveTotalFormatterThis can be a a function that handles the formatting of the final number. eg:
labelsAboveTotalFormatter: function (opt)
{
var obj = opt.object,
val = opt.value,
idx = opt.index;

return val;
}
null

Title properties

PropertyDescriptionDefault
titleThe title of the chart, if any.null
titleFontThe font that the title is rendered in. If not specified the textFont setting is used (usually Arial).null
titleSizeThe size of the title. If not specified the size is usually 2pt bigger than the textSize setting.null
titleColorThe colour of the title.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleBackgroundThe background colour (if any) for the title.null
titleXTo give the exact X coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null
titleYTo give the exact Y coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null

Shadow properties

PropertyDescriptionDefault
shadowWhether a drop shadow is applied.false
shadowColorThe colour of the shadow.#666
shadowOffsetxThe X offset of the shadow.3
shadowOffsetyThe Y offset of the shadow.3
shadowBlurThe severity of the shadow blurring effect.3

Key properties

The key properties are documented on the key documentation page.

Interactive features properties

PropertyDescriptionDefault
contextmenuAn array of context menu items. More information about context menus is here.[] (An empty array)
tooltipsA numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.null
tooltipsEffectThe effect used for showing tooltips. Can be either fade or none.fade
tooltipsEventThis is the event that triggers the tooltips. It can be either onclick or onmousemove.onclick
tooltipsCssClassThis is the name of the CSS class the chart uses.RGraph_tooltip
tooltipsOverrideIf you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more information on the tooltips documentation page.null
tooltipsNohideonclearNot an option that you'll need particularly often if at all. Setting this to true means that when you call the RGraph.clear() API function tooltips DO NOT get hidden.false
crosshairsIf true, you will get a crosshair centering on the current mouse position.false
crosshairsLinewidthThis controls the linewidth of the crosshairs.1
crosshairsColorThe colour of the crosshairs.#333
crosshairsHlinesThis determines whether the horizontal crosshair is shown.true
crosshairsVlinesThis determines whether the vertical crosshair is shown.true
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotatableColorIf you do not allow the use of the palette, then this will be the only colour allowed for annotations.black
annotatableLinewidthThis is the line width of the annotations.1
resizableDefaulting to false, this determines whether your chart will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).false
resizableHandleBackgroundWith this you can specify the background colour for the resize handle. If you're adjusting the position of the handle then you may need this to make the handle stand out more.null
resizableMinwidthThis allows you to set a minimum width that the chart can be resized to.null
resizableMinheightThis allows you to set a minimum height that the chart can be resized to.null
resizableMaxwidthThis allows you to set a maximum width that the chart can be resized to.null
resizableMaxheightThis allows you to set a maximum height that the chart can be resized to.null

Event properties

PropertyDescriptionDefault
eventsClickIf you want to add your own onclick function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own onmousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own onmouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own onmouseout function you can do so by assigning it to this property. See here for details.null

Miscellaneous properties

PropertyDescriptionDefault
highlightStyleBy default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument.null
highlightStrokeIf you use tooltips, this controls the colour of the highlight stroke.black
highlightFillIf you use tooltips, this controls the colour of the highlight fill.rgba(255,255,255,0.5)
barOffsetxThis is the positioning offset that is applied to the bars (in the horizontal direction). By using this property you can achieve a dual dataset Waterfall chart as in this demo: waterfall-dual-dataset.html.0
barOffsetyThis is the positioning offset that is applied to the bars (in the vertical direction).0
linewidthThis is linewidth used for the stroke around the bars.1
cleartoThis is used in animations and effects as the default colour to use when clearing the canvas.null

Methods

obj.get(name)
An accessor that you can use to retrieve the values of properties.

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

obj.getShape(event)

This method returns details of the focused bar (if any). It provides:

The shape also includes textual indexes like this: shape['object'] And they are:

obj.getYCoord(value)

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.

obj.on(event, function)

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 you wish to attach 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, for example:

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

The exec function is documented here.

Animation effects

These effects are available and can be used instead of the draw() function. There are also generic effects available which you can see here: Generic effects and transitions
<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,
            hmargin: 5
        }
    }).grow({frames: 60}, myCallback)
</script>