Waterfall charts documentation

 

Example

<script>
    var waterfall = new RGraph.Waterfall({
        id: 'cvs',
        data: [90, -16, -18, -34],
        options: {
            labels: ['Sales','Bills','Expenses','Stock','Gross profit'],
            backgroundGridAutofitNumvlines: 5
        }
    }).draw();
</script>

The example file is here.

 

Properties

You can use these properties to control how the chart apears. You can set them by including them in the options section of the configuration as above.

Layout style:     
  

Background

PropertyDescriptionDefault
backgroundBarcolor1The color of the background bars, (1 of 2).white
backgroundBarcolor2The color of the background bars, (2 of 2).white
backgroundGridWhether to show the background grid or not.true
backgroundGridColorThe color of the background grid.#ddd
backgroundGridHsizeThe horizontal background grid size.40
backgroundGridVsizeThe vertical background grid size.18
backgroundGridWidthThe 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
backgroundGridAutofitInstead of specifying a pixel width/height for the background grid, you can use autofit and specify how many horizontal and vertical lines you want.false
backgroundGridAutofitNumhlinesWhen using autofit this allows you to specify how many horizontal grid lines you want.7
backgroundGridAutofitNumvlinesWhen using autofit this allows you to specify how many vertical grid lines you want.20
backgroundGridAutofitAlignIf you want to have your grid lines line up with the labels (both X and Y axis), you can set this to true and RGraph will attempt to make the grid lines line up. If you have a hmargin set then the alignment will be thrown out.false
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('hbars', [[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
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
backgroundColorIf you want to have a single background color for your chart you can use this. It doesn't cover the gutters. If you want that then you can simply apply a CSS background color to the canvas tag.null

Axis properties

PropertyDescriptionDefault
axisColorThe color of the axis.black
axisLinewidthThe linewidth of the axes.1
noaxesWhether the axes are drawnfalse (the axes ARE drawn)
noxaxisSet this to true if you don't want a X axis.false
noyaxisSet this to true if you don't want a Y axis.false
xaxisposThis 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 ymax and ymin properties.bottom

Colors

PropertyDescriptionDefault
strokestyleThe color of the outline of the bars.#666
colorsAn array of the colors of the actual bars.['green', 'red', 'blue']

Margins

PropertyDescriptionDefault
hmarginThe horizontal margin (in pixels) of the chart.5
gutterLeftThe left gutter of the chart, (the gutter is where the labels and title are)).25
gutterRightThe right gutter of the chart, (the gutter is where the labels and title are).25
gutterTopThe top gutter of the chart, (the gutter is where the labels and title are).25
gutterBottomThe bottom gutter of the chart, (the gutter is where the labels and title are).25

Labels and text

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 gutters 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 color of the labels.black
textSizeThe size (in points) of the labels.10
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)
textFontThe font used to render the text.Arial
labelsAn array of the labels to be used on the chart.An empty array
labelsColorThe color of the labelsnull (same as textColor)
labelsBoldWhether the labels are bold or notfalse
labelsOffsetxThis allows you finer grained control in the horizontal direction over the X label positioning if you need it.0
labelsOffsetyThis allows you finer grained control in the vertical direction over the X label positioning if you need it.0
ylabelsCan be true or false and determines whether the chart has Y axis labels.true
labelsCountThis determines how many Y scale labels are shown.true
ylabelsOffsetxThis allows you finer grained control in the horizontal direction over the Y label positioning if you need it.0
ylabelsOffsetyThis allows you finer grained control in the vertical direction over the Y label positioning if you need it.0
numyticksThe number of Y tickmarks. If you have changed the number of Y labels, you may also want to change this to match.10

Titles

PropertyDescriptionDefault
titleThe title of the chart, if any.null
titleFontThe font that the title is rendered in. If not specified the text.font setting is used (usually Arial)null
titleSizeThe size of the title. If not specified the size is usually 2pt bigger than the text.size setting.null
titleBoldWhether the title is bold or not.true
titleItalicWhether the title is italic or not.false
titleBackgroundThe background color (if any) for the title.null
titleColorThe color of the title.black
titleXTo give the exact X coordinate for the title - use thisnull
titleYTo give the exact Y coordinate for the title - use thisnull
titleXaxisThis allows to specify a title for the X axis.none
titleXaxisSizeThis allows you to specify a size for the X axis title.null
titleXaxisFontThis allows to specify a font for the X axis title.null
titleXaxisBoldThis controls whether the X axis title is bold or not.true
titleXaxisColorThis controls the color of the X axis title.black
titleXaxisXBy giving this you can specifically set the X position of the X axis titlenull
titleXaxisYBy giving this you can specifically set the Y position of the X axis titlenull
titleYaxisXBy giving this you can specifically set the X position of the Y axis titlenull
titleYaxisYBy giving this you can specifically set the Y position of the Y axis titlenull
titleYaxisThis allows to specify a title for the Y axis.none
titleYaxisSizeThis allows you to specify a size for the Y axis title.null
titleYaxisFontThis allows to specify a font for the Y axis title.null
titleYaxisBoldThis controls whether the Y axis title is bold or not.true
titleYaxisColorThis controls what color the Y axis is.black
titleXaxisPosThis is multiplied with the gutter to give the position of the X axis title.0.25
titleYaxisPosThis is multiplied with the gutter to give the position of the Y axis title.0.25
titleYaxisAlignInstead of using the option above you can instead use this option, specifying left or right.left

Shadow

PropertyDescriptionDefault
shadowWhether a drop shadow is applied.false
shadowColorThe color 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

Scale

PropertyDescriptionDefault
scaleDecimalsThe number of decimal places to display for the Y scale.0
scalePointThe character used as the decimal point..
scaleThousandThe character used as the thousand separator,
scaleFormatterTo allow 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
scaleZerostartWhether to start the scale at zero or nottrue
unitsPreThe units that the Y axis is measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50".none
unitsPostThe units that the Y axis is measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms".none
ymaxThe optional maximum Y scale value. If not specified then it will be calculated.null (It's calculated)
yminThis 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 axis0

Interactive features

PropertyDescriptionDefault
contextmenuAn array of context menu items. More information on 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 pagenull
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 tooltip 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 color 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
annotateColorIf you do not allow the use of the palette, then this will be the only colour allowed for annotations.black
annotateLinewidthThis 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
resizeHandleBackgroundWith this you can specify the background color 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
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

Zoom

PropertyDescriptionDefault
zoomFactorThis is the factor that the chart will be zoomed by (bigger values means more zoom)1.5
zoomFadeInWhether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.true
zoomFadeOutWhether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.true
zoomHdirThe horizontal direction of the zoom. Possible values are: left, center, rightright
zoomVdirThe vertical direction of the zoom. Possible values are: up, center, downdown
zoomDelayThe delay (in milliseconds) between frames.50
zoomFramesThe number of frames in the zoom animation.10
zoomShadowWhether or not the zoomed canvas has a shadow or not.true

Events

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

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. Its 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)
axisColorThe color of the axis.black
cleartoThis is used in animations and effects as the default color to use when clearing the canvas.null

 

Methods

 

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

 

obj.set(name, value)
An accessor that you can use to set the value 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, func)

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:

var obj = new RGraph.Waterfall('cvs', [5,8,6,4,3,5])
    .set('gutterLeft', 55)
    .set('hmargin', 5)
    .set('labels', ['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: {
            gutterLeft: 35,
            hmargin: 5
        }
    }).grow({frames: 60}, myCallback)
</script>
RGraph on social media