Funnel charts documentation

 

Example

<script>
    // Create the Funnel chart. Note the the values start at the maximum and decrease to the minimum.
    var funnel = 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>

The example file is here.

 

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');

Layout style:     
  

Margins

PropertyDescriptionDefault
gutterLeftThe left gutter of the chart, (the gutter is where the labels and title are)).25
gutterRightThe right gutter of the chart, (the gutter is where the labels and title are).25
gutterTopThe top gutter of the chart, (the gutter is where the labels and title are).25
gutterBottomThe bottom gutter of the chart, (the gutter is where the labels and title are).25

Colors

PropertyDescriptionDefault
colorsThese are the colors used for each segment.['red', 'green', 'gray', 'blue', 'black', 'white']

Labels and text

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 example for how you can use them.null
textFontThe font used to render the text.Arial
textColorThe color of the labels.black
textSizeThe size (in points) of the labels.10
textBoxedWhether the text is contained within a white bounding box. In some cases this can help readability.true
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 gutters 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

Titles

PropertyDescriptionDefault
titleThe title of the chart, if any.null
titleFontThe font that the title is rendered in. If not specified the text.font setting is used (usually Verdana)null
titleSizeThe size of the title. If not specified the size is usually 2pt bigger than the text.size setting.null
titleBoldWhather the title is bold or not.true
titleItalicWhether the title is italic or not.false
titleBackgroundThe background color (if any) for the title.null
titleXTo give the exact X coordinate for the title - use thisnull
titleYTo give the exact Y coordinate for the title - use thisnull
titleColorThe color of the title.black

Shadow

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

PropertyDescriptionDefault
contextmenuAn array of context menu items. More information on 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 pagenull
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 tooltip DO NOT get hidden.false
annotatableWhether annotations are enabled for the chart (ie you can draw on the chart interactively.false
annotateColorIf you do not allow the use of the palette, then this will be the only colour allowed for annotations.black
annotateLinewidthThis is the line width 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
resizeHandleBackgroundWith 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
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

The key properties are documented on the key documentation page.

Zoom

PropertyDescriptionDefault
zoomFactorThis is the factor that the chart will be zoomed by (bigger values means more zoom)1.5
zoomFadeInWhether the zoomed canvas fades in or not. This also can be used to control the fade in for the zoom in thumbnail mode.true
zoomFadeOutWhether the zoomed canvas fades out or not. This also can be used to control the fade in for the zoom in thumbnail mode.true
zoomHdirThe horizontal direction of the zoom. Possible values are: left, center, rightright
zoomVdirThe vertical direction of the zoom. Possible values are: up, center, downdown
zoomDelayThe delay (in milliseconds) between frames.50
zoomFramesThe number of frames in the zoom animation.10
zoomShadowWhether or not the zoomed canvas has a shadow or not.true

Events

PropertyDescriptionDefault
eventsClickIf you want to add your own onclick function you can do so by assigning it to this property. See here for details.null
eventsMousemoveIf you want to add your own onmousemove function you can do so by assigning it to this property. See here for details.null
eventsMouseoverIf you want to add your own onmouseover function you can do so by assigning it to this property. See here for details.null
eventsMouseoutIf you want to add your own onmouseout function you can do so by assigning it to this property. See here for details.null

Miscellaneous

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. Its passed the shape object as an argument.null
highlightStrokeIf you use tooltips, this controls the colour of the highlight stroke.black
highlightFillIf you use tooltips, this controls the colour 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 value of properties.

 

obj.set(name, value)
An accessor that you can use to set the value 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, func)

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

Share RGraph!