To help you get started, we've collected the most common ways that d3-funnel is being used within popular public projects.

outbrain / ob-kb-funnel / public / funnel_visualization.js View on Github

constructor(el, vis) {
      this.vis = vis;
      this.el = el;

      this.container = document.createElement('div');
      this.container.className = this.containerClassName;
      this.el.appendChild(this.container);

      this.processedData = {};

      this.chart = new D3Funnel(this.container);
      // this.filterManager = filterManager;
    }

View more ways to use d3-funnel

d3-funnel

d3-funnel is an extensible, open-source JavaScript library for rendering funnel charts using the D3.js library.

d3-funnel is focused on providing practical and visually appealing funnels through a variety of customization options. Check out the examples page to get a showcasing of the several possible options.

Installation

To install this library, simply include both D3.js and D3Funnel:

Alternatively, if you are using Webpack or Browserify, you can install the npm package and import the module. This will include a compatible version of D3.js for you:

npm install d3-funnel --save

import D3Funnel from 'd3-funnel';

Usage

To use this library, you must create a container element and instantiate a new funnel chart. By default, the chart will assume the width and height of the parent container:

<div id="funnel"></div>

Options

Label/Tooltip Format

The option label.format can either be a function or a string. The following keys will be substituted by the string formatter:

Event Data

Block-based events are passed a data object containing the following elements:

Example:

{
    index: 0,
    node: { ... },
    value: 150,
    fill: '#c33',
    label: {
        raw: 'Visitors',
        formatted: 'Visitors: 150',
        color: '#fff',
    },
},

Overriding Defaults

You may wish to override the default chart options. For example, you may wish for every funnel to have proportional heights. To do this, simply modify the D3Funnel.defaults property:

D3Funnel.defaults.block.dynamicHeight = true;

Should you wish to override multiple properties at a time, you may consider using lodash's _.merge or jQuery's $.extend:

D3Funnel.defaults = _.merge(D3Funnel.defaults, {
    block: {
        dynamicHeight: true,
        fill: {
            type: 'gradient',
        },
    },
    label: {
        format: '{l}: ${f}',
    },
});

Advanced Data

In the examples above, both label and value were just to describe a block within the funnel. A complete listing of the available options is included below:

API

Additional methods beyond draw() are accessible after instantiating the chart:

License

MIT license.