Waterfall charts documentation

  Read comments...

 

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.

 

Background

backgroundBarcolor1
The color of the background bars, (1 of 2).
Default: white

backgroundBarcolor2
The color of the background bars, (2 of 2).
Default: white

backgroundGrid
Whether to show the background grid or not.
Default: true

backgroundGridColor
The color of the background grid.
Default: #ddd

backgroundGridHsize
The horizontal background grid size.
Default: 40

backgroundGridVsize
The vertical background grid size.
Default: 18

backgroundGridWidth
The width that the background grid lines are. Decimals (eg 0.5) are permitted.
Default: 1

backgroundGridBorder
Determines whether a border line is drawn around the grid.
Default: true

backgroundGridHlines
Determines whether to draw the horizontal grid lines.
Default: true

backgroundGridVlines
Determines whether to draw the vertical grid lines.
Default: true

backgroundGridAutofit
Instead of specifying a pixel width/height for the background grid, you can use autofit and specify how many horizontal and vertical lines you want.
Default: false

backgroundGridAutofitNumhlines
When using autofit this allows you to specify how many horizontal grid lines you want.
Default: 7

backgroundGridAutofitNumvlines
When using autofit this allows you to specify how many vertical grid lines you want.
Default: 20

backgroundGridAutofitAlign
If 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.
Default: false

backgroundGridDotted
If you want to have your background grid dashed then set this to true.
Default: false

backgroundGridDashed
If you want to have your background grid dotted then set this to true. This takes precedence over dashed lines.
Default: false

backgroundHbars
An 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.
Default: null

backgroundImage
If you want to specify a background image to use on your chart, specify it with this property.
Default: null

backgroundImageStretch
If you want to specify a background image to use on your chart, specify it with this property.
Default: null

backgroundImageAlign
The alignment of the background image. This is a string that can contain the words: top bottom left right.
Default: top left

backgroundImageX
If you want to you can specify the X coordinate of the image.
Default: null

backgroundImageY
If you want to you can specify the Y coordinate of the image.
Default: null

backgroundImageW
If you want to you can specify the width of the image.
Default: null

backgroundImageH
If you want to you can specify the height of the image.
Default: null

backgroundColor
If 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.
Default: null

 

Axis properties

axisColor
The color of the axis.
Default: black

axisLinewidth
The linewidth of the axes.
Default: 1

noaxes
Whether the axes are drawn
Default: false (the axes ARE drawn)

noxaxis
Set this to true if you don't want a X axis.
Default: false

noyaxis
Set this to true if you don't want a Y axis.
Default: false

xaxispos
This 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.
Default: bottom

 

Colors

strokestyle
The color of the outline of the bars.
Default: #666

colors
An array of the colors of the actual bars.
Default: ['green', 'red', 'blue']

 

Margins

hmargin
The horizontal margin (in pixels) of the chart.
Default: 5

gutterLeft
The left gutter of the chart, (the gutter is where the labels and title are)).
Default: 25

gutterRight
The right gutter of the chart, (the gutter is where the labels and title are).
Default: 25

gutterTop
The top gutter of the chart, (the gutter is where the labels and title are).
Default: 25

gutterBottom
The bottom gutter of the chart, (the gutter is where the labels and title are).
Default: 25

 

Labels and text

textAccessible
A 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>

Default: true

textAccessibleOverflow
This 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.
Default: visible

textAccessiblePointerevents
This controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).
Default: true

textColor
The color of the labels.
Default: black

textSize
The size (in points) of the labels.
Default: 10

textAngle
The angle of the horizontal text labels (at the bottom of the chart). This can be one of three values - 0, 45 or 90.
Default: 0 (Horizontal)

textFont
The font used to render the text.
Default: Arial

labels
An array of the labels to be used on the chart.
Default: An empty array

labelsColor
The color of the labels
Default: null (same as textColor)

labelsBold
Whether the labels are bold or not
Default: false

labelsOffsetx
This allows you finer grained control in the horizontal direction over the X label positioning if you need it.
Default: 0

labelsOffsety
This allows you finer grained control in the vertical direction over the X label positioning if you need it.
Default: 0

ylabels
Can be true or false and determines whether the chart has Y axis labels.
Default: true

labelsCount
This determines how many Y scale labels are shown.
Default: true

ylabelsOffsetx
This allows you finer grained control in the horizontal direction over the Y label positioning if you need it.
Default: 0

ylabelsOffsety
This allows you finer grained control in the vertical direction over the Y label positioning if you need it.
Default: 0

numyticks
The number of Y tickmarks. If you have changed the number of Y labels, you may also want to change this to match.
Default: 10

 

Titles

title
The title of the chart, if any.
Default: null

titleFont
The font that the title is rendered in. If not specified the text.font setting is used (usually Arial)
Default: null

titleSize
The size of the title. If not specified the size is usually 2pt bigger than the text.size setting.
Default: null

titleBold
Whether the title is bold or not.
Default: true

titleItalic
Whether the title is italic or not.
Default: false

titleBackground
The background color (if any) for the title.
Default: null

titleColor
The color of the title.
Default: black

titleX
To give the exact X coordinate for the title - use this
Default: null

titleY
To give the exact Y coordinate for the title - use this
Default: null

titleXaxis
This allows to specify a title for the X axis.
Default: none

titleXaxisSize
This allows you to specify a size for the X axis title.
Default: null

titleXaxisFont
This allows to specify a font for the X axis title.
Default: null

titleXaxisBold
This controls whether the X axis title is bold or not.
Default: true

titleXaxisColor
This controls the color of the X axis title.
Default: black

titleXaxisX
By giving this you can specifically set the X position of the X axis title
Default: null

titleXaxisY
By giving this you can specifically set the Y position of the X axis title
Default: null

titleYaxisX
By giving this you can specifically set the X position of the Y axis title
Default: null

titleYaxisY
By giving this you can specifically set the Y position of the Y axis title
Default: null

titleYaxis
This allows to specify a title for the Y axis.
Default: none

titleYaxisSize
This allows you to specify a size for the Y axis title.
Default: null

titleYaxisFont
This allows to specify a font for the Y axis title.
Default: null

titleYaxisBold
This controls whether the Y axis title is bold or not.
Default: true

titleYaxisColor
This controls what color the Y axis is.
Default: black

titleXaxisPos
This is multiplied with the gutter to give the position of the X axis title.
Default: 0.25

titleYaxisPos
This is multiplied with the gutter to give the position of the Y axis title.
Default: 0.25

titleYaxisAlign
Instead of using the option above you can instead use this option, specifying left or right.
Default: left

 

Shadow

shadow
Whether a drop shadow is applied.
Default: false

shadowColor
The color of the shadow.
Default: #666

shadowOffsetx
The X offset of the shadow.
Default: 3

shadowOffsety
The Y offset of the shadow.
Default: 3

shadowBlur
The severity of the shadow blurring effect.
Default: 3

 

Scale

scaleDecimals
The number of decimal places to display for the Y scale.
Default: 0

scalePoint
The character used as the decimal point.
Default: .

scaleThousand
The character used as the thousand separator
Default: ,

scaleFormatter
To 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);

Default: null

scaleZerostart
Whether to start the scale at zero or not
Default: true

unitsPre
The units that the Y axis is measured in. This string is displayed BEFORE the actual number, allowing you to specify values such as "$50".
Default: none

unitsPost
The units that the Y axis is measured in. This string is displayed AFTER the actual number, allowing you to specify values such as "50ms".
Default: none

ymax
The optional maximum Y scale value. If not specified then it will be calculated.
Default: null (It's calculated)

ymin
This 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
Default: 0

 

Interactive features

contextmenu
An array of context menu items. More information on context menus is here.
Default: [] (An empty array)

tooltips
A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain HTML.
Default: null

tooltipsEffect
The effect used for showing tooltips. Can be either fade or none.
Default: fade

tooltipsEvent
This is the event that triggers the tooltips. It can be either onclick or onmousemove.
Default: onclick

tooltipsCssClass
This is the name of the CSS class the chart uses.
Default: RGraph_tooltip

tooltipsOverride
If 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
Default: null

tooltipsNohideonclear
Not 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.
Default: false

crosshairs
If true, you will get a crosshair centering on the current mouse position.
Default: false

crosshairsLinewidth
This controls the linewidth of the crosshairs.
Default: 1

crosshairsColor
The color of the crosshairs.
Default: #333

crosshairsHlines
This determines whether the horizontal crosshair is shown.
Default: true

crosshairsVlines
This determines whether the vertical crosshair is shown.
Default: true

annotatable
Whether annotations are enabled for the chart (ie you can draw on the chart interactively.
Default: false

annotateColor
If you do not allow the use of the palette, then this will be the only colour allowed for annotations.
Default: black

annotateLinewidth
This is the line width of the annotations.
Default: 1

resizable
Defaulting 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).
Default: false

resizeHandleBackground
With 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.
Default: null

resizableMaxwidth
This allows you to set a maximum width that the chart can be resized to.
Default: null

resizableMaxheight
This allows you to set a maximum height that the chart can be resized to.
Default: null

 

Zoom

zoomFactor
This is the factor that the chart will be zoomed by (bigger values means more zoom)
Default: 1.5

zoomFadeIn
Whether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true

zoomFadeOut
Whether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.
Default: true

zoomHdir
The horizontal direction of the zoom. Possible values are: left, center, right
Default: right

zoomVdir
The vertical direction of the zoom. Possible values are: up, center, down
Default: down

zoomDelay
The delay (in milliseconds) between frames.
Default: 50

zoomFrames
The number of frames in the zoom animation.
Default: 10

zoomShadow
Whether or not the zoomed canvas has a shadow or not.
Default: true

 

Events

eventsClick
If you want to add your own onclick function you can do so by assigning it to this property. See here for details.
Default: null

eventsMousemove
If you want to add your own onmousemove function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseover
If you want to add your own onmouseover function you can do so by assigning it to this property. See here for details.
Default: null

eventsMouseout
If you want to add your own onmouseout function you can do so by assigning it to this property. See here for details.
Default: null

 

Miscellaneous

highlightStyle
By 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.
Default: null

highlightStroke
If you use tooltips, this controls the colour of the highlight stroke.
Default: black

highlightFill
If you use tooltips, this controls the colour of the highlight fill.
Default: rgba(255,255,255,0.5)

axisColor
The color of the axis.
Default: black

clearto
This is used in animations and effects as the default color to use when clearing the canvas.
Default: 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>
Share RGraph
X

Comments