Funnel chart
- Example
- The coordinates properties
- Properties
- Methods
- Data properties that are used on the segments
- Events
Example
<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 ofx1
,y1
,x2
,y2
,x3
,y3
,x4
,x4
,widthTop
,widthBottom
,height
,element
andobject
properties. Theelement
property is theSVG
element and theobject
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.
- Background properties
- Margin properties
- Color properties
- Labels and text properties
- Tooltip properties
- Key properties
- Title properties
- Other properties
Background properties
A
true
or false
value that determines whether the background bars are shown.Default: false
backgroundBarsOpacity
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
backgroundBarsColors
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.Default: null
Margin properties
Property | Description | Default |
---|---|---|
marginLeft | The left margin of the chart. | 35 |
marginRight | The right margin of the chart. | 35 |
marginTop | The top margin of the chart. | 35 |
marginBottom | The bottom margin of the chart. | 35 |
The left margin of the chart.
Default: 35
marginRight
The right margin of the chart.
Default: 35
marginTop
The top margin of the chart.
Default: 35
marginBottom
The bottom margin of the chart.
Default: 35
Color properties
An array of the colors of the funnel segments.
Default: ['red', 'black', 'orange', 'green', '#6ff', '#ccc', 'pink', 'orange', 'cyan', 'maroon', 'olive', 'teal']
colorsStroke
The color of the outline of the segments.
Default: white
Labels and 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 |
labels | An array of labels that are added to the chart. | [] (An empty array) |
labelsFont | The font that's used for the labels. | null |
labelsSize | The font size that's used for the labels. | null |
labelsColor | The color that's used for the labels. | null |
labelsBold | Whether the labels are bold or not. | null |
labelsItalic | Whether the labels are italic or not. | null |
labelsBackground | The background color that's used for the labels. | null |
labelsHalign | The horizontal alignment of the labels. | center |
labelsPosition | This can be section or edge and controls the placement of the labels (ie where they're aligned to). | section |
labelsFormattedDecimals | When using formatted labels this is the number of decimals that are applied to the %{value_formatted} macro. | 0 |
labelsFormattedPoint | When using formatted labels this is the decimal point character that's used with the %{value_formatted} macro. | . |
labelsFormattedThousand | When using formatted labels this is the thousand separator character that's used with the %{value_formatted} macro. | , |
labelsFormattedUnitsPre | When using formatted labels these are the units that are prepended to the number with the %{value_formatted} macro. | (an empty string) |
labelsFormattedUnitsPost | When using formatted labels these are the units that are appended to the number with the %{value_formatted} macro. | (an empty string) |
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
labels
An array of labels that are added to the chart.
Default: [] (An empty array)
labelsFont
The font that's used for the labels.
Default: null
labelsSize
The font size that's used for the labels.
Default: null
labelsColor
The color that's used for the labels.
Default: null
labelsBold
Whether the labels are bold or not.
Default: null
labelsItalic
Whether the labels are italic or not.
Default: null
labelsBackground
The background color that's used for the labels.
Default: null
labelsHalign
The horizontal alignment of the labels.
Default: center
labelsPosition
This can be
section
or edge
and controls the placement of the labels (ie where they're aligned to).Default: section
labelsFormattedDecimals
When using formatted labels this is the number of decimals that are applied to the
%{value_formatted}
macro.Default: 0
labelsFormattedPoint
When using formatted labels this is the decimal point character that's used with the
%{value_formatted}
macro.Default: .
labelsFormattedThousand
When using formatted labels this is the thousand separator character that's used with the
%{value_formatted}
macro.Default: ,
labelsFormattedUnitsPre
When using formatted labels these are the units that are prepended to the number with the
%{value_formatted}
macro.Default: (an empty string)
labelsFormattedUnitsPost
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
Property | Description | Default |
---|---|---|
tooltips | An array of tooltips for the chart. This array should NOT be multidimensional. You can also check the canvas tooltips documentation for more information. | null |
tooltipsOverride | 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:
| 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. | [] (an empty array) |
tooltipsFormattedKeyColors | 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. | 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: "1 px 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 |
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. This array should NOT be multidimensional. You can also check the canvas tooltips documentation for more information.
Default: null
tooltipsOverride
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 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.
Default: [] (an empty array)
tooltipsFormattedKeyColors
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
tooltipsFormattedKeyColorsShape
This is the shape that's used in the tooltip key. It can be
square
or circle
Default: square
tooltipsFormattedKeyColorsCss
By using this property you can add
CSS
values to the key color shape that appears in the tooltip key. Note the property name is "color" and not "colors" like previous properties. It should be an object of CSS
properties like this: tooltipsFormattedKeyColorsCss : { border: "1 px solid #ddd"; }
Default: null
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
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
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.
Default: null
keyLabelsSize
The size to use for the key text.
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 vertical 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:
x1
, 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.
Default: null
titleSubtitleBold
Whether the subtitle is bold or not.
Default: null
titleSubtitleItalic
Whether the subtitle is italic or not.
Default: null
Other properties
The
linewidth
(around the segments) used.Default: 1
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.
The responsive function is documented on its own page here.
Data properties that are used on the segments
The SVG
path
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 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.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();