SVG Funnel charts API reference

Documentation about the SVG Funnel chart including information on all 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',
            gutterTop: 45,
            gutterLeft: 300,
            gutterRight: 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 apears. You can set them by including them in the options section of the configuration as above.

Background

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

Margins

PropertyDescriptionDefault
gutterLeftThe left gutter of the chart.35
gutterRightThe right gutter of the chart.35
gutterTopThe top gutter of the chart.35
gutterBottomThe bottom gutter of the chart.35

Colors

PropertyDescriptionDefault
colorsAn array of the colors of the funnel segments.['red', 'black', 'orange', 'green', '#6ff', '#ccc', 'pink', 'orange', 'cyan', 'maroon', 'olive', 'teal']
colorsOpacityThe defaault opacity setting thats used for the colors.1
strokestyleThe color of the outline of the segments.white

Labels and text

PropertyDescriptionDefault
textColorThe color of the text.black
textFontThe font used for text.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. This falls back to the textFont property.null
labelsSizeThe font size that's used for the labels. This falls back to the textSize property.null
labelsColorThe color that's used for the labels. This falls back to the textColor property.null
labelsBoldWhether the labels are bold or not. This falls back to the textBold property.null
labelsItalicWhether the labels are italic or not. This falls back to the textItalic property.null
labelsBackgroundThe background color thats used for the labels.null
labelsAlignThe 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

Tooltips

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
tooltipsCssClassThe CSS class thats applied to the tooltip DIV.RGraph_tooltip
tooltipsEventThe event used for tooltips (either click or mousemove.click
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

Key

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
keyTextColorThe color of the text in the key.black
keyTextBoldWhether the key text is bold or not.false
keyTextFontThe font to use for the key text. If not specified it defaults to the textFont setting.null
keyTextSizeThe size to use for the key text. If not specified then the textSize is used.null
ketTextItalicWhether the key text is italic or not.false
keyTextOffsetxThe horizontal pixel offset of the key text (just the text).0
keyTextOffsetyThe 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: rect, circle, triangle, line, dot, rectdotrect

Title

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
titleHalignThe horizontal alignment of the title.center
titleValignThe vertical alignment of the title.bottom
titleColorThe color of the title. It defaults to be the same as the textColor property.null
titleFontThe font used to render the title.null
titleSizeThe size of the font used to render the title. It defaults to be a little larger than the textSize propertynull
titleBoldWhether the title is bold or not.false
titleItalicWhether the title is italic or not.false
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 gutterTop value.(An empty string)
titleSubtitleXThe specific X coordinate of the subtitle. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.null
titleSubtitleYThe specific Y coordinate of the subtitle. This can also be a string that looks like this: "+10" or "-10" in which case it's added to the calculated position.null
titleSubtitleHalignThe horizontal alignment of the subtitle.center
titleSubtitleValignThe vertical alignment of the subtitle.top
titleSubtitleColorThe color of the subtitle.#aaa
titleSubtitleFontThe font used to render the subtitle.null
titleSubtitleSizeThe size of the font used to render the subtitle. It defaults to be the same as the textSize setting.null
titleBoldWhether the subtitle is bold or not.false
titleSubtitleItalicWhether the subtitle is italic or not.false

Other

PropertyDescriptionDefault
linewidthThe line width (around the segments) used.1

 

Methods

 

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 onbeforedraw or ondraw) to the chart object.

 

obj.exec(func)

This function simply executes the function that you give it (there and then - not on any particular event)