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 of x1, y1, x2, y2, x3, y3, x4, x4, widthTop, widthBottom, height, element and object properties. The element property is the SVG element and the object 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

Margin properties

Color properties

Labels and text properties

Tooltip properties

tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}

tooltipsFormattedKeyColorsCss : {
    border: "1 px solid #ddd";
}

tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]

.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}

tooltips: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}

tooltipsOverride: function (obj, opt)
{
    // Show tooltip
}

tooltipsFormattedKeyColorsCss : {
    border: "1 px solid #ddd";
}

tooltipsFormattedListItems: [
    ['Bill','Jerry','Berty'], // First tooltip
    ['Gill','Carrie','Lucy'], // Second tooltip
    ['Pob','Nobby','Hilda']   // Third tooltip
]

.RGraph_tooltip ul#rgraph_formatted_tooltips_list li {
    text-align: left;
    color: yellow;
}

tooltips: {
    borderLeft: 'gray 2px solid',
    borderBottom: 'gray 2px solid'
}

tooltipsCss: {
    fontFamily: 'Verdana',
    fontSize: '20pt'
}

Key properties

Title properties

Other properties

Methods

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

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.

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

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

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 the draw method before anything has been done.
• draw This event fires at the end of the draw function.
• firstdraw This event fires at the end of the draw function - but only the first time and so it fires only once after the first draw 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();