RGraph is a JavaScript charts library based on
HTML5 SVG and canvas. RGraph is mature (over 17 years
old) and has a wealth of features making it an ideal
choice to use for showing charts on your website.
Get the latest version of RGraph (version 6.20, 1st December 2024) from
the download page. You can read the changelog here. There's also older versions available,
minified files and links to cdnjs.com hosted libraries.
<script>
labels = ['Start point','Stage 1','Stage 2','Stage 3'];
new RGraph.SVG.Funnel({
id: 'chart-container',
data: [100,75,50,25],
options: {
title: 'A "key stages of plan CD1" funnel',
titleSubtitle: 'Each stage is depicted by a separate color',
marginTop: 45,
marginLeft: 300,
marginRight: 5,
linewidth: 0,
colors: ['#3EB0BB', '#EE7E34', '#677E9D'],
backgroundBars: true,
labels: '%{global:labels[%{index}]} (%{value_formatted})',
labelsFormattedUnitsPost: '%',
labelsSize: 26,
labelsItalic: true,
labelsColor: 'gray',
labelsHalign: 'left',
labelsPosition: 'edge',
tooltips: 'Value at this point: <b>%{value_formatted}%</b>',
tooltipsCss: {
backgroundColor: '#333',
fontWeight: 'bold',
fontSize: '14pt',
opacity: 0.85
}
}
}).draw();
</script>
The coordinates properties
The coordinates for the segments on the Funnel chart are held in
the obj.coords array:
obj.coords
All of the coordinates - that are simply appended to this
array as the segments are drawn. Each element of the array is
an object which consists of x1, y1, x2,
y2, x3, y3, x4, x4,
widthTop, widthBottom, height,
element and object properties. The element
property is the svg element and the object property
is the RGraph object.
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.
A true or false value that determines whether the background bars are shown.
Default: false
Name: backgroundBarsOpacity
Description:
This controls the opacity used for the background bars (ie how transparent they are). 1 is fully opaque ie not transparent at all.
Default: 0.25
Name: backgroundBarsColors
Description:
By default the colors of the background bars are the same as the regular colors array but with the opacity set to the backgroundBarsOpacity setting. If you want to set specific colors though, then you can use this property.
This can be section or edge and controls the placement of the labels (ie where they're aligned to).
Default: section
Name: labelsFormattedDecimals
Description:
When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro.
Default: 0
Name: labelsFormattedPoint
Description:
When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro.
Default: .
Name: labelsFormattedThousand
Description:
When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro.
Default: ,
Name: labelsFormattedUnitsPre
Description:
When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro.
Default: (an empty string)
Name: labelsFormattedUnitsPost
Description:
When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro.
Default: (an empty string)
Tooltip properties
Name: tooltips
Description:
An array of tooltips for the chart. This array should NOT be multidimensional. You can also check the canvas tooltips documentation for more information.
Default: null
Name: tooltipsOverride
Description:
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 is an argument that contains these items:
object The chart object.
index The index of the element (that triggered the tooltip).
sequentialIndex The sequential index of the element that was clicked.
text The text to be used as the tooltip. Remember that this may contain html (or whatever else you may have specified).
event The event object (either a click or mousemove event).
Default: null
Name: tooltipsEvent
Description:
The event used for tooltips (either click or mousemove.
Default: click
Name: tooltipsPersistent
Description:
If you want the tooltips to persist after a click (ie they don't disappear) then you can set this property to true to get this behaviour. Keep in mind that if you have a lot of bars/segments/points/etc then it's possible for the chart to become quite crowded. If you need to subsequently clear all of the tooltips there's an api function available to do that for you and it's called: RGraph.SVG.tooltip.persistent.clear() If you want to access any (or all) of the tooltip div tags then you can do so using the RGraph.SVG.tooltip.persistent object. This option works when you have the tooltipsEvent property set to mousemove
Default: false
Name: tooltipsFormattedPoint
Description:
When using formatted tooltip strings this is used as the point when using the %{value_formatted} option.
Default: .
Name: tooltipsFormattedThousand
Description:
When using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.
Default: ,
Name: tooltipsFormattedDecimals
Description:
When using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.
Default: 0
Name: tooltipsFormattedUnitsPre
Description:
When using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.
Default: (an empty string)
Name: tooltipsFormattedUnitsPost
Description:
When using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.
Default: (an empty string)
Name: tooltipsFormattedKeyLabels
Description:
The labels that are used in the formatted tooltip key.
Default: [] (an empty array)
Name: tooltipsFormattedKeyColors
Description:
The colors that are used in the formatted tooltip key. Normally these are automatically taken from the colors on the chart but can be specified differently using this property.
Default: null
Name: tooltipsFormattedKeyColorsShape
Description:
This is the shape that's used in the tooltip key. It can be square or circle
Default: square
Name: tooltipsFormattedKeyColorsCss
Description:
By using this property you can add css values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of css properties like this:
With this property you can switch between an unordered list (the default) and an ordered list. Possible values are ul and ol.
Default: ul
Name: tooltipsFormattedListItems
Description:
This should be a two-dimension array of the list items that are to be shown for all of the tooltips. An example of this property is:
tooltipsFormattedListItems: [
['Bill','Jerry','Berty'], // First tooltip
['Gill','Carrie','Lucy'], // Second tooltip
['Pob','Nobby','Hilda'] // Third tooltip
]
You can use css to style this list - for example:
.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
text-align: left;
color: yellow;
}
Default: null
Name: tooltipsFormattedTableHeaders
Description:
When showing a table in the tooltips this can be an array of headers for the table. These are added to the tooltip using th tags.
Default: null
Name: tooltipsFormattedTableData
Description:
This is the data that is added to the table. This is a 3-dimensional array so it's easy to make a mistake. See the example in the canvas documentation, copy the code from it and then modify it suit. You'll create fewer bugs this way.
Default: null)
Name: tooltipsPointer
Description:
By default the tooltips have a small triangular pointer that points to the shape that was clicked on. You can turn this off with this property.
Default: true
Name: tooltipsPointerCss
Description:
If you want any css values applied to the tooltips pointer (a css border, for example) then specify an object containing those values to this property. For example:
This allows you to adjust the horizontal position of the tooltips pointer.
Default: 0
Name: tooltipsPointerOffsety
Description:
This allows you to adjust the vertical position of the tooltips pointer.
Default: 0
Name: tooltipsPositionStatic
Description:
The new default (as of August 2020) is for tooltips to be positioned statically and not be dependent on the mouse position. If you don't want this for whatever reason, you can disable it with this setting. When you set it to false tooltips are positioned next to the mouse pointer.
Default: true
Name: tooltipsCss
Description:
If you want to specify some css that gets applied to all of the tooltips, but don't want to use the RGraph.SVG.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-objectcss 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:
This property allows you to shift the tooltips left or right.
Default: 0
Name: tooltipsOffsety
Description:
This property allows you to shift the tooltips up or down.
Default: 0
Name: highlightStroke
Description:
The stroke color that's used when highlighting the chart.
Default: rgba(0,0,0,0)
Name: highlightFill
Description:
The fill color that's used when highlighting the chart.
Default: rgba(255,255,255,0.7)
Name: highlightLinewidth
Description:
The linewidth that's used when highlighting the chart.
Default: 1
Key properties
Name: key
Description:
An array of the labels that appear on the key.
Default: null
Name: keyColors
Description:
An array of colors to be shown on the key. If not specified then the colors option will be used instead.
Default: null
Name: keyLabelsColor
Description:
The color of the text in the key.
Default: null
Name: keyLabelsBold
Description:
Whether the key text is bold or not.
Default: null
Name: keyLabelsFont
Description:
The font to use for the key text.
Default: null
Name: keyLabelsSize
Description:
The size to use for the key text.
Default: null
Name: ketLabelsItalic
Description:
Whether the key text is italic or not.
Default: null
Name: keyLabelsOffsetx
Description:
The horizontal pixel offset of the key text (just the text).
Default: 0
Name: keyLabelsOffsety
Description:
The vertical pixel offset of the key text (just the text).
Default: -1
Name: keyOffsetx
Description:
The horizontal pixel offset of the entire key.
Default: 0
Name: keyOffsety
Description:
The vertical pixel offset of the entire key.
Default: 0
Name: keyColorShape
Description:
This controls which shape should be displayed on the key. It can be a string or an array of strings. The possible options are: x1, circle, triangle, line, dot, rectdot.
Default: rect
Title properties
Name: title
Description:
The title of the chart.
Default: (An empty string)
Name: titleX
Description:
The specific x-axis coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null
Name: titleY
Description:
The specific y-axis coordinate of the title. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.
Default: null
Name: titleOffsetx
Description:
An offset value that is added to the calculated x-axis coordinate.
Default: 0
Name: titleOffsety
Description:
An offset value that is added to the calculated y-axis coordinate.
Default: 0
Name: titleHalign
Description:
The horizontal alignment of the title.
Default: center
Name: titleColor
Description:
The color of the title.
Default: null
Name: titleFont
Description:
The font used to render the title.
Default: null
Name: titleSize
Description:
The size of the font used to render the title.
Default: null
Name: titleBold
Description:
Whether the title is bold or not.
Default: null
Name: titleItalic
Description:
Whether the title is italic or not.
Default: null
Name: titleSubtitle
Description:
The subtitle of the chart. If a subtitle is specified the title is moved up to accommodate it. As such you might need to give a larger marginTop value.
Default: (An empty string)
Name: titleSubtitleColor
Description:
The color of the subtitle.
Default: #aaa
Name: titleSubtitleFont
Description:
The font used to render the subtitle.
Default: null
Name: titleSubtitleSize
Description:
The size of the font used to render the subtitle.
Default: null
Name: titleSubtitleBold
Description:
Whether the subtitle is bold or not.
Default: null
Name: titleSubtitleItalic
Description:
Whether the subtitle is italic or not.
Default: null
Other properties
Name: linewidth
Description:
The linewidth (around the segments) used.
Default: 1
Name: responsive
Description:
This option is new to the July 2023 release (v6.13) and allows you to inline the responsive configuration instead of appending it on to the end of the object it as a function. The documentation and demo pages have been updated to use this new option. You can read more about the responsive feature by reading the responsive configuration page.
Default: null
Name: zoom
Description:
Allow zooming of the chart. The svg zoom feature, added in version 6.19, allows you to zoom in on a certain area of your chart and then pan around by dragging the zoom. You can also increase or decrease the zoom level by using your mousewheel if you have one. You can read a documentation page about the SVG zoom feature here.
Default: false
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.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 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 svgpath elements that represent the segments on the Funnel chart have
a couple of data attributes added to them that hold values that you can use. These
are:
data-index
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 the draw method before anything has been done.
draw This event fires at the end of the draw function.
firstdraw This event fires at the end of the draw function - but only the first time and so it fires only once after the first draw call.
beforetooltip This event fires at the start of the tooltip showing process.
tooltip This event fires after a tooltip has been shown.
For example:
new RGraph.SVG.Funnel({
id: 'chart-container',
data: [4,8,6,4,5,2,3],
options: {
}
}).on('draw', function (obj)
{
console.log('The draw event has fired');
}).draw();