About
RGraph is a JavaScript charts library based on HTML5 SVG and canvas. RGraph is mature (over 15 years old) and has a wealth of features making it an ideal choice to show charts on your website.

More »

 

License
RGraph can be used for free under the GPL or if that doesn't suit your situation there's an inexpensive (£99) commercial license available.

More »

 

Download
Get the latest version of RGraph (version 6.16) from the download page. There's also older versions available, minified files and links to cdnjs.com hosted libraries.

More »

Waterfall chart

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:

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

Name: backgroundColor
Description: 
The color of the background.
Default: null
Name: backgroundImage
Description: 
A URL of an image to render to the background.
Default: null
Name: backgroundImageAspect
Description: 
The aspect ratio setting of the svg image tag, eg it could be XMinYMin meet.
Default: none
Name: backgroundImageOpacity
Description: 
The opacity value of the background image.
Default: 0.5
Name: backgroundImageStretch
Description: 
Whether the background image is stretched across the whole chart (except the margins).
Default: true
Name: backgroundImageX
Description: 
If you're not using the backgroundImageStretch option you can specify the x-axis coordinate of the image.
Default: null
Name: backgroundImageX
Description: 
If you're not using the backgroundImageStretch option you can specify the y-axis coordinate of the image.
Default: null
Name: backgroundImageW
Description: 
If you're not using the backgroundImageStretch option you can specify the width of the image.
Default: null
Name: backgroundImageH
Description: 
If you're not using the backgroundImageStretch option you can specify the height of the image.
Default: null
Name: backgroundGrid
Description: 
Whether to show the background grid or not.
Default: true
Name: backgroundGridColor
Description: 
The color of the background grid.
Default: #ddd
Name: backgroundGridLinewidth
Description: 
The linewidth that the background grid lines are. Decimals (eg 0.5) are permitted.
Default: 1
Name: backgroundGridBorder
Description: 
Determines whether a border is drawn around the grid.
Default: true
Name: backgroundGridHlines
Description: 
Determines whether to draw the horizontal grid lines.
Default: true
Name: backgroundGridHlinesCount
Description: 
Determines how many horizontal grid lines you have. The default is linked to how many scale labels that you have.
Default: null
Name: backgroundGridVlines
Description: 
Determines whether to draw the vertical grid lines.
Default: true
Name: backgroundGridVlinesCount
Description: 
Determines how many vertical grid lines you have. The default is to be linked to how many scale labels that you have.
Default: null
Name: backgroundGridDashed
Description: 
You can specify a dashed background grid by setting this to true. This option takes precedence over the dotted variant.
Default: false
Name: backgroundGridDotted
Description: 
You can specify a dotted background grid by setting this to true.
Default: false
Name: backgroundGridDashArray
Description: 
With this option you can specify exactly what the array used for the linedash setting should be. It should be an array consisting of two numbers.
Default: null
Name: backgroundBorder
Description: 
You can use this property to specify that the chart area has a border around it.
Default: false
Name: backgroundBorderLinewidth
Description: 
The linewidth of the border that goes around the chart area.
Default: 1
Name: backgroundBorderColor
Description: 
The color of the border that goes around the chart area.
Default: #aaa
Name: backgroundBorderDashed
Description: 
Whether the border around the chart area is dashed or not.
Default: false
Name: backgroundBorderDotted
Description: 
Whether the border around the chart area is dotted or not.
Default: false
Name: backgroundBorderDashArray
Description: 
If the default dot or dash style is not to your liking you can use this property to specify your own style. It should be an array of two or more elements that specify the dashes and spaces - for example: backgroundBorderDashArray: [5,10],
Default: null

Margin properties

Name: marginLeft
Description: 
The left margin of the chart, (the margin is where the labels and title are)).
Default: 35
Name: marginRight
Description: 
The right margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginTop
Description: 
The top margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginBottom
Description: 
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 35
Name: marginInner
Description: 
The horizontal margin (in pixels) of the chart. The horizontal margin is on either side of the bars.
Default: 5

Color properties

Name: colors
Description: 
An array of the colors of the bars. You can specify four colors if you want and they are:
  1. The color used for positive bars (black).
  2. The color used for negative bars (red).
  3. The color used for total bars (blue).
  4. The color used for "mid-chart" total bars (blue, optional).
Default: ['black', 'red', 'blue']
Name: colorsSequential
Description: 
If true, for regular bar charts, (not stacked or grouped), the colors that you specify will be used sequentially.
Default: false
Name: colorsStroke
Description: 
The color of the outline of the bars.
Default: #aaa
Name: colorsConnectors
Description: 
This is the color used for the connectors between the bars. Set this to rgba(0,0,0,0) if you don't want the connectors to be visible
Default: #666

X-axis properties

Name: xaxis
Description: 
Whether the x-axis is shown or not.
Default: true
Name: xaxisLinewidth
Description: 
The linewidth that's used to draw the x-axis.
Default: 1
Name: xaxisColor
Description: 
The color of the x-axis.
Default: black
Name: xaxisTickmarks
Description: 
Whether the x-axis has tickmarks or not.
Default: true
Name: xaxisTickmarksLength
Description: 
The size of the x-axis tickmarks.
Default: 5
Name: xaxisLabelsOffsetx
Description: 
The horizontal pixel offset that's added to the x-axis labels.
Default:  0
Name: xaxisLabelsOffsety
Description: 
The vertical pixel offset that's added to the x-axis labels.
Default:  0
Name: xaxisLabelsColor
Description: 
The color of the x-axis text.
Default: null
Name: xaxisLabelsBold
Description: 
Whether the x-axis text is bold or not.
Default: null
Name: xaxisLabelsItalic
Description: 
Whether the x-axis text is italic or not.
Default: null
Name: xaxisLabelsFont
Description: 
The font of the x-axis text.
Default: null
Name: xaxisLabelsSize
Description: 
The size of the x-axis text.
Default: null
Name: xaxisLabelsAngle
Description: 
If you have long labels you may want to set this to a number between 0 and 90 to enable angled labels.
Default: null
Name: xaxisLabelsPositionSectionTickmarksCount
Description: 
Not something you'll use often, if at all. Determines how many tickmarks there are.
Default: null
Name: xaxisLabelsFormattedDecimals
Description: 
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default:  0
Name: xaxisLabelsFormattedPoint
Description: 
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .
Name: xaxisLabelsFormattedThousand
Description: 
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,
Name: xaxisLabelsFormattedUnitsPre
Description: 
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: xaxisLabelsFormattedUnitsPost
Description: 
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: xaxisTitle
Description: 
This allows you to specify a title for the x-axis.
Default: none
Name: xaxisTitleSize
Description: 
This allows you to specify a size for the x-axis title.
Default: null
Name: xaxisTitleFont
Description: 
This allows you to specify a font for the x-axis title.
Default: null
Name: xaxisTitleBold
Description: 
This controls whether the x-axis title is bold or not.
Default: null
Name: xaxisTitleItalic
Description: 
This controls whether the x-axis title is italic or not.
Default: null
Name: xaxisTitleColor
Description: 
This controls the color of the x-axis title.
Default: null
Name: xaxisTitleX
Description: 
By giving this you can specifically set the X coordinate of the x-axis title.
Default: null
Name: xaxisTitleY
Description: 
By giving this you can specifically set the Y coordinate of the x-axis title.
Default: null
Name: xaxisTitleOffsetx
Description: 
The horizontal pixel offset that's applied to the x-axis title.
Default:  0
Name: xaxisTitleOffsety
Description: 
The vertical pixel offset that's applied to the x-axis title.
Default:  0
Name: xaxisTitleHalign
Description: 
The horizontal alignment of the x-axis title.
Default: null
Name: xaxisTitleValign
Description: 
The vertical alignment of the x-axis title.
Default: null

Y-axis properties

Name: yaxis
Description: 
Whether the y-axis is shown or not.
Default: true
Name: yaxisPosition
Description: 
This controls whether the y-axis is positioned on the left or the right.
Default: left
Name: yaxisColor
Description: 
The color of the y-axis.
Default: black
Name: yaxisLinewidth
Description: 
The linewidth that's used to draw the y-axis.
Default: 1
Name: yaxisTickmarks
Description: 
Whether the y-axis has tickmarks or not.
Default: true
Name: yaxisTickmarksLength
Description: 
The size of the y-axis tickmarks.
Default: 5
Name: yaxisLabels
Description: 
If the yaxisScale option is false then this can be used to give an array of labels that are shown on the y-axis instead.
Default: null
Name: yaxisLabelsOffsetx
Description: 
The horizontal pixel offset that's added to the y-axis labels.
Default:  0
Name: yaxisLabelsOffsety
Description: 
The vertical pixel offset that's added to the y-axis labels.
Default:  0
Name: yaxisLabelsHalign
Description: 
The horizontal alignment of the labels.
Default: right
Name: yaxisLabelsValign
Description: 
The vertical alignment of the labels.
Default: center
Name: yaxisLabelsCount
Description: 
The number of y-axis labels.
Default: 5
Name: yaxisLabelsPositionEdgeTickmarksCount
Description: 
Not something you'll use often, if at all. Determines how many tickmarks there are.
Default: null
Name: yaxisScale
Description: 
Whether the y-axis scale is shown.
Default: true
Name: yaxisScaleUnitsPre
Description: 
Units that are prepended to the scale numbers.
Default:  (An empty string
Name: yaxisScaleUnitsPost
Description: 
Units that are appended to the scale numbers.
Default: (An empty string
Name: yaxisScaleDecimals
Description: 
The number of decimals that the scale will show.
Default:  0
Name: yaxisScalePoint
Description: 
The character(s) used as the decimal point.
Default: .
Name: yaxisScaleThousand
Description: 
The character(s) used as the thousand separator.
Default: ,
Name: yaxisScaleRound
Description: 
If set to true the max scale value will be rounded up.
Default: false
Name: yaxisScaleMax
Description: 
The maximum y-axis scale value.
Default: null
Name: yaxisScaleMin
Description: 
The minimum y-axis scale value. As well as a numeric value you can also set this to mirror so that the x-axis is put in the center.
Default:  0
Name: yaxisScaleFormatter
Description: 
This option should be a function. This function handles the entirety of the number formatting for the y-axis. Units are not added - decimals are not added - it's all up to you. The function is passed two arguments - the chart object and the number. It should look like this:
yaxisFormatter: function (obj, num),
{
}
Default: null
Name: yaxisLabelsColor
Description: 
The color of the y-axis text.
Default: null
Name: yaxisLabelsBold
Description: 
Whether the y-axis text is bold or not.
Default: null
Name: yaxisLabelsItalic
Description: 
Whether the y-axis text is italic or not.
Default: null
Name: yaxisLabelsFont
Description: 
The font of the y-axis text.
Default: null
Name: yaxisLabelsSize
Description: 
The size of the y-axis text.
Default: null
Name: yaxisTitle
Description: 
This allows you to specify a title for the y-axis.
Default: none
Name: yaxisTitleSize
Description: 
This allows you to specify a size for the y-axis title.
Default: null
Name: yaxisTitleFont
Description: 
This allows you to specify a font for the y-axis title.
Default: null
Name: yaxisTitleBold
Description: 
This controls whether the y-axis title is bold or not.
Default: null
Name: yaxisTitleItalic
Description: 
This controls whether the y-axis title is italic or not.
Default: null
Name: yaxisTitleColor
Description: 
This controls the color of the y-axis title.
Default: null
Name: yaxisTitleX
Description: 
By giving this you can specifically set the horizontal position of the y-axis title.
Default: null
Name: yaxisTitleY
Description: 
By giving this you can specifically set the vertical position of the y-axis title.
Default: null
Name: yaxisTitleOffsetx
Description: 
The horizontal pixel offset that's applied to the y-axis title.
Default:  0
Name: yaxisTitleOffsety
Description: 
The vertical pixel offset that's applied to the y-axis title.
Default:  0
Name: yaxisTitleHalign
Description: 
The horizontal alignment of the y-axis title.
Default: null
Name: yaxisTitleValign
Description: 
The vertical alignment of the y-axis title.
Default: null

Other text properties

Name: textColor
Description: 
The color of the text.
Default: black
Name: textFont
Description: 
The font used for text.
Default: Arial, Verdana, sans-serif
Name: textSize
Description: 
The size of the text.
Default: 12
Name: textBold
Description: 
Whether the text is bold or not.
Default: false
Name: textItalic
Description: 
Whether the text is italic or not.
Default: false
Name: text
Description: 
This allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here.
Default: null
Name: labelsAbove
Description: 
Whether to show the labelsAbove style labels.
Default: false
Name: labelsAbovePoint
Description: 
The decimal point character to use for the labelsAbove labels.
Default: null
Name: labelsAboveThousand
Description: 
The thousand separator character to use for the labelsAbove labels.
Default: null
Name: labelsAboveDecimals
Description: 
The number of decimals to use for the labelsAbove labels.
Default:  0
Name: labelsAbovePre
Description: 
A string to prepend to the labelsAbove labels.
Default: null
Name: labelsAbovePost
Description: 
A string to append to the labelsAbove labels.
Default: null
Name: labelsAboveFormatter
Description: 
A function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number.
Default: null
Name: labelsAboveOffsetx
Description: 
The horizontal offset of the labelsAbove labels.
Default:  0
Name: labelsAboveOffsety
Description: 
The vertical offset of the labelsAbove labels.
Default:  0
Name: labelsAboveFont
Description: 
The font of the labelsAbove labels.
Default: null
Name: labelsAboveSize
Description: 
The size of the labelsAbove labels.
Default: null
Name: labelsAboveBold
Description: 
Whether the labelsAbove labels are bold or not.
Default: null
Name: labelsAboveItalic
Description: 
Whether the labelsAbove labels are italic or not.
Default: null
Name: labelsAboveColor
Description: 
The color of the labelsAbove labels.
Default: null
Name: labelsAboveBackground
Description: 
The background color of the labelsAbove labels.
Default: null
Name: labelsAboveBackgroundPadding
Description: 
The padding of the labelsAbove labels.
Default:  0
Name: labelsAboveHalign
Description: 
The horizontal alignment of the labelsAbove.
Default: left
Name: labelsAboveValign
Description: 
The vertical alignment of the labelsAbove.
Default: center
Name: labelsAboveSpecific
Description: 
This property allows you to make the labelsAbove labels specific strings.
Default: null
Name: labelsAboveLastFont
Description: 
This allows you to specify the font for the last labelsAbove label.
Default: null
Name: labelsAboveLastBold
Description: 
This allows you to specify whether the text is bold or not for the last labelsAbove label.
Default: null
Name: labelsAboveLastItalic
Description: 
This allows you to specify whether the text is italic or not for the last labelsAbove label.
Default: null
Name: labelsAboveLastSize
Description: 
This allows you to specify the size for the last labelsAbove label.
Default: null
Name: labelsAboveLastColor
Description: 
This allows you to specify the color for the last labelsAbove label.
Default: null
Name: labelsAboveLastBackground
Description: 
This allows you to specify the background color for the last labelsAbove label.
Default: null
Name: labelsAboveLastBackgroundPadding
Description: 
This allows you to specify the background padding for the last labelsAbove label.
Default: null

Tooltip properties

Name: tooltips
Description: 
An array of tooltips for the chart. You can also check the canvas tooltips documentation for more information.
Default: null
Name: tooltipsOverride
Description: 
If required, this can be a function that handles the tooltip showing instead of the default RGraph tooltips. It should look like this:
tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}
The opt argument contains these items:
  • object The chart object.
  • index The index of the element (that triggered the tooltip).
  • sequentialIndex The sequential index of the element that was clicked.
  • text The text to be used as the tooltip. Remember that this may contain html (or whatever else you may have specified).
  • event The event object (either a click or mousemove event).
Default: null
Name: tooltipsEvent
Description: 
The event used for tooltips (either click or mousemove.
Default: click
Name: tooltipsFormattedPoint
Description: 
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .
Name: tooltipsFormattedThousand
Description: 
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,
Name: tooltipsFormattedDecimals
Description: 
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default:  0
Name: tooltipsFormattedUnitsPre
Description: 
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)
Name: tooltipsFormattedUnitsPost
Description: 
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)
Name: tooltipsFormattedKeyLabels
Description: 
The labels that are used in the formatted tooltip key. These are (in order):
  1. Label for positive columns.
  2. Label for outgoing columns.
  3. Label for the total column.
  4. Labels for mid-data total columns.
Default: [] (an empty array)
Name: tooltipsFormattedKeyColors
Description: 
The colors that are used in the formatted tooltip key. See the colors property for what colors you can specify.
Default: null
Name: tooltipsFormattedKeyColorsShape
Description: 
This is the shape that's used in the tooltip key. It can be square or circle
Default: square
Name: tooltipsFormattedKeyColorsCss
Description: 
By using this property you can add css values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of css properties like this:
tooltipsFormattedKeyColorsCss : {
    border: "1px solid #ddd";
}
Default: null
Name: tooltipsFormattedListType
Description: 
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.
Default: ul
Name: tooltipsFormattedListItems
Description: 
This should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]
You can use css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}
Default: null
Name: tooltipsFormattedTableHeaders
Description: 
When showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.
Default: null
Name: tooltipsFormattedTableData
Description: 
This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example in the canvas documentation, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)
Name: tooltipsPointer
Description: 
By default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.
Default: true
Name: tooltipsPointerCss
Description: 
If you want any css values applied to the tooltips pointer (a css border, for example) then specify an object containing those values to this property. For example:
tooltips: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}
Default: null
Name: tooltipsPointerOffsetx
Description: 
This allows you to adjust the horizontal position of the tooltips pointer.
Default:  0
Name: tooltipsPointerOffsety
Description: 
This allows you to adjust the vertical position of the tooltips pointer.
Default:  0
Name: tooltipsPositionStatic
Description: 
The new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.
Default: true
Name: tooltipsCss
Description: 
If you want to specify some css that gets applied to all of the tooltips, but don't want to use the RGraph.SVG.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object css for the tooltips. These are css styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}
Default: null
Name: tooltipsCssClass
Description: 
The css class that's applied to the tooltip div.
Default: RGraph_tooltip
Name: tooltipsOffsetx
Description: 
This property allows you to shift the tooltips left or right.
Default:  0
Name: tooltipsOffsety
Description: 
This property allows you to shift the tooltips up or down.
Default:  0
Name: highlightStroke
Description: 
The stroke color that's used when highlighting the chart.
Default: rgba(0,0,0,0)
Name: highlightFill
Description: 
The fill color that's used when highlighting the chart.
Default: rgba(255,255,255,0.7)
Name: highlightLinewidth
Description: 
The linewidth that's used when highlighting the chart.
Default: 1

Shadow properties

Name: shadow
Description: 
Whether a drop shadow is applied to the lines.
Default: false
Name: shadowOffsetx
Description: 
The horizontal offset of the shadow.
Default: 2
Name: shadowOffsety
Description: 
The vertical offset of the shadow.
Default: 2
Name: shadowBlur
Description: 
The extent of the blurring effect that's applied to the shadow.
Default: 2
Name: shadowColor
Description: 
The color of the shadow.
Default: rgba(0,0,0,0.25)

Key properties

Name: key
Description: 
An array of the labels that appear on the key.
Default: null
Name: keyColors
Description: 
An array of colors to be shown on the key. If not specified then the colors option will be used instead.
Default: null
Name: keyLabelsColor
Description: 
The color of the text in the key.
Default: null
Name: keyLabelsBold
Description: 
Whether the key text is bold or not.
Default: null
Name: keyLabelsFont
Description: 
The font to use for the key text. If not specified it defaults to the textFont setting.
Default: null
Name: keyLabelsSize
Description: 
The size to use for the key text. If not specified then the textSize is used.
Default: null
Name: ketLabelsItalic
Description: 
Whether the key text is italic or not.
Default: null
Name: keyLabelsOffsetx
Description: 
The horizontal pixel offset of the key text (just the text).
Default:  0
Name: keyLabelsOffsety
Description: 
The vertical pixel offset of the key text (just the text).
Default: -1
Name: keyOffsetx
Description: 
The horizontal pixel offset of the entire key.
Default:  0
Name: keyOffsety
Description: 
The horizontal pixel offset of the entire key.
Default:  0
Name: keyColorShape
Description: 
This controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are: rect circle triangle line dot rectdot
Default: rect

Title properties

Name: title
Description: 
The title of the chart.
Default: (An empty string)
Name: titleX
Description: 
The specific x-axis coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null
Name: titleY
Description: 
The specific y-axis coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null
Name: titleOffsetx
Description: 
An offset value that is added to the calculated x-axis coordinate.
Default:  0
Name: titleOffsety
Description: 
An offset value that is added to the calculated y-axis coordinate.
Default:  0
Name: titleHalign
Description: 
The horizontal alignment of the title.
Default: center
Name: titleColor
Description: 
The color of the title.
Default: null
Name: titleFont
Description: 
The font used to render the title.
Default: null
Name: titleSize
Description: 
The size of the font used to render the title.
Default: null
Name: titleBold
Description: 
Whether the title is bold or not.
Default: null
Name: titleItalic
Description: 
Whether the title is italic or not.
Default: null
Name: titleSubtitle
Description: 
The subtitle of the chart. If a subtitle is specified the title is moved up to accommodate it. As such you might need to give a larger marginTop value.
Default: (An empty string)
Name: titleSubtitleColor
Description: 
The color of the subtitle.
Default: #aaa
Name: titleSubtitleFont
Description: 
The font used to render the subtitle.
Default: null
Name: titleSubtitleSize
Description: 
The size of the font used to render the subtitle. It defaults to be the same as the textSize setting.
Default: null
Name: titleSubtitleBold
Description: 
Whether the subtitle is bold or not.
Default: null
Name: titleSubtitleItalic
Description: 
Whether the subtitle is italic or not.
Default: null

Other properties

Name: linewidth
Description: 
The linewidth (around the bars) used.
Default: 1
Name: total
Description: 
Whether to show the total at the end or not.
Default: true
Name: responsive
Description: 
This option is new to the July 2023 release (v6.13) and allows you to inline the responsive configuration instead of appending it on to the end of the object it as a function. The documentation and demo pages have been updated to use this new option. You can read more about the responsive feature by reading the responsive configuration page.
Default: null

Methods

obj.get(name)

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).

obj.set(name, value)

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.

obj.getYCoord(value)

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.

obj.on(event, handler)

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
});
obj.exec(func)

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
});
obj.responsive(configuration)

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:

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:

For example:
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();