SVG Funnel chart API reference

Summary: Documentation about the SVG Funnel chart including information about all of the options and methods that are available to you.

 

Example

The code here produces a chart like this:

<script>
    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: ['Start point (100%)', 'Stage 1 (75%)', 'Stage 2 (50%)', 'Stage 3 (25%)'],
            labelsSize: 26,
            labelsItalic: true,
            labelsBold: false,
            labelsColor: 'gray',
            labelsHalign: 'left',
            labelsPosition: 'edge'
        }
    }).draw();
</script>

 

The coordinates properties

The coordinates for the segments on the Funnel chart are held in the obj.coords array:

 

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

Background properties

PropertyDescriptionDefault
backgroundBarsA true or false value that determines whether the background bars are shown.false
backgroundBarsOpacityThis controls the opacity used for the background bars (ie how transparent they are). 1 is fully opaque ie not transparent at all.0.25
backgroundBarsColorsBy 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.null
backgroundBars
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

PropertyDescriptionDefault
marginLeftThe left margin of the chart.35
marginRightThe right margin of the chart.35
marginTopThe top margin of the chart.35
marginBottomThe bottom margin of the chart.35
marginLeft
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

PropertyDescriptionDefault
colorsAn array of the colors of the funnel segments.['red', 'black', 'orange', 'green', '#6ff', '#ccc', 'pink', 'orange', 'cyan', 'maroon', 'olive', 'teal']
colorsStrokeThe color of the outline of the segments.white
colors
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

PropertyDescriptionDefault
textColorThe color of the text.black
textFontThe font used for text.Arial, Verdana, sans-serif
textSizeThe size of the text.12
textBoldWhether the text is bold or not.false
textItalicWhether the text is italic or not.false
labelsAn array of labels that are added to the chart.[] (An empty array)
labelsFontThe font that's used for the labels.null
labelsSizeThe font size that's used for the labels.null
labelsColorThe color that's used for the labels.null
labelsBoldWhether the labels are bold or not.null
labelsItalicWhether the labels are italic or not.null
labelsBackgroundThe background color that's used for the labels.null
labelsHalignThe horizontal alignment of the labels.center
labelsPositionThis can be section or edge and controls the placement of the labels (ie where they're aligned to).section
textColor
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

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

Tooltip properties

PropertyDescriptionDefault
tooltipsAn array of tooltips for the chart. This array should NOT be multidimensional.null
tooltipsOverrideIf required, this can be a function that totally 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).
null
tooltipsEventThe event used for tooltips (either click or mousemove.click
tooltipsFormattedPointWhen using formatted tooltip strings this is used as the point when using the %{value_formatted} option..
tooltipsFormattedThousandWhen using formatted tooltip strings this is used as the thousand separator when using the %{value_formatted} option.,
tooltipsFormattedDecimalsWhen using formatted tooltip strings this specifies the number of decimals when using the %{value_formatted} option.0
tooltipsFormattedUnitsPreWhen using formatted tooltip strings these units are prepended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedUnitsPostWhen using formatted tooltip strings these units are appended to the number when using the %{value_formatted} option.(an empty string)
tooltipsFormattedKeyLabelsThe labels that are used in the formatted tooltip key.[] (an empty array)
tooltipsFormattedKeyColorsThe 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
tooltipsFormattedKeyColorsShapeThis is the shape that's used in the tooltip key. It can be square or circlesquare
tooltipsCssIf you want to specify some CSS that gets applied to all of the tooltips, but don't want to use the RGraph.tooltips.style object (which gets applied to all of the tooltips on the page for every chart) you can use this property to give some per-object CSS for the tooltips. These are CSS styles that get applied to all of the tooltips for the specific object only. It should look like this:
tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt',
    backgroundColor: 'black',
    color: 'white'
}
null
tooltipsCssClassThe CSS class that's applied to the tooltip DIV.RGraph_tooltip
tooltipsOffsetxThis property allows you to shift the tooltips left or right.0
tooltipsOffsetyThis property allows you to shift the tooltips up or down.0
highlightStrokeThe stroke color that's used when highlighting the chart.rgba(0,0,0,0)
highlightFillThe fill color that's used when highlighting the chart.rgba(255,255,255,0.7)
highlightLinewidthThe linewidth that's used when highlighting the chart.1
tooltips
An array of tooltips for the chart. This array should NOT be multidimensional.
Default: null

tooltipsOverride
If required, this can be a function that totally 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:
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

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',
    backgroundColor: 'black',
    color: 'white'
}

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

PropertyDescriptionDefault
keyAn array of the labels that appear on the key.null
keyColorsAn array of colors to be shown on the key. If not specified then the colors option will be used instead.null
keyLabelsColorThe color of the text in the key.null
keyLabelsBoldWhether the key text is bold or not.null
keyLabelsFontThe font to use for the key text.null
keyLabelsSizeThe size to use for the key text.null
ketLabelsItalicWhether the key text is italic or not.null
keyLabelsOffsetxThe horizontal pixel offset of the key text (just the text).0
keyLabelsOffsetyThe vertical pixel offset of the key text (just the text).-1
keyOffsetxThe horizontal pixel offset of the entire key.0
keyOffsetyThe horizontal pixel offset of the entire key.0
keyColorShapeThis 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.rect
key
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 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: x1, circle, triangle, line, dot, rectdot.
Default: rect

Title properties

PropertyDescriptionDefault
titleThe title of the chart.(An empty string)
titleXThe specific X 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.null
titleYThe specific Y 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.null
titleOffsetxAn offset value which is added to the calculated X coordinate.0
titleOffsetyAn offset value which is added to the calculated Y coordinate.0
titleHalignThe horizontal alignment of the title.center
titleColorThe color of the title.null
titleFontThe font used to render the title.null
titleSizeThe size of the font used to render the title.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleSubtitleThe 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.(An empty string)
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleSizeThe size of the font used to render the subtitle.null
titleSubtitleBoldWhether the subtitle is bold or not.null
titleSubtitleItalicWhether the subtitle is italic or not.null
title
The title of the chart.
Default: (An empty string)

titleX
The specific X 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 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 which is added to the calculated X coordinate.
Default: 0

titleOffsety
An offset value which is added to the calculated Y 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

PropertyDescriptionDefault
linewidthThe linewidth (around the segments) used.1
linewidth
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
});

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:

These can be retrieved by using standard DOM methods:

obj.coords[0].element.getAttribute('data-index');