Donut chart
A pie with the centre cut out, for a lighter visual weight.
Preview
Customers by plan
Usage
import {
ChartsProvider,
DonutChart,
dimension,
measure,
results,
} from 'em-kit';
const plan = dimension({ name: 'plan', title: 'Plan' });
const customers = measure({ name: 'customers', title: 'Customers' });
export const Example = () => (
<ChartsProvider>
<div style={{ height: 440 }}>
<DonutChart
title="Customers by plan"
dimension={plan}
measure={customers}
results={results(rows)}
/>
</div>
</ChartsProvider>
);
const rows = [
{ plan: 'Starter', customers: 1283 },
{ plan: 'Growth', customers: 1085 },
{ plan: 'Enterprise', customers: 207 },
];Install with npm install em-kit. Needs <ChartsProvider> once and a parent with a height: Quick start.
Examples
Percentages
Each segment labelled with its share of the total. showValueAsPercentage is a field option on the measure.
Show full code (33 lines)
import {
ChartsProvider,
DonutChart,
dimension,
measure,
results,
} from 'em-kit';
const plan = dimension({ name: 'plan', title: 'Plan' });
const customers = measure({
name: 'customers',
title: 'Customers',
inputs: { showValueAsPercentage: true, decimalPlaces: 1 },
});
export const Example = () => (
<ChartsProvider>
<div style={{ height: 440 }}>
<DonutChart
title="Customers by plan"
dimension={plan}
measure={customers}
results={results(rows)}
/>
</div>
</ChartsProvider>
);
const rows = [
{ plan: 'Starter', customers: 1283 },
{ plan: 'Growth', customers: 1085 },
{ plan: 'Enterprise', customers: 207 },
];const customers = measure({
name: 'customers',
title: 'Customers',
inputs: { showValueAsPercentage: true, decimalPlaces: 1 },
});
<DonutChart
title="Customers by plan"
dimension={plan}
measure={customers}
results={results(rows)}
/>Minimal
No legend and no labels: shape only, with the detail in the tooltips.
Show full code (31 lines)
import {
ChartsProvider,
DonutChart,
dimension,
measure,
results,
} from 'em-kit';
const plan = dimension({ name: 'plan', title: 'Plan' });
const customers = measure({ name: 'customers', title: 'Customers' });
export const Example = () => (
<ChartsProvider>
<div style={{ height: 440 }}>
<DonutChart
title="Customers by plan"
dimension={plan}
measure={customers}
results={results(rows)}
showLegend={false}
showValueLabels={false}
/>
</div>
</ChartsProvider>
);
const rows = [
{ plan: 'Starter', customers: 1283 },
{ plan: 'Growth', customers: 1085 },
{ plan: 'Enterprise', customers: 207 },
];const plan = dimension({ name: 'plan', title: 'Plan' });
const customers = measure({ name: 'customers', title: 'Customers' });
<DonutChart
title="Customers by plan"
dimension={plan}
measure={customers}
results={results(rows)}
showLegend={false}
showValueLabels={false}
/>Props
Not listed: showValueLabelsAsPercentage, which the type accepts and the component does not read. Keyboard and screen readers: Accessibility.
| Prop | Type | Default | Description |
|---|---|---|---|
dimensionrequired | Dimension | The field whose values label the axis or the segments. Its name is the row key. | |
measurerequired | Measure | The numeric field to plot. Its inputs (prefix, suffix, decimalPlaces) set the formatting. | |
resultsrequired | DataResponse | Your query’s state: { isLoading, data, error }, where data is your rows. results(rows) builds it from an array. | |
maxLegendItems | number | 10 | Show at most this many segments. The rest are added up into one “Other” segment. |
showLegend | boolean | true | Show the legend. Entries wrap onto more lines when they do not fit. |
showTooltips | boolean | true | Show a formatted tooltip on hover. |
showValueLabels | boolean | true | Print each value on the chart. |
onSegmentClick | ( | Called with the clicked segment’s dimension value. Use it as a filter. A click on the “Other” segment reports the first of the rows it adds up, so ignore that one.PieChartClickArg = { dimensionValue: string | undefined; dimensionTimeRange: TimeRange; } | |
componentName | string | A name for this component, included in the interaction events it dispatches on the DOM, for your analytics. | |
trackingId | string | An id included in the same events, to tell two instances apart. | |
title | string | The card’s title. A "key|fallback" string is looked up in your translations. | |
description | string | Smaller text under the title. Translates like title. | |
tooltip | string | Text for an info icon beside the title. | |
hideMenu | boolean | false | Hide the card’s header: the title, description and menu. |
menuOptions | ( | ["csv", | Which entries the card menu offers. Pass [] for none. |
A blank default means the prop is unset unless you pass it.
| Type | Definition |
|---|---|
TimeRange | { from: Date |What a click’s TimeRange holds: Events. |
Field options
Set in a field’s inputs, beside the common options:
| Option | Type | Set on | Description |
|---|---|---|---|
showValueAsPercentage | boolean | measure | Label each value with its share of the total. The tooltip shows both. Default: false. |