Components · Funnels

Funnel chart

How much of a total survives each step of a process, in order.

Open in playground

Preview

Deals by stage

Usage

tsx
import {
  ChartsProvider,
  FunnelChart,
  dimension,
  measure,
  results,
} from 'em-kit';

const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <FunnelChart
        title="Deals by stage"
        sectionDimension={dealStage}
        countMeasure={deals}
        results={results(rows)}
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { deal_stage: 'Lead', deals: 4820 },
  { deal_stage: 'Qualified', deals: 2796 },
  { deal_stage: 'Proposal', deals: 1901 },
  { deal_stage: 'Negotiation', deals: 1369 },
  { deal_stage: 'Won', deals: 903 },
];
  • Steps sort largest first. When a later step can outgrow an earlier one, pass the optional orderDimension: a field holding each step’s position.

Install with npm install em-kit. Needs <ChartsProvider> once and a parent with a height: Quick start.

Examples

Step names on the funnel

Each step named on the funnel beside its value, with no legend: for a wide card. showSectionLabels writes “Step: value” on each step, so a legend would repeat the names.

tsxDiffers from Usage
Show full code (33 lines)
import {
  ChartsProvider,
  FunnelChart,
  dimension,
  measure,
  results,
} from 'em-kit';

const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <FunnelChart
        title="Deals by stage"
        sectionDimension={dealStage}
        countMeasure={deals}
        results={results(rows)}
        showLegend={false}
        showSectionLabels
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { deal_stage: 'Lead', deals: 4820 },
  { deal_stage: 'Qualified', deals: 2796 },
  { deal_stage: 'Proposal', deals: 1901 },
  { deal_stage: 'Negotiation', deals: 1369 },
  { deal_stage: 'Won', deals: 903 },
];
const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

<FunnelChart
  title="Deals by stage"
  sectionDimension={dealStage}
  countMeasure={deals}
  results={results(rows)}
  showLegend={false}
  showSectionLabels
/>

Share of all steps

Each step as a share of all steps added together, not a conversion rate. displayPercentages divides by the total of every step.

tsxDiffers from Usage
Show full code (32 lines)
import {
  ChartsProvider,
  FunnelChart,
  dimension,
  measure,
  results,
} from 'em-kit';

const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <FunnelChart
        title="Deals by stage, as a share of all steps"
        sectionDimension={dealStage}
        countMeasure={deals}
        results={results(rows)}
        displayPercentages
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { deal_stage: 'Lead', deals: 4820 },
  { deal_stage: 'Qualified', deals: 2796 },
  { deal_stage: 'Proposal', deals: 1901 },
  { deal_stage: 'Negotiation', deals: 1369 },
  { deal_stage: 'Won', deals: 903 },
];
const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

<FunnelChart
  title="Deals by stage, as a share of all steps"
  sectionDimension={dealStage}
  countMeasure={deals}
  results={results(rows)}
  displayPercentages
/>

Proportional bars

No taper: plain bars whose widths are exactly proportional, at the cost of the funnel look. shrinkAnchor="none" turns the taper off.

tsxDiffers from Usage
Show full code (32 lines)
import {
  ChartsProvider,
  FunnelChart,
  dimension,
  measure,
  results,
} from 'em-kit';

const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <FunnelChart
        title="Deals by stage"
        sectionDimension={dealStage}
        countMeasure={deals}
        results={results(rows)}
        shrinkAnchor="none"
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { deal_stage: 'Lead', deals: 4820 },
  { deal_stage: 'Qualified', deals: 2796 },
  { deal_stage: 'Proposal', deals: 1901 },
  { deal_stage: 'Negotiation', deals: 1369 },
  { deal_stage: 'Won', deals: 903 },
];
const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

<FunnelChart
  title="Deals by stage"
  sectionDimension={dealStage}
  countMeasure={deals}
  results={results(rows)}
  shrinkAnchor="none"
/>

Custom colour ramp

A ramp between two colours of your choice, from the first step to the last. Set startColor and endColor; with one of them, the other is generated.

tsxDiffers from Usage
Show full code (33 lines)
import {
  ChartsProvider,
  FunnelChart,
  dimension,
  measure,
  results,
} from 'em-kit';

const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

export const Example = () => (
  <ChartsProvider>
    <div style={{ height: 360 }}>
      <FunnelChart
        title="Deals by stage"
        sectionDimension={dealStage}
        countMeasure={deals}
        results={results(rows)}
        startColor="#0ea5e9"
        endColor="#1e3a8a"
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { deal_stage: 'Lead', deals: 4820 },
  { deal_stage: 'Qualified', deals: 2796 },
  { deal_stage: 'Proposal', deals: 1901 },
  { deal_stage: 'Negotiation', deals: 1369 },
  { deal_stage: 'Won', deals: 903 },
];
const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

<FunnelChart
  title="Deals by stage"
  sectionDimension={dealStage}
  countMeasure={deals}
  results={results(rows)}
  startColor="#0ea5e9"
  endColor="#1e3a8a"
/>

In a small card

A card 320px wide, with the steps in the legend and the counts in the tooltips. showValueLabels={false} keeps the narrow last steps clean.

tsxDiffers from Usage
Show full code (32 lines)
import {
  ChartsProvider,
  FunnelChart,
  dimension,
  measure,
  results,
} from 'em-kit';

const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

export const Example = () => (
  <ChartsProvider>
    <div style={{ width: 320, height: 360 }}>
      <FunnelChart
        title="Deals by stage"
        sectionDimension={dealStage}
        countMeasure={deals}
        results={results(rows)}
        showValueLabels={false}
      />
    </div>
  </ChartsProvider>
);

const rows = [
  { deal_stage: 'Lead', deals: 4820 },
  { deal_stage: 'Qualified', deals: 2796 },
  { deal_stage: 'Proposal', deals: 1901 },
  { deal_stage: 'Negotiation', deals: 1369 },
  { deal_stage: 'Won', deals: 903 },
];
const dealStage = dimension({ name: 'deal_stage', title: 'Stage' });
const deals = measure({ name: 'deals', title: 'Deals' });

<div style={{ width: 320, height: 360 }}>
  <FunnelChart
    title="Deals by stage"
    sectionDimension={dealStage}
    countMeasure={deals}
    results={results(rows)}
    showValueLabels={false}
  />
</div>

Props

Keyboard and screen readers: Accessibility.

PropTypeDefaultDescription
sectionDimensionrequiredDimensionThe dimension whose values are the funnel’s steps. Rows with the same step are added up.
countMeasurerequiredMeasureThe measure that sizes each step.
resultsrequiredDataResponseYour query’s state: { isLoading, data, error }, where data is your rows. results(rows) builds it from an array.
orderDimensionDimensionA numeric field giving each step’s position, lowest first. Without it, steps run largest to smallest.
startColorstringColour of the first step. The steps between blend towards endColor.
endColorstringColour of the last step. With only one of the two set, the other is generated.
showLegendbooleantrueShow the legend. Entries wrap onto more lines when they do not fit.
showTooltipsbooleantrueShow a formatted tooltip on hover.
showValueLabelsbooleantruePrint each value on the chart.
showSectionLabelsbooleanfalsePrint each step’s name on its bar. With showValueLabels, the value follows the name.
displayPercentagesbooleanfalseLabel each step with its share of all steps’ total instead of its value.
shrinkAnchor"top" | "middle" | "bottom" | "none""middle"Where each step narrows towards the next. "none" draws straight-sided bars.
shrinkFractionnumber1How much of each step narrows, from 0 (none of it) to 1 (all of it).
titlestringThe card’s title. A "key|fallback" string is looked up in your translations.
descriptionstringSmaller text under the title. Translates like title.
tooltipstringText for an info icon beside the title.
hideMenubooleanfalseHide the card’s header: the title, description and menu.
menuOptions("csv" | "xlsx" | "png" | "maximize")[]["csv", "xlsx", "png", "maximize"]Which entries the card menu offers. Pass [] for none.

A blank default means the prop is unset unless you pass it.

Field options

FunnelChart reads only the common options in a field’s inputs.