Waterfall chart API reference

Summary: 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

[No canvas support]
<script>
    new RGraph.Waterfall({
        id: 'cvs',
        data: [90, -16, -18, -34,43,82,53],
        options: {
            title: 'Each salespersons sales/returns totals',
            titleBold: true,
            titleSize: 22,
            backgroundGridVlines: false,
            backgroundGridBorder: false,
            yaxis: false,
            marginInner: 20,
            xaxisLabels: ['Olga','Barry','Pete','Helen','Richard','Jill','Molly','Total'],
            backgroundGridVlinesCount: 5,
            tooltips: '<span style="font-size: 14pt">Todays income</span><br/>%{key}',
            tooltipsFormattedUnitsPre: '£',
            tooltipsCss: {
                fontSize: '18pt',
                textAlign: 'left'
            },
            highlightStyle: 'invert',
            highlightStroke:'white'
        }
    }).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 color of the background bars, (1 of 2).white
backgroundBarsColor2The 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
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 colored bars. You can use these to indicate limits. Eg: obj.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 color 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 color 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
backgroundBarsCount
The number of background bars.
Default: 5

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

backgroundBarsColor2
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

backgroundGridLinewidth
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

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

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 colored bars. You can use these to indicate limits. Eg: obj.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.
Default: null

backgroundColor
If you want to have a single background color 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 color to the canvas tag.
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

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 top 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
xaxisLinewidthThe linewidth used for the X axis and the X axis tickmarks.1
xaxisColorThe color of the X axis (and its tickmarks.black
xaxisTickmarksWhether the X axis tickmarks are shown.true
xaxisTickmarksLastLeftWhether the last tickmark on the left is displayed.null
xaxisTickmarksLastRightWhether the last tickmark on the right is displayed.null
xaxisTickmarksLengthThe length of the tickmarks.3
xaxisTickmarksCountThe number of tickmarks that are shown on the X axis.null
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 color 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
xaxisLabelsHalignThe horizontal alignment of the labels.center
xaxisLabelsValignThe vertical alignment of the labels.top
xaxisLabelsAngleThe angle of the X axis labels. For example you could set this to 45 to get angled labels.0 (Horizontal)
xaxisLabelsPositionThis property controls how the labels are arranged - section for most chart types and edge for Line charts. You probably won't need to change this.section
xaxisLabelsSpecificAlignThis determines the alignment of the specific labels. You probably won't need this.left
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 color 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
xaxisTitleOffsetxThe X pixel offset that's applied to the title.0
xaxisTitleOffsetyThe Y pixel offset that's applied to the title.0
xaxisTitleHalignThe horizontal alignment of the title.center
xaxisTitleValignThe vertical alignment of the title.top
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
xaxis
Set this to true if you don't want an X axis.
Default: true

xaxisPosition
This determines where the X axis is positioned. If you wish to show negative values then you should set this to center or top 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.
Default: bottom

xaxisLinewidth
The linewidth used for the X axis and the X axis tickmarks.
Default: 1

xaxisColor
The color of the X axis (and its tickmarks.
Default: black

xaxisTickmarks
Whether the X axis tickmarks are shown.
Default: true

xaxisTickmarksLastLeft
Whether the last tickmark on the left is displayed.
Default: null

xaxisTickmarksLastRight
Whether the last tickmark on the right is displayed.
Default: null

xaxisTickmarksLength
The length of the tickmarks.
Default: 3

xaxisTickmarksCount
The number of tickmarks that are shown on the X axis.
Default: null

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

xaxisLabelsFont
The font used to render the labels.
Default: null

xaxisLabelsSize
The size of the labels.
Default: null

xaxisLabelsColor
The color of the labels.
Default: null

xaxisLabelsBold
Whether the labels are bold or not.
Default: null

xaxisLabelsItalic
Whether the labels are italic or not.
Default: null

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

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

xaxisLabelsHalign
The horizontal alignment of the labels.
Default: center

xaxisLabelsValign
The vertical alignment of the labels.
Default: top

xaxisLabelsAngle
The angle of the X axis labels. For example you could set this to 45 to get angled labels.
Default: 0 (Horizontal)

xaxisLabelsPosition
This property controls how the labels are arranged - section for most chart types and edge for Line charts. You probably won't need to change this.
Default: section

xaxisLabelsSpecificAlign
This determines the alignment of the specific labels. You probably won't need this.
Default: left

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

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

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

xaxisTitleBold
This controls whether the X axis title is bold or not.
Default: null

xaxisTitleItalic
This controls whether the X axis title is italic or not.
Default: null

xaxisTitleColor
This controls the color of the X axis title.
Default: null

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

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

xaxisTitleOffsetx
The X pixel offset that's applied to the title.
Default: 0

xaxisTitleOffsety
The Y pixel offset that's applied to the title.
Default: 0

xaxisTitleHalign
The horizontal alignment of the title.
Default: center

xaxisTitleValign
The vertical alignment of the title.
Default: top

xaxisTitlePos
This 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.
Default: null

Y axis properties

PropertyDescriptionDefault
yaxisWhether the Y axis is drawn.true
yaxisPositionSpecifies the Y axis position. Can be left or right.left
yaxisLinewidthThe linewidth of the Y axis.1
yaxisColorThe color of the Y axis.black
yaxisTickmarksWhether the Y axis tickmarks are drawn.true
yaxisTickmarksLengthThe length of the Y axis tickmarks.3
yaxisTickmarksCountThis allows you to stipulate how many Y axis tickmarks there are.null (related to how many labels there are)
yaxisTickmarksLastTopWhether the top-most tickmark is drawn.null (displayed if the X axis position warrants it)
yaxisTickmarksLastBottomWhether the bottom-most tickmark is drawn.null (displayed if the X axis position warrants it)
yaxisLabelsCountA value that controls how many Y labels there are. This value could formerly be either 1/3/5/10 however now it can be any number.5
yaxisLabelsSpecificYou can use this option to give your own Y labels (eg ['Low', 'Medium', 'High']. Note: Since March 2013 you may now need to add an extra (optionally) empty element to the array of labels to achieve your desired result.null
yaxisLabelsPositionThis controls how the specific labels are positioned on the Y axis. It has no effect on a scale.edge
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 that's used by the Y axis labels.null
yaxisLabelsSizeThe size of the Y axis labels.null
yaxisLabelsColorThe color 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
yaxisLabelsHalignThe horizontal alignment of the Y axis labels.null
yaxisLabelsValignThe vertical alignment of the Y axis labels.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
yaxisTitleColorThis controls what color the Y axis title is.null
yaxisTitleItalicThis controls whether the Y axis title is italic or not.null
yaxisTitlePosThis is multiplied with the margin to give the position of the Y axis title.0.25
yaxisTitleOffsetxThe pixel offset that's added to the Y axis titles X coordinate.0
yaxisTitleOffsetyThe pixel offset that's added to the Y axis titles Y coordinate.0
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
yaxisTitleHalignThe horizontal alignment of the Y axis title.0
yaxisTitleValignThe vertical alignment of the Y axis title.0
yaxisTitleAccessibleWith this property you can control whether the Y axis title is accessible or not.true
yaxisScaleWhether the Y axis scale is displayed or not.true
yaxisScaleRoundWhether the Y axis scale is rounded up or not.false
yaxisScaleUnitsPreThe 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
yaxisScaleUnitsPostThe 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
yaxisScaleMaxThe optional maximum Y scale value. If not specified then it will be calculated.null (It's calculated)
yaxisScaleMinThe optional minimum Y scale value. If not specified then it will be 0.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(opt)
{
    var num = Number(opt.number) * 5;

    return String(num)
}
obj.set('yaxisScaleFormatter', myFormatter);
null
yaxisScaleRoundWhether to round the scale up. eg A maximum value of 59 results in scale to 100.false
yaxisScaleDecimalsThe number of decimal places to display for the Y scale.0
yaxisScalePointThe character used as the decimal point..
yaxisScaleThousandThe character used as the thousand separator.,
yaxisScaleInvertWhether the Y axis scale is inverted or not.false
yaxis
Whether the Y axis is drawn.
Default: true

yaxisPosition
Specifies the Y axis position. Can be left or right.
Default: left

yaxisLinewidth
The linewidth of the Y axis.
Default: 1

yaxisColor
The color of the Y axis.
Default: black

yaxisTickmarks
Whether the Y axis tickmarks are drawn.
Default: true

yaxisTickmarksLength
The length of the Y axis tickmarks.
Default: 3

yaxisTickmarksCount
This allows you to stipulate how many Y axis tickmarks there are.
Default: null (related to how many labels there are)

yaxisTickmarksLastTop
Whether the top-most tickmark is drawn.
Default: null (displayed if the X axis position warrants it)

yaxisTickmarksLastBottom
Whether the bottom-most tickmark is drawn.
Default: null (displayed if the X axis position warrants it)

yaxisLabelsCount
A value that controls how many Y labels there are. This value could formerly be either 1/3/5/10 however now it can be any number.
Default: 5

yaxisLabelsSpecific
You can use this option to give your own Y labels (eg ['Low', 'Medium', 'High']. Note: Since March 2013 you may now need to add an extra (optionally) empty element to the array of labels to achieve your desired result.
Default: null

yaxisLabelsPosition
This controls how the specific labels are positioned on the Y axis. It has no effect on a scale.
Default: edge

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

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

yaxisLabelsFont
The font that's used by the Y axis labels.
Default: null

yaxisLabelsSize
The size of the Y axis labels.
Default: null

yaxisLabelsColor
The color of the Y axis labels.
Default: null

yaxisLabelsBold
Whether the Y axis labels are bold or not.
Default: null

yaxisLabelsItalic
Whether the Y axis labels are italic or not.
Default: null

yaxisLabelsHalign
The horizontal alignment of the Y axis labels.
Default: null

yaxisLabelsValign
The vertical alignment of the Y axis labels.
Default: null

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

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

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

yaxisTitleBold
This controls whether the Y axis title is bold or not.
Default: null

yaxisTitleColor
This controls what color the Y axis title is.
Default: null

yaxisTitleItalic
This controls whether the Y axis title is italic or not.
Default: null

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

yaxisTitleOffsetx
The pixel offset that's added to the Y axis titles X coordinate.
Default: 0

yaxisTitleOffsety
The pixel offset that's added to the Y axis titles Y coordinate.
Default: 0

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

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

yaxisTitleHalign
The horizontal alignment of the Y axis title.
Default: 0

yaxisTitleValign
The vertical alignment of the Y axis title.
Default: 0

yaxisTitleAccessible
With this property you can control whether the Y axis title is accessible or not.
Default: true

yaxisScale
Whether the Y axis scale is displayed or not.
Default: true

yaxisScaleRound
Whether the Y axis scale is rounded up or not.
Default: false

yaxisScaleUnitsPre
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

yaxisScaleUnitsPost
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

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

yaxisScaleMin
The optional minimum Y scale value. If not specified then it will be 0.
Default: 0

yaxisScaleFormatter
To 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(opt)
{
    var num = Number(opt.number) * 5;

    return String(num)
}
obj.set('yaxisScaleFormatter', myFormatter);

Default: null

yaxisScaleRound
Whether to round the scale up. eg A maximum value of 59 results in scale to 100.
Default: false

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

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

yaxisScaleThousand
The character used as the thousand separator.
Default: ,

yaxisScaleInvert
Whether the Y axis scale is inverted or not.
Default: false

Color properties

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

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

colorsSequential
Set this to true if you want the colors to be used in a sequential fashion.
Default: false

Margin properties

PropertyDescriptionDefault
marginInnerThe horizontal margin (in pixels) of the chart.5
marginLeftThe left margin of the chart, (the margin is where the labels and title are)).35
marginRightThe right margin of the chart, (the margin is where the labels and title are).35
marginTopThe top margin of the chart, (the margin is where the labels and title are).35
marginBottomThe bottom margin of the chart, (the margin is where the labels and title are).35
marginInner
The horizontal margin (in pixels) of the chart.
Default: 5

marginLeft
The left margin of the chart, (the margin is where the labels and title are)).
Default: 35

marginRight
The right margin of the chart, (the margin is where the labels and title are).
Default: 35

marginTop
The top margin of the chart, (the margin is where the labels and title are).
Default: 35

marginBottom
The bottom margin of the chart, (the margin is where the labels and title are).
Default: 35

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 color 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
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 color of the labelsAbove text. This can be either a string defining a single color or an array of three strings - one for the up color, one for the down color and one for the total color.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 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 inverted 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 color of the final labelsAbove label. This can be either a string defining a single color or an array of two strings - one for the up color, one for the down color.null
labelsAboveTotalBoldWhether the final labelsAbove label is bold or not.null
labelsAboveTotalItalicWhether the final 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 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
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 margins 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 text on the chart.
Default: black

textSize
The size of the text on the chart.
Default: 12

textFont
The font used to render the text on the chart.
Default: Arial, Verdana, sans-serif

textBold
Whether the text on the chart is bold or not.
Default: false

textItalic
Whether the text on the chart is italic or not.
Default: false

labelsAbove
Whether the labelsAbove labels are enabled. These sit just above the bars (or below them if the bars are negative).
Default: false

labelsAboveFont
The font to use when rendering the labelsAbove text.
Default: null

labelsAboveSize
The size of the labelsAbove text.
Default: null

labelsAboveColor
The color of the labelsAbove text. This can be either a string defining a single color or an array of three strings - one for the up color, one for the down color and one for the total color.
Default: null

labelsAboveBold
Whether the labelsAbove labels are bold or not.
Default: null

labelsAboveItalic
Whether the labelsAbove labels are italic or not.
Default: null

labelsAboveUnitsPre
A string that is appended to the number.
Default: (An empty string)

labelsAboveUnitsPost
A string that is prepended to the number.
Default: (An empty string)

labelsAboveDecimals
The number of decimals that are displayed.
Default: 0

labelsAbovePoint
This can be a character (or multiple characters) that is to be used as the decimal separator in the labels.
Default: .

labelsAboveThousand
This can be a character (or multiple characters) that is to be used as the thousand separator in the labels.
Default: ,

labelsAboveFormatter
This can be 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;
}

Default: null

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

labelsAboveOffsetx
If you want to alter the position of the labels in the horizontal direction you can use this property.
Default: 0

labelsAboveOffsety
If you want to alter the position of the labels in the vertical direction you can use this property. This value is inverted 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).
Default: 0

labelsAboveTotalFont
The font to use when rendering the final labelsAbove label.
Default: null

labelsAboveTotalSize
The size of the final labelsAbove label.
Default: null

labelsAboveTotalColor
The color of the final labelsAbove label. This can be either a string defining a single color or an array of two strings - one for the up color, one for the down color.
Default: null

labelsAboveTotalBold
Whether the final labelsAbove label is bold or not.
Default: null

labelsAboveTotalItalic
Whether the final labelsAbove label is italic or not.
Default: null

labelsAboveTotalDecimals
The number of decimals that are displayed on the final label.
Default: null

labelsAboveTotalUnitsPre
A string that is appended to the number on the final labelsAbove label.
Default: null

labelsAboveTotalUnitsPost
A string that is prepended to the number on the final labelsAbove label.
Default: null

labelsAboveTotalPoint
This can be a character (or multiple characters) that is to be used as the decimal separator in the final label.
Default: null

labelsAboveTotalThousand
This can be a character (or multiple characters) that is to be used as the thousand separator in the final label.
Default: null

labelsAboveTotalFormatter
This can be 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;
}

Default: 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 color of the title.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleBackgroundThe background color (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
titleHalignThe horizontal alignment of the title.center (can change depending on other options)
titleValignThe vertical alignment of the title.center (can change depending on other options)
title
The title of the chart, if any.
Default: null

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

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

titleColor
The color of the title.
Default: null

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

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

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

titleX
To 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.
Default: null

titleY
To 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.
Default: null

titleHalign
The horizontal alignment of the title.
Default: center (can change depending on other options)

titleValign
The vertical alignment of the title.
Default: center (can change depending on other options)

Shadow properties

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

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 click or mousemove.click
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
tooltipsFormattedPointWhen using formatted tooltip strings this is used as the point when using the %{value_formatted} option..
tooltipsFormattedThousandWhen using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.,
tooltipsFormattedDecimalsWhen using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.0
tooltipsFormattedUnitsPreWhen using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedUnitsPostWhen using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedKeyColorsWhen using formatted tooltip strings you can give specific colors for the %{key} option to use.null
tooltipsFormattedKeyColorsShapeThis is the shape that's used in the tooltip key. It can be square or circlesquare
tooltipsFormattedKeyColorsCss 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: "1 px solid #ddd";
}
null
tooltipsFormattedKeyLabelsWhen using formatted tooltip strings these are the labels that are displayed.[] (an empty array)
tooltipsFormattedTableHeadersWhen 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.null
tooltipsFormattedTableDataThis 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, copy the code from it and then modify it suit. You'll create fewer bugs this way.null)
tooltipsPointerBy 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.true
tooltipsPointerCssIf you want any CSS values applied to the tooltips pointer (for example a CSS border) then specify an object containing those values to this property. For example:
tooltips: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}
null
tooltipsPositionStaticThe 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.true
tooltipsCssClassThis is the name of the CSS class the chart uses.RGraph_tooltip
tooltipsCssIf you want to specify some CSS that gets applied to all of the tooltips, but don't want to use the RGraph.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'
}
null
tooltipsOffsetxThis property allows you to shift the tooltips left or right.0
tooltipsOffsetyThis property allows you to shift the tooltips up or down.0
crosshairsIf true, you will get a crosshair centered on the current mouse position.false
crosshairsLinewidthThis controls the linewidth of the crosshairs.1
crosshairsColorThe color of the crosshairs.#333
crosshairsHlineThis determines whether the horizontal crosshair is shown.true
crosshairsVlineThis 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 color allowed for annotations.black
annotatableLinewidthThis is the linewidth of the annotations.1
contextmenu
An array of context menu items. More information about 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 click or mousemove.
Default: click

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 tooltips do not get hidden.
Default: false

tooltipsFormattedPoint
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .

tooltipsFormattedThousand
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,

tooltipsFormattedDecimals
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default: 0

tooltipsFormattedUnitsPre
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedUnitsPost
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)

tooltipsFormattedKeyColors
When using formatted tooltip strings you can give specific colors for the %{key} option to use.
Default: null

tooltipsFormattedKeyColorsShape
This is the shape that's used in the tooltip key. It can be square or circle
Default: square

tooltipsFormattedKeyColorsCss
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: "1 px solid #ddd";
}

Default: null

tooltipsFormattedKeyLabels
When using formatted tooltip strings these are the labels that are displayed.
Default: [] (an empty array)

tooltipsFormattedTableHeaders
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

tooltipsFormattedTableData
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, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)

tooltipsPointer
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

tooltipsPointerCss
If you want any CSS values applied to the tooltips pointer (for example a CSS border) then specify an object containing those values to this property. For example:
tooltips: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

Default: null

tooltipsPositionStatic
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

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

tooltipsCss
If you want to specify some CSS that gets applied to all of the tooltips, but don't want to use the RGraph.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

tooltipsOffsetx
This property allows you to shift the tooltips left or right.
Default: 0

tooltipsOffsety
This property allows you to shift the tooltips up or down.
Default: 0

crosshairs
If true, you will get a crosshair centered 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

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

crosshairsVline
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

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

annotatableLinewidth
This is the linewidth of the annotations.
Default: 1

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. As of version 5.23 you can also set this to invert as well. If you do this on a dark background you may find that you need to change the highlightFill color setting as well.null
highlightStrokeIf you use tooltips, this controls the color of the highlight stroke.black
highlightFillIf you use tooltips, this controls the color 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 color to use when clearing the canvas.null
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. It's passed the shape object as an argument. As of version 5.23 you can also set this to invert as well. If you do this on a dark background you may find that you need to change the highlightFill color setting as well.
Default: null

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

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

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

barOffsety
This is the positioning offset that is applied to the bars (in the vertical direction).
Default: 0

linewidth
This is linewidth used for the stroke around the bars.
Default: 1

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 values of properties.

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

obj.getShape(event)
This method makes it easy to get hold of which bar has been clicked on or hovered over. It returns an object which has the following indexes available:
object The chart object
x The X coordinate
y The Y coordinate
width The width of the bar
height The height of the bar
dataset The zero-indexed "group". In a Waterfall chart there is only ever a single dataset so this is always zero.
index The zero-indexed numerical index of the bar.
sequentialIndex The zero-indexed sequential index of the bar. Because there's only a single dataset this is always the same as the index.
tooltip If a tooltip is associated with this bar this will be it.id: strings are expanded for you (where the tooltip text is retrieved from the HTML tag with the matching ID).
<script>
    obj.canvas.onclick = function (e)
    {
        RGraph.redraw();
    
        var canvas  = e.target,
            obj     = canvas.__object__,
            shape   = obj.getShape(e);

        if (shape) {
            var x      = shape.x,
                y      = shape.y,
                width  = shape.width,
                height = shape.height;
            
            obj.path(
                'b r % % % % s black f red',
                x, y, width, height
            );
        }
    }
</script>

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 that you wish to attach to and the second is the handler function. For example:

obj.on('draw', function (obj)
{
    // Put your 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,
        marginInner: 5,
        xaxisLabels: ['Hoolio','Jill','Pete','Kevin','Lucy','John']
    }
}).on('mousemove', function (e, shape)
{
    e.target.style.cursor = 'pointer';
}).on('click', function (e, shape)
{
    // Put your click event code here
}).draw()

obj.exec(function)

The exec function is documented here.


Custom RGraph events that are available

Custom RGraph events are events that RGraph fires when certain actions occur. There is a more comprehensive list of these events here . Here's some example code that show you how to add these events to your chart.

There's more documentation about events available here: Summary of events documentation

<script>
    waterfall = new RGraph.Waterfall({
        id: 'cvs',
        data: [4,6,-2,-4,8,-5,8],
        options: {
        }
    }).draw().on('click', function (e, shape)
    {
        // Add your click event listener code here

    }).on('mousemove', function (e, shape)
    {
        // Add your mousemove event listener code here

    }).on('mouseover', function (e, shape)
    {
        // Add your mouseover event listener code here

    }).on('mouseout', function (obj)
    {
        // Add your mouseout event listener code here
    });
</script>

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,
            marginInner: 5
        }
    }).grow({frames: 60}, myCallback)
</script>