Funnel chart API reference

Documentation about the Funnel chart including information about all of the options that are available to you. Funnel charts can show the decreasing (or increasing) values of a quantity through the various stages that a process may have.

Example

<script>
    new RGraph.Funnel({
        id: 'cvs',
        data: [100,45,45,26,21,5],
        options: {
            textBoxed: false,
            title: 'Leads through to sales',
            labels: ['A', 'B', 'C', 'D', 'E', 'F'],
            shadow: true
        }
    }).draw();
</script>

Properties

You can use these properties to control how the Funnel chart appears. You can set them by using the set() method. Eg:

myFunnel.set('name', 'value');

Margin properties

PropertyDescriptionDefault
marginLeftThe left margin of the chart.25
marginRightThe right margin of the chart.25
marginTopThe top margin of the chart.25
marginBottomThe bottom margin of the chart.25

Color properties

PropertyDescriptionDefault
colorsThese are the colors used for each segment.['red', 'green', 'gray', 'blue', 'black', 'white']
colorsStrokeThe color used for the stroke that goes around each segment.rgba(0,0,0,0)

Labels and text properties

PropertyDescriptionDefault
labelsAn array of the labels to be used on the chart.An empty array
labelsXUse this to specify an X position for labels.null
labelsSticksIf your labels are offset you can use this to show indicating sticks. See the examples in the download for how you can use them.null
labelsFontThe font used by the labels.null
labelsSizeThe size of the labels.null
labelsColorThe color of the labels.null
labelsBoldWhether the labels are bold or not.null
labelsItalicWhether the labels are italic or not.null
textFontThe font used to render the text on the chart.Arial, Verdana, sans-serif
textColorThe color of the text on the chart.black
textSizeThe size of the text on the chart.12
textBoldWhether the text on the chart is bold or not.false
textItalicWhether the text on the chart is italic or not.false
textHalignThe horizontal alignment of the text. Can be center or left.left
textAccessibleA new feature in 2016 that allows you to use DOM text in place of canvas text. It makes for much higher quality text that you can also select if desired (for copy/paste operations). It won't fit all situations and you can read more about the DOM text feature here. A good way to control borders/margins/padding etc is not to set them on the canvas but to wrap the canvas in a div and set them on that like this:
<div style="margin-left: 50px; display: inline-block">
<canvas id="cvs" width="650" height="250"></canvas>
</div>
true
textAccessibleOverflowThis can be visible or hidden and it controls whether the text is clipped to the edges of the canvas. It defaults to be visible and means you can set small margins if you wish.visible
textAccessiblePointereventsThis controls whether the DOM text responds to mouse based events or not (it sets the pointer-events CSS property to none).true

Title properties

PropertyDescriptionDefault
titleThe title of the chart, if any.null
titleFontThe font that the title is rendered in.null
titleSizeThe size of the title.null
titleBoldWhether the title is bold or not.null
titleItalicWhether the title is italic or not.null
titleColorThe color of the title.null
titleBackgroundThe background color (if any) for the title.null
titleXTo give the exact X coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null
titleYTo give the exact Y coordinate for the title - use this. This can also be a string like this: "-5" -- in which case it's converted to a number and added to the calculated coordinate - allowing you to adjust the calculated coordinate.null

Shadow properties

PropertyDescriptionDefault
shadowWhether a drop shadow is applied to the Funnel chart.false
shadowColorThe color of the drop shadow.#666
shadowBlurThe severity of the shadow blurring effect.3
shadowOffsetxThe X offset of the shadow.3
shadowOffsetyThe Y offset of the shadow.3

Interactive features properties

PropertyDescriptionDefault
contextmenuAn array of context menu items. More information about context menus is here.[] (An empty array)
tooltipsAn array of tooltips for the Funnel chart segments.null
tooltipsEffectThe effect used for showing tooltips. Can be either fade or none.fade
tooltipsCssClassThis is the name of the CSS class the chart uses.RGraph_tooltip
tooltipsOverrideIf you wish to handle showing tooltips yourself, this should be a function object which does just that. There's more information on the tooltips documentation page.null
tooltipsNohideonclearNot an option that you'll need particularly often if at all. Setting this to true means that when you call the RGraph.clear() API function tooltips DO NOT get hidden.false
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotatableColorIf you do not allow the use of the palette, then this will be the only color allowed for annotations.black
annotatableLinewidthThis is the linewidth of the annotations.1
resizableDefaulting to false, this determines whether your chart will be resizable. Because of the numerous event handlers this has to install code on, This feature is unlikely to work with other dynamic features (the context menu is fine however).false
resizableHandleBackgroundWith this you can specify the background color for the resize handle. If you're adjusting the position of the handle then you may need this to make the handle stand out more.null
resizableMinwidthThis allows you to set a minimum width that the chart can be resized to.null
resizableMinheightThis allows you to set a minimum height that the chart can be resized to.null
resizableMaxwidthThis allows you to set a maximum width that the chart can be resized to.null
resizableMaxheightThis allows you to set a maximum height that the chart can be resized to.null

Key properties

The key properties are documented on the key documentation page.

Event properties

PropertyDescriptionDefault
eventsClickIf you want to add your own click function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own mousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own mouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own mouseout function you can do so by assigning it to this property. See here for details.null

Miscellaneous properties

PropertyDescriptionDefault
highlightStyleBy default this is null but you can set it to a function if you wish so that function is called to do the chart highlighting. It's passed the shape object as an argument.null
highlightStrokeIf you use tooltips, this controls the color of the highlight stroke.black
highlightFillIf you use tooltips, this controls the color of the highlight fill.rgba(255,255,255,0.5)
cleartoThis is used in animations and effects as the default color to use when the canvas.null

Methods

obj.get(name)
An accessor that you can use to retrieve the values of properties.

obj.set(name, value)
An accessor that you can use to set the values of properties.

obj.getShape(event)

This function, when passed an event object, will return details of the appropriate segment (if any). It returns:

The shape also includes textual indexes like this: shape['object'] And they are:

obj.on(event, function)

This method can be used to set an event listener on an object. It operates in a similar way to the jQuery on() function. The first argument is the event that you wish to attach to and the second is the handler function. For example:

.on('draw', function (obj)
{
    // Put event code here
});
The exec option and method

The exec function is documented here.