Waterfall chart
Example
<script> new RGraph.Waterfall({ id: 'cvs', data: [90, -16, -18, -34,43,82,53], options: { marginTop: 50, 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
- X-axis properties
- Y-axis properties
- Color properties
- Margin properties
- Labels and text properties
- Title properties
- Shadow properties
- Key properties
- Interactive features properties
- Miscellaneous properties
Background properties
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 is drawn around the grid.
Default: true
backgroundGridHlines
Determines whether to draw the horizontal gridlines.
Default: true
backgroundGridVlines
Determines whether to draw the vertical gridlines.
Default: true
backgroundGridHlinesCount
When using autofit this allows you to specify how many horizontal gridlines 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
Property | Description | Default |
---|---|---|
xaxis | Set this to true if you don't want an x-axis . | 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. | bottom |
xaxisLinewidth | The linewidth used for the x-axis and the x-axis tickmarks. | 1 |
xaxisColor | The color of the x-axis (and its tickmarks. | black |
xaxisTickmarks | Whether the x-axis tickmarks are shown. | true |
xaxisTickmarksLastLeft | Whether the last tickmark on the left is displayed. | null |
xaxisTickmarksLastRight | Whether the last tickmark on the right is displayed. | null |
xaxisTickmarksLength | The length of the tickmarks. | 3 |
xaxisTickmarksCount | The number of tickmarks that are shown on the x-axis . | null |
xaxisLabels | An array of the labels to be used on the chart. You can also give this option a string if you prefer and use formatted labels. | An empty array |
xaxisLabelsFont | The font used to render the labels. | null |
xaxisLabelsSize | The size of the labels. | null |
xaxisLabelsColor | The color of the labels. | null |
xaxisLabelsBold | Whether the labels are bold or not. | null |
xaxisLabelsItalic | Whether the labels are italic or not. | null |
xaxisLabelsOffsetx | This allows you finer-grained control in the horizontal direction over the X label positioning if you need it. | 0 |
xaxisLabelsOffsety | This allows you finer-grained control in the vertical direction over the X label positioning if you need it. | 0 |
xaxisLabelsFormattedDecimals | When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. | 0 |
xaxisLabelsFormattedPoint | When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro. | . |
xaxisLabelsFormattedThousand | When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro. | , |
xaxisLabelsFormattedUnitsPre | When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro. | (an empty string) |
xaxisLabelsFormattedUnitsPost | When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro. | (an empty string) |
xaxisLabelsHalign | The horizontal alignment of the labels. | center |
xaxisLabelsValign | The vertical alignment of the labels. | top |
xaxisLabelsAngle | The angle of the x-axis labels. For example, you could set this to 45 to get angled labels. | 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. | section |
xaxisLabelsClass | This property allows you to add your own css class to the x-axis labels which you can then use for styling purposes or to make retrieving the span tags easier (the dom elements). If you inspect the labels in your browser's javascript console (you will first need to enable the textAccessiblePointerevents property) you will be able to see the other css classes that are assigned to the labels. | [none] |
xaxisLabelsSpecificAlign | This determines the alignment of the specific labels. You probably won't need this. | left |
xaxisTitle | This allows you to specify a title for the x-axis . | none |
xaxisTitleSize | This allows you to specify a size for the x-axis title. | null |
xaxisTitleFont | This allows you to specify a font for the x-axis title. | null |
xaxisTitleBold | This controls whether the x-axis title is bold or not. | null |
xaxisTitleItalic | This controls whether the x-axis title is italic or not. | null |
xaxisTitleColor | This controls the color of the x-axis title. | null |
xaxisTitleX | By giving this you can specifically set the position of the x-axis title. | null |
xaxisTitleY | By giving this you can specifically set the Y position of the x-axis title. | null |
xaxisTitleOffsetx | The horizontal pixel offset that's applied to the title. | 0 |
xaxisTitleOffsety | The vertical pixel offset that's applied to the title. | 0 |
xaxisTitleHalign | The horizontal alignment of the title. | center |
xaxisTitleValign | The vertical alignment of the title. | 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. | null |
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. You can also give this option a string if you prefer and use formatted labels.
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
xaxisLabelsFormattedDecimals
When using formatted labels this is the number of decimals that are applied to the
%{value_formatted}
macro.Default: 0
xaxisLabelsFormattedPoint
When using formatted labels this is the decimal point character that's used with the
%{value_formatted}
macro.Default: .
xaxisLabelsFormattedThousand
When using formatted labels this is the thousand separator character that's used with the
%{value_formatted}
macro.Default: ,
xaxisLabelsFormattedUnitsPre
When using formatted labels these are the units that are prepended to the number with the
%{value_formatted}
macro.Default: (an empty string)
xaxisLabelsFormattedUnitsPost
When using formatted labels these are the units that are appended to the number with the
%{value_formatted}
macro.Default: (an empty string)
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
xaxisLabelsClass
This property allows you to add your own
css
class to the x-axis
labels which you can then use for styling purposes or to make retrieving the span
tags easier (the dom
elements). If you inspect the labels in your browser's javascript
console (you will first need to enable the textAccessiblePointerevents
property) you will be able to see the other css
classes that are assigned to the labels.Default: [none]
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 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 horizontal pixel offset that's applied to the title.
Default: 0
xaxisTitleOffsety
The vertical 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
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 does not affect 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 that's used as the decimal point.
Default: .
yaxisScaleThousand
The character that's used as the thousand separator.
Default: ,
yaxisScaleInvert
Whether the
y-axis
scale is inverted or not.Default: false
Color properties
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 sequentially.Default: false
colorsConnectors
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 visibleDefault: #666
Margin properties
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
Labels and text properties
Property | Description | Default |
---|---|---|
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> | false |
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. | visible |
textAccessiblePointerevents | This controls whether the dom text responds to mouse-based events or not (it sets the pointer-events css property to none ). | true |
textColor | The color of the text on the chart. | black |
textSize | The size of the text on the chart. | 12 |
textFont | The font used to render the text on the chart. | Arial, Verdana, sans-serif |
textBold | Whether the text on the chart is bold or not. | false |
textItalic | Whether the text on the chart is italic or not. | false |
labelsAbove | Whether the labelsAbove labels are enabled. These sit just above the bars (or below them if the bars are negative). | false |
labelsAboveFont | The font to use when rendering the labelsAbove text. | null |
labelsAboveSize | The size of the labelsAbove text. | 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. | null |
labelsAboveBold | Whether the labelsAbove labels are bold or not. | null |
labelsAboveItalic | Whether the labelsAbove labels are italic or not. | null |
labelsAboveUnitsPre | A string that is appended to the number. | (An empty string) |
labelsAboveUnitsPost | A string that is prepended to the number. | (An empty string) |
labelsAboveDecimals | The number of decimals that are displayed. | 0 |
labelsAbovePoint | This can be a character (or multiple characters) that is to be used as the decimal separator in the labels. | . |
labelsAboveThousand | This can be a character (or multiple characters) that is to be used as the thousand separator in the labels. | , |
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; } | 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. | null |
labelsAboveOffsetx | If you want to alter the position of the labels in the horizontal direction you can use this property. | 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). | 0 |
labelsAboveTotalFont | The font to use when rendering the final labelsAbove label. | null |
labelsAboveTotalSize | The size of the final labelsAbove label. | 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. | null |
labelsAboveTotalBold | Whether the final labelsAbove label is bold or not. | null |
labelsAboveTotalItalic | Whether the final labelsAbove label is italic or not. | null |
labelsAboveTotalDecimals | The number of decimals that are displayed on the final label. | null |
labelsAboveTotalUnitsPre | A string that is appended to the number on the final labelsAbove label. | null |
labelsAboveTotalUnitsPost | A string that is prepended to the number on the final labelsAbove label. | null |
labelsAboveTotalPoint | This can be a character (or multiple characters) that is to be used as the decimal separator in the final label. | null |
labelsAboveTotalThousand | This can be a character (or multiple characters) that is to be used as the thousand separator in the final label. | 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; } | null |
labelsAboveTotalOffsetx | This allows you finer-grained control in the horizontal direction over the text positioning if you need it. | 0 |
labelsAboveTotalOffsety | This allows you finer-grained control in the vertical direction over the text positioning if you need it. | 0 |
text | This allows you to add custom text to your chart if you want to. There's a dedicated page that describes this option here. | null |
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: false
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
labelsAboveTotalOffsetx
This allows you finer-grained control in the horizontal direction over the text positioning if you need it.
Default: 0
labelsAboveTotalOffsety
This allows you finer-grained control in the vertical direction over the text positioning if you need it.
Default: 0
text
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
Title properties
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
4pt
bigger than the textSize
setting.Default: null
titleBold
Whether the title is bold or not.
Default: null
titleItalic
Whether the title is italic or not.
Default: null
titleColor
The color of 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)
titleOffsetx
You can use this property to adjust the positioning of the title in the horizontal direction (positive values adjust the title to the right and negative values adjust it to the left).
Default: 0
titleOffsety
You can use this property to adjust the positioning of the title in the vertical direction (positive values adjust the title downwards and negative values adjust it upwards).
Default: 0
titleSubtitle
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: null
titleSubtitleSize
The size of the font used to render the subtitle.
Default: null
titleSubtitleColor
The color of the subtitle.
Default: #aaa
titleSubtitleFont
The font used to render the subtitle.
Default: null
titleSubtitleBold
Whether the subtitle is bold or not.
Default: null
titleSubtitleItalic
Whether the subtitle is italic or not.
Default: null
titleSubtitleOffsetx
Use this property to adjust the horizontal position of the subtitle.
Default: 0
titleSubtitleOffsety
Use this property to adjust the vertical position of the subtitle.
Default: 0
Shadow properties
Whether a drop shadow is applied.
Default: false
shadowColor
The color of the shadow.
Default: #666
shadowOffsetx
The horizontal offset of the shadow.
Default: 3
shadowOffsety
The vertical 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
Property | Description | Default |
---|---|---|
contextmenu | An array of context menu items. More information about context menus is here. | [] (An empty array) |
tooltips | A numerically indexed array of tooltips that are shown when a bar is clicked. These can contain html . | null |
tooltipsEffect | The effect used for showing tooltips. Possible values are slide fade or none . | slide |
tooltipsEvent | This is the event that triggers the tooltips. It can be either click or mousemove . | 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. | null |
tooltipsFormattedPoint | When using formatted tooltip strings this is used as the point when using the %{value_formatted} option. | . |
tooltipsFormattedThousand | When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option. | , |
tooltipsFormattedDecimals | When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option. | 0 |
tooltipsFormattedUnitsPre | When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option. | (an empty string) |
tooltipsFormattedUnitsPost | When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option. | (an empty string) |
tooltipsFormattedKeyColors | When using formatted tooltip strings you can give specific colors for the %{key} option to use. | null |
tooltipsFormattedKeyColorsShape | This is the shape that's used in the tooltip key. It can be square or circle | 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: "1px solid #ddd"; } | null |
tooltipsFormattedKeyLabels | When using formatted tooltip strings these are the labels that are displayed. | [] (an empty array) |
tooltipsFormattedListType | With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol . | ul |
tooltipsFormattedListItems | 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; } | null |
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. | 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. | 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. | true |
tooltipsPointerCss | 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: tooltipsPointerCss: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' } | null |
tooltipsPointerOffsetx | This allows you to adjust the vertical position of the tooltips pointer. | 0 |
tooltipsPointerOffsety | This allows you to adjust the vertical position of the tooltips pointer (for example, if you add a border you may need to move it down slightly). | 0 |
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. | true |
tooltipsCssClass | This is the name of the css class the chart uses. | 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' } | null |
tooltipsOffsetx | This property allows you to shift the tooltips left or right. | 0 |
tooltipsOffsety | This property allows you to shift the tooltips up or down. | 0 |
tooltipsHotspotIgnore | This can be a number of things and can be used to ignore certain tooltip hotspots - which can allow charts to the rear to be clickable. There's an example of this in the download archive called pie-tooltipshotspotignore.html . You can use the transparent color to allow the rear chart to be seen in such a case. It can be:
| null |
crosshairs | If true, you will get a crosshair centered on the current mouse position. | false |
crosshairsLinewidth | This controls the linewidth of the crosshairs. | 1 |
crosshairsColor | The color of the crosshairs. | #333 |
crosshairsHline | This determines whether the horizontal crosshair is shown. | true |
crosshairsVline | This determines whether the vertical crosshair is shown. | true |
annotatable | Whether annotations are enabled for the chart (ie you can draw on the chart interactively. | false |
annotatableColor | If you do not allow the use of the palette, then this will be the only color allowed for annotations. | black |
annotatableLinewidth | This is the linewidth of the annotations. | 1 |
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. Possible values are
slide
fade
or none
.Default: slide
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
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: "1px solid #ddd"; }
Default: null
tooltipsFormattedKeyLabels
When using formatted tooltip strings these are the labels that are displayed.
Default: [] (an empty array)
tooltipsFormattedListType
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are
ul
and ol
.Default: ul
tooltipsFormattedListItems
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
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 (a css
border, for example) then specify an object containing those values to this property. For example: tooltipsPointerCss: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' }
Default: null
tooltipsPointerOffsetx
This allows you to adjust the vertical position of the tooltips pointer.
Default: 0
tooltipsPointerOffsety
This allows you to adjust the vertical position of the tooltips pointer (for example, if you add a border you may need to move it down slightly).
Default: 0
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
tooltipsHotspotIgnore
This can be a number of things and can be used to ignore certain tooltip hotspots - which can allow charts to the rear to be clickable. There's an example of this in the download archive called
pie-tooltipshotspotignore.html
. You can use the transparent
color to allow the rear chart to be seen in such a case. It can be:
- A single
boolean
value (ietrue
orfalse
) to enable or disable all of the hotspots -true
means the hotspot will be ignored - A single number (the zero-indexed number corresponding to the hotspot to ignore)
- An array of numbers (the numbers are the indexes of hotspots to ignore)
- An array of
boolean
true
orfalse
values - the position of these values correspond to the index(es) of the segments to ignore (for example[false, false, true, false, false]
-true
means the corresponding hotspot will be ignored)
Default: null
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
Property | Description | Default |
---|---|---|
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. | null |
highlightStroke | If you use tooltips, this controls the color of the highlight stroke. | black |
highlightFill | If you use tooltips, this controls the color of the highlight fill. | 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 . | 0 |
barOffsety | This is the positioning offset that is applied to the bars (in the vertical direction). | 0 |
linewidth | This is linewidth used for the stroke around the bars. | 1 |
clearto | This is used in animations and effects as the default color to use when clearing the canvas . | null |
responsive | 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. | null |
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
responsive
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)
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 similarly 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.
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.
Events
RGraph supports custom events that allow you to easily add interactivity to your charts if required. The following events are available:
annotatebegin
This event fires at the start of annotating - like the standardmousedown
event.annotate
This event fires (repeatedly) during annotating - like the standardmousemove
event.annotateend
This event fires at the end of annotating - like the standardmouseup
event.annotateclear
This event fires at the end of theRGraph.clearAnnotations
function.beforeclear
This event fires at the start of theRGraph.clear
function.clear
This event fires at the end of theRGraph.clear
function.click
This is similar to the standardcanvas
click
event but this only fires when you click on a bar - not the wholecanvas
.beforecontextmenu
This event fires when you have the contextmenu enabled and it is about to appear.contextmenu
This event fires when you have the contextmenu enabled and it has been displayed.beforedraw
This event fires at the start of thedraw
method before anything has been done.firstdraw
This event fires at the end of thedraw
function - but only the first time that thedraw
function is called.draw
This event fires at the end of thedraw
function.beforeinteractivekey
When you're using the interactive key this event fires just before the key and chart are highlighted.afterinteractivekey
When you're using the interactive key this event fires just after the key and chart are highlighted.keyclick
This event fires when you click on the key - you don't have to be using the interactive key however.mousemove
This event is similar to the standardmousemove
event but only fires when you move the mouse over a bar on the chart.mouseover
This event is similar to the standardmouseover
event but only fires when you move the mouse over a bar on the chart.mouseout
This event is similar to the standardmouseout
event but only fires when you move the mouse away from a bar on the chart that you've previously hovered over.beforetooltip
This event fires at the start of the tooltip showing process.tooltip
This event fires after a tooltip has been shown.
new RGraph.Waterfall({ id: 'cvs', data: [4,8,6,3,5,8,9], options: { } }).on('draw', function (obj) { console.log('The draw event has fired'); }).draw();
Effects
These effects are available and can be used instead of thedraw
function. There are also generic effects available which
you can see here: Generic effects and transitions
- The
grow
effect (effects-waterfall-grow.html
in the download archive)
<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>