Waterfall chart
- Example
- The coordinates properties
- Properties
- Methods
- Data properties that are used on the bars
- Events
Example
<script> data = [59,15,-50,-68,20,4,7]; function getDay (index) { var days = ['Monday','Tuesday','Wednesday','Thursday','Friday','Saturday','Sunday','Total']; // Add a crlf if (index % 2 === 1) { days[index] = '\r\n' + days[index]; } return days[index]; } function trim (str) { return str.trim(); } waterfall = new RGraph.SVG.Waterfall({ id: 'chart-container', data: data, options: { yaxisScaleMin: 'mirror', xaxisLabels: '%{function:getDay(%{index})}', xaxisColor: 'gray', yaxis: false, labelsAbove: true, labelsAboveUnitsPost: '%', labelsAboveLastBold: true, tooltips: '%{function:trim("%{property:xaxisLabels[%{index}]}")}: <br />%{key}', tooltipsFormattedKeyLabels: ['Incoming', 'Outgoing','Total'], tooltipsFormattedUnitsPost: 'm', colors: ['black','red','blue'], backgroundGridVlines: false, backgroundGridBorder: false, yaxisScaleMax: 100, marginBottom: 50, marginLeft: 40, marginInner: 10, labelsAboveSize: 12, textSize: 12, tooltipsCss: { backgroundColor: '#333', fontWeight: 'bold', fontSize: '14pt', opacity: 0.85 } } }).draw(); </script>
The coordinates properties
The coordinates of the bars on the Waterfall chart
are held in the
obj.coords
array. Each element in the array is an object
that consists of these properties:
object
- A reference to the chart objectelement
- A reference to thesvg
rect
elementx
- Thex-axis
coordinate for the bary
- They-axis
coordinate for the barwidth
- Thewidth
of the barheight
- Theheight
of the bar
So you could, for example, use this to get the width
of the first bar on the
chart:
obj.coords[0].width
Properties
You can use these properties to control how the chart appears. You can set them by including them in the options section of the configuration as shown above.
- Background properties
- Margin properties
- Color properties
- X-axis properties
- Y-axis properties
- Other text properties
- Tooltip properties
- Shadow properties
- Key properties
- Title properties
- Other properties
Background properties
The color of the background.
Default: null
backgroundImage
A URL of an image to render to the background.
Default: null
backgroundImageAspect
The aspect ratio setting of the
svg
image tag, eg it could be XMinYMin meet
.Default: none
backgroundImageOpacity
The
opacity
value of the background image.Default: 0.5
backgroundImageStretch
Whether the background image is stretched across the whole chart (except the margins).
Default: true
backgroundImageX
If you're not using the
backgroundImageStretch
option you can specify the x-axis
coordinate of the image.Default: null
backgroundImageX
If you're not using the
backgroundImageStretch
option you can specify the y-axis
coordinate of the image.Default: null
backgroundImageW
If you're not using the
backgroundImageStretch
option you can specify the width of the image.Default: null
backgroundImageH
If you're not using the
backgroundImageStretch
option you can specify the height of the image.Default: null
backgroundGrid
Whether to show the background grid or not.
Default: true
backgroundGridColor
The color of the background grid.
Default: #ddd
backgroundGridLinewidth
The
linewidth
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 grid lines.
Default: true
backgroundGridHlinesCount
Determines how many horizontal grid lines you have. The default is linked to how many scale labels that you have.
Default: null
backgroundGridVlines
Determines whether to draw the vertical grid lines.
Default: true
backgroundGridVlinesCount
Determines how many vertical grid lines you have. The default is to be linked to how many scale labels that you have.
Default: null
backgroundGridDashed
You can specify a dashed background grid by setting this to true. This option takes precedence over the dotted variant.
Default: false
backgroundGridDotted
You can specify a dotted background grid by setting this to true.
Default: false
backgroundGridDashArray
With this option you can specify exactly what the array used for the
linedash
setting should be. It should be an array consisting of two numbers.Default: null
Margin properties
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
marginInner
The horizontal margin (in pixels) of the chart. The horizontal margin is on either side of the bars.
Default: 5
Color properties
An array of the colors of the bars. You can specify four colors if you want and they are:
- The color used for positive bars (black).
- The color used for negative bars (red).
- The color used for total bars (blue).
- The color used for "mid-chart" total bars (blue, optional).
Default: ['black', 'red', 'blue']
colorsSequential
If
true
, for regular bar charts, (not stacked or grouped), the colors that you specify will be used sequentially.Default: false
colorsStroke
The color of the outline of the bars.
Default: #aaa
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
X-axis properties
Property | Description | Default |
---|---|---|
xaxis | Whether the x-axis is shown or not. | true |
xaxisLinewidth | The linewidth that's used to draw the x-axis . | 1 |
xaxisColor | The color of the x-axis . | black |
xaxisTickmarks | Whether the x-axis has tickmarks or not. | true |
xaxisTickmarksLength | The size of the x-axis tickmarks. | 5 |
xaxisLabelsOffsetx | The horizontal pixel offset that's added to the x-axis labels. | 0 |
xaxisLabelsOffsety | The vertical pixel offset that's added to the x-axis labels. | 0 |
xaxisLabelsColor | The color of the x-axis text. | null |
xaxisLabelsBold | Whether the x-axis text is bold or not. | null |
xaxisLabelsItalic | Whether the x-axis text is italic or not. | null |
xaxisLabelsFont | The font of the x-axis text. | null |
xaxisLabelsSize | The size of the x-axis text. | null |
xaxisLabelsAngle | If you have long labels you may want to set this to a number between 0 and 90 to enable angled labels. | null |
xaxisLabelsPositionSectionTickmarksCount | Not something you'll use often, if at all. Determines how many tickmarks there are. | null |
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) |
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 X coordinate of the x-axis title. | null |
xaxisTitleY | By giving this you can specifically set the Y coordinate of the x-axis title. | null |
xaxisTitleOffsetx | The horizontal pixel offset that's applied to the x-axis title. | 0 |
xaxisTitleOffsety | The vertical pixel offset that's applied to the x-axis title. | 0 |
xaxisTitleHalign | The horizontal alignment of the x-axis title. | null |
xaxisTitleValign | The vertical alignment of the x-axis title. | null |
Whether the
x-axis
is shown or not.Default: true
xaxisLinewidth
The
linewidth
that's used to draw the x-axis
.Default: 1
xaxisColor
The color of the
x-axis
.Default: black
xaxisTickmarks
Whether the
x-axis
has tickmarks or not.Default: true
xaxisTickmarksLength
The size of the
x-axis
tickmarks.Default: 5
xaxisLabelsOffsetx
The horizontal pixel offset that's added to the
x-axis
labels.Default: 0
xaxisLabelsOffsety
The vertical pixel offset that's added to the
x-axis
labels.Default: 0
xaxisLabelsColor
The color of the
x-axis
text.Default: null
xaxisLabelsBold
Whether the
x-axis
text is bold or not.Default: null
xaxisLabelsItalic
Whether the
x-axis
text is italic or not.Default: null
xaxisLabelsFont
The font of the
x-axis
text.Default: null
xaxisLabelsSize
The size of the
x-axis
text.Default: null
xaxisLabelsAngle
If you have long labels you may want to set this to a number between 0 and 90 to enable angled labels.
Default: null
xaxisLabelsPositionSectionTickmarksCount
Not something you'll use often, if at all. Determines how many tickmarks there are.
Default: null
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)
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 coordinate of the
x-axis
title.Default: null
xaxisTitleY
By giving this you can specifically set the Y coordinate of the
x-axis
title.Default: null
xaxisTitleOffsetx
The horizontal pixel offset that's applied to the
x-axis
title.Default: 0
xaxisTitleOffsety
The vertical pixel offset that's applied to the
x-axis
title.Default: 0
xaxisTitleHalign
The horizontal alignment of the
x-axis
title.Default: null
xaxisTitleValign
The vertical alignment of the
x-axis
title.Default: null
Y-axis properties
Whether the
y-axis
is shown or not.Default: true
yaxisPosition
This controls whether the
y-axis
is positioned on the left or the right.Default: left
yaxisColor
The color of the
y-axis
.Default: black
yaxisLinewidth
The
linewidth
that's used to draw the y-axis
.Default: 1
yaxisTickmarks
Whether the
y-axis
has tickmarks or not.Default: true
yaxisTickmarksLength
The size of the
y-axis
tickmarks.Default: 5
yaxisLabels
If the
yaxisScale
option is false then this can be used to give an array of labels that are shown on the y-axis
instead.Default: null
yaxisLabelsOffsetx
The horizontal pixel offset that's added to the
y-axis
labels.Default: 0
yaxisLabelsOffsety
The vertical pixel offset that's added to the
y-axis
labels.Default: 0
yaxisLabelsHalign
The horizontal alignment of the labels.
Default: right
yaxisLabelsValign
The vertical alignment of the labels.
Default: center
yaxisLabelsCount
The number of
y-axis
labels.Default: 5
yaxisLabelsPositionEdgeTickmarksCount
Not something you'll use often, if at all. Determines how many tickmarks there are.
Default: null
yaxisScale
Whether the
y-axis
scale is shown.Default: true
yaxisScaleUnitsPre
Units that are prepended to the scale numbers.
Default: (An empty string
yaxisScaleUnitsPost
Units that are appended to the scale numbers.
Default: (An empty string
yaxisScaleDecimals
The number of decimals that the scale will show.
Default: 0
yaxisScalePoint
The character(s) used as the decimal point.
Default: .
yaxisScaleThousand
The character(s) used as the thousand separator.
Default: ,
yaxisScaleRound
If set to true the max scale value will be rounded up.
Default: false
yaxisScaleMax
The maximum
y-axis
scale value.Default: null
yaxisScaleMin
The minimum
y-axis
scale value. As well as a numeric value you can also set this to mirror
so that the x-axis
is put in the center.Default: 0
yaxisScaleFormatter
This option should be a function. This function handles the entirety of the number formatting for the
y-axis
. Units are not added - decimals are not added - it's all up to you. The function is passed two arguments - the chart object and the number. It should look like this: yaxisFormatter: function (obj, num), { }
Default: null
yaxisLabelsColor
The color of the
y-axis
text.Default: null
yaxisLabelsBold
Whether the
y-axis
text is bold or not.Default: null
yaxisLabelsItalic
Whether the
y-axis
text is italic or not.Default: null
yaxisLabelsFont
The font of the
y-axis
text.Default: null
yaxisLabelsSize
The size of the
y-axis
text.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
yaxisTitleItalic
This controls whether the
y-axis
title is italic or not.Default: null
yaxisTitleColor
This controls the color of the
y-axis
title.Default: null
yaxisTitleX
By giving this you can specifically set the horizontal position of the
y-axis
title.Default: null
yaxisTitleY
By giving this you can specifically set the vertical position of the
y-axis
title.Default: null
yaxisTitleOffsetx
The horizontal pixel offset that's applied to the
y-axis
title.Default: 0
yaxisTitleOffsety
The vertical pixel offset that's applied to the
y-axis
title.Default: 0
yaxisTitleHalign
The horizontal alignment of the
y-axis
title.Default: null
yaxisTitleValign
The vertical alignment of the
y-axis
title.Default: null
Other text properties
Property | Description | Default |
---|---|---|
textColor | The color of the text. | black |
textFont | The font used for text. | Arial, Verdana, sans-serif |
textSize | The size of the text. | 12 |
textBold | Whether the text is bold or not. | false |
textItalic | Whether the text is italic or not. | false |
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 |
labelsAbove | Whether to show the labelsAbove style labels. | false |
labelsAbovePoint | The decimal point character to use for the labelsAbove labels. | null |
labelsAboveThousand | The thousand separator character to use for the labelsAbove labels. | null |
labelsAboveDecimals | The number of decimals to use for the labelsAbove labels. | 0 |
labelsAbovePre | A string to prepend to the labelsAbove labels. | null |
labelsAbovePost | A string to append to the labelsAbove labels. | null |
labelsAboveFormatter | A function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number. | null |
labelsAboveOffsetx | The horizontal offset of the labelsAbove labels. | 0 |
labelsAboveOffsety | The vertical offset of the labelsAbove labels. | 0 |
labelsAboveFont | The font of the labelsAbove labels. | null |
labelsAboveSize | The size of the labelsAbove labels. | null |
labelsAboveBold | Whether the labelsAbove labels are bold or not. | null |
labelsAboveItalic | Whether the labelsAbove labels are italic or not. | null |
labelsAboveColor | The color of the labelsAbove labels. | null |
labelsAboveBackground | The background color of the labelsAbove labels. | null |
labelsAboveBackgroundPadding | The padding of the labelsAbove labels. | 0 |
labelsAboveHalign | The horizontal alignment of the labelsAbove . | left |
labelsAboveValign | The vertical alignment of the labelsAbove . | center |
labelsAboveSpecific | This property allows you to make the labelsAbove labels specific strings. | null |
labelsAboveLastFont | This allows you to specify the font for the last labelsAbove label. | null |
labelsAboveLastBold | This allows you to specify whether the text is bold or not for the last labelsAbove label. | null |
labelsAboveLastItalic | This allows you to specify whether the text is italic or not for the last labelsAbove label. | null |
labelsAboveLastSize | This allows you to specify the size for the last labelsAbove label. | null |
labelsAboveLastColor | This allows you to specify the color for the last labelsAbove label. | null |
labelsAboveLastBackground | This allows you to specify the background color for the last labelsAbove label. | null |
labelsAboveLastBackgroundPadding | This allows you to specify the background padding for the last labelsAbove label. | null |
The color of the text.
Default: black
textFont
The font used for text.
Default: Arial, Verdana, sans-serif
textSize
The size of the text.
Default: 12
textBold
Whether the text is bold or not.
Default: false
textItalic
Whether the text is italic or not.
Default: false
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
labelsAbove
Whether to show the
labelsAbove
style labels.Default: false
labelsAbovePoint
The decimal point character to use for the
labelsAbove
labels.Default: null
labelsAboveThousand
The thousand separator character to use for the
labelsAbove
labels.Default: null
labelsAboveDecimals
The number of decimals to use for the
labelsAbove
labels.Default: 0
labelsAbovePre
A string to prepend to the
labelsAbove
labels.Default: null
labelsAbovePost
A string to append to the
labelsAbove
labels.Default: null
labelsAboveFormatter
A function that handles ALL of the formatting of the number. The function is passed two arguments - the object and the unformatted number.
Default: null
labelsAboveOffsetx
The horizontal offset of the
labelsAbove
labels.Default: 0
labelsAboveOffsety
The vertical offset of the
labelsAbove
labels.Default: 0
labelsAboveFont
The font of the
labelsAbove
labels.Default: null
labelsAboveSize
The size of the
labelsAbove
labels.Default: null
labelsAboveBold
Whether the
labelsAbove
labels are bold or not.Default: null
labelsAboveItalic
Whether the
labelsAbove
labels are italic or not.Default: null
labelsAboveColor
The color of the
labelsAbove
labels.Default: null
labelsAboveBackground
The background color of the
labelsAbove
labels.Default: null
labelsAboveBackgroundPadding
The padding of the
labelsAbove
labels.Default: 0
labelsAboveHalign
The horizontal alignment of the
labelsAbove
.Default: left
labelsAboveValign
The vertical alignment of the
labelsAbove
.Default: center
labelsAboveSpecific
This property allows you to make the
labelsAbove
labels specific strings.Default: null
labelsAboveLastFont
This allows you to specify the font for the last
labelsAbove
label.Default: null
labelsAboveLastBold
This allows you to specify whether the text is bold or not for the last
labelsAbove
label.Default: null
labelsAboveLastItalic
This allows you to specify whether the text is italic or not for the last
labelsAbove
label.Default: null
labelsAboveLastSize
This allows you to specify the size for the last
labelsAbove
label.Default: null
labelsAboveLastColor
This allows you to specify the color for the last
labelsAbove
label.Default: null
labelsAboveLastBackground
This allows you to specify the background color for the last
labelsAbove
label.Default: null
labelsAboveLastBackgroundPadding
This allows you to specify the background padding for the last
labelsAbove
label.Default: null
Tooltip properties
Property | Description | Default |
---|---|---|
tooltips | An array of tooltips for the chart. You can also check the canvas tooltips documentation for more information. | null |
tooltipsOverride | If required, this can be a function that handles the tooltip showing instead of the default RGraph tooltips. It should look like this: tooltipsOverride: function (obj, opt)
{
// Show tooltip
} The opt argument contains these items:
| null |
tooltipsEvent | The event used for tooltips (either click or mousemove . | click |
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) |
tooltipsFormattedKeyLabels | The labels that are used in the formatted tooltip key. These are (in order):
| [] (an empty array) |
tooltipsFormattedKeyColors | The colors that are used in the formatted tooltip key. See the colors property for what colors you can specify. | 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 |
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 in the canvas documentation, 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: tooltips: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' } | null |
tooltipsPointerOffsetx | This allows you to adjust the horizontal position of the tooltips pointer. | 0 |
tooltipsPointerOffsety | This allows you to adjust the vertical position of the tooltips pointer. | 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 |
tooltipsCss | If you want to specify some css that gets applied to all of the tooltips, but don't want to use the RGraph.SVG.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object css for the tooltips. These are css styles that get applied to all of the tooltips for the specific object only. It should look like this:tooltipsCss: { fontFamily: 'Verdana', fontSize: '20pt' } | null |
tooltipsCssClass | The css class that's applied to the tooltip div . | RGraph_tooltip |
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 |
highlightStroke | The stroke color that's used when highlighting the chart. | rgba(0,0,0,0) |
highlightFill | The fill color that's used when highlighting the chart. | rgba(255,255,255,0.7) |
highlightLinewidth | The linewidth that's used when highlighting the chart. | 1 |
An array of tooltips for the chart. You can also check the canvas tooltips documentation for more information.
Default: null
tooltipsOverride
If required, this can be a function that handles the tooltip showing instead of the default RGraph tooltips. It should look like this:
tooltipsOverride: function (obj, opt)
{
// Show tooltip
}
The opt argument contains these items: object
The chart object.index
The index of the element (that triggered the tooltip).sequentialIndex
The sequential index of the element that was clicked.text
The text to be used as the tooltip. Remember that this may containhtml
(or whatever else you may have specified).event
The event object (either aclick
ormousemove
event).
Default: null
tooltipsEvent
The event used for tooltips (either
click
or mousemove
.Default: click
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)
tooltipsFormattedKeyLabels
The labels that are used in the formatted tooltip key. These are (in order):
- Label for positive columns.
- Label for outgoing columns.
- Label for the total column.
- Labels for mid-data total columns.
Default: [] (an empty array)
tooltipsFormattedKeyColors
The colors that are used in the formatted tooltip key. See the colors property for what colors you can specify.
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
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 in the
canvas
documentation, 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: tooltips: { borderLeft: 'gray 2px solid', borderBottom: 'gray 2px solid' }
Default: null
tooltipsPointerOffsetx
This allows you to adjust the horizontal position of the tooltips pointer.
Default: 0
tooltipsPointerOffsety
This allows you to adjust the vertical position of the tooltips pointer.
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
tooltipsCss
If you want to specify some
css
that gets applied to all of the tooltips, but don't want to use the RGraph.SVG.tooltips.style
object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object css
for the tooltips. These are css
styles that get applied to all of the tooltips for the specific object only. It should look like this:tooltipsCss: { fontFamily: 'Verdana', fontSize: '20pt' }
Default: null
tooltipsCssClass
The
css
class that's applied to the tooltip div
.Default: RGraph_tooltip
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
highlightStroke
The stroke color that's used when highlighting the chart.
Default: rgba(0,0,0,0)
highlightFill
The fill color that's used when highlighting the chart.
Default: rgba(255,255,255,0.7)
highlightLinewidth
The
linewidth
that's used when highlighting the chart.Default: 1
Shadow properties
Whether a drop shadow is applied to the lines.
Default: false
shadowOffsetx
The horizontal offset of the shadow.
Default: 2
shadowOffsety
The vertical offset of the shadow.
Default: 2
shadowBlur
The extent of the blurring effect that's applied to the shadow.
Default: 2
shadowColor
The color of the shadow.
Default: rgba(0,0,0,0.25)
Key properties
An array of the labels that appear on the key.
Default: null
keyColors
An array of colors to be shown on the key. If not specified then the
colors
option will be used instead.Default: null
keyLabelsColor
The color of the text in the key.
Default: null
keyLabelsBold
Whether the key text is bold or not.
Default: null
keyLabelsFont
The font to use for the key text. If not specified it defaults to the
textFont
setting.Default: null
keyLabelsSize
The size to use for the key text. If not specified then the
textSize
is used.Default: null
ketLabelsItalic
Whether the key text is italic or not.
Default: null
keyLabelsOffsetx
The horizontal pixel offset of the key text (just the text).
Default: 0
keyLabelsOffsety
The vertical pixel offset of the key text (just the text).
Default: -1
keyOffsetx
The horizontal pixel offset of the entire key.
Default: 0
keyOffsety
The horizontal pixel offset of the entire key.
Default: 0
keyColorShape
This controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are:
rect
circle
triangle
line
dot
rectdot
Default: rect
Title properties
The title of the chart.
Default: (An empty string)
titleX
The specific
x-axis
coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.Default: null
titleY
The specific
y-axis
coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.Default: null
titleOffsetx
An offset value that is added to the calculated
x-axis
coordinate.Default: 0
titleOffsety
An offset value that is added to the calculated
y-axis
coordinate.Default: 0
titleHalign
The horizontal alignment of the title.
Default: center
titleColor
The color of the title.
Default: null
titleFont
The font used to render the title.
Default: null
titleSize
The size of the font used to render the title.
Default: null
titleBold
Whether the title is bold or not.
Default: null
titleItalic
Whether the title is italic or not.
Default: null
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: (An empty string)
titleSubtitleColor
The color of the subtitle.
Default: #aaa
titleSubtitleFont
The font used to render the subtitle.
Default: null
titleSubtitleSize
The size of the font used to render the subtitle. It defaults to be the same as the
textSize
setting.Default: null
titleSubtitleBold
Whether the subtitle is bold or not.
Default: null
titleSubtitleItalic
Whether the subtitle is italic or not.
Default: null
Other properties
Property | Description | Default |
---|---|---|
linewidth | The linewidth (around the bars) used. | 1 |
total | Whether to show the total at the end or not. | true |
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 |
The
linewidth
(around the bars) used.Default: 1
total
Whether to show the total at the end or not.
Default: true
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)
This can be used to get properties if necessary. It's normally used after the chart is drawn if you need to get parameters (if you're doing custom coding for example).
obj.set(name, value)
This can be used to set properties if necessary. It's normally used after the chart is drawn if you need to set additional parameters or change them.
obj.getYCoord(value)
This method can be used to get an appropriate y-axis
coordinate for a value when you're
doing custom drawing on the chart. It returns null
if the value is out of
range.
obj.on(event, handler)
This function adds an event listener (such as beforedraw
or
draw
) to the chart object. For example:
obj.on('draw', function (obj)
{
// Put your code here
});
obj.exec(func)
This function can be used to execute a function (immediately). It's not event-based
(ie it doesn't run when something happens) - it just runs immediately - and only once.
You might use it when you need to get something from the chart when it's drawn and
then call the RGraph.SVG.redraw
function. Because this function only runs once the RGraph.SVG.redraw
function would not cause a loop - which would happen if you used the draw
event.
obj.exec(function (obj)
{
// Put your code here
});
obj.responsive(configuration)
The responsive
function helps your charts
respond to different browser window sizes and screen
resolutions. For example, for smaller screens, you
might want to have angled labels or show shorter
versions of them completely.
Update: There is now the responsive configuration option available to you and this is now the preferred method of configuration.
The responsive function and configuration option are documented on their own page here.
Data properties that are used on the bars
The svg
elements that represent the bars on the Waterfall chart
have
various data attributes added to them that hold various bits of information. These
are:
- data-index
- data-original-x
- data-original-y
- data-original-width
- data-original-height
- data-original-stroke
- data-original-fill
- data-value
These can be retrieved by using standard dom
methods:
obj.coords[0].element.getAttribute('data-index');
Events
RGraph supports custom events that allow you to easily add interactivity to your charts if required. The following events are available:
beforedraw
This event fires at the start of thedraw
method before anything has been done.draw
This event fires at the end of thedraw
function.firstdraw
This event fires at the end of thedraw
function - but only the first time and so it fires only once after the firstdraw
call.beforetooltip
This event fires at the start of the tooltip showing process.tooltip
This event fires after a tooltip has been shown.
new RGraph.SVG.Waterfall({ id: 'chart-container', data: [1,5,6,-4,2,5,-3,5], options: { } }).on('tooltip', function (obj) { console.log('The draw event has fired'); }).draw();