Horizontal bar chart
Bars laid out horizontally, for long category labels or ranked lists.
Preview
Customers by region
Usage
import {
ChartsProvider,
BarChartHorizontal,
dimension,
measure,
results,
} from 'em-kit';
const region = dimension({ name: 'region', title: 'Region' });
const customers = measure({
name: 'customers',
title: 'Customers',
inputs: { abbreviateLargeNumber: true },
});
export const Example = () => (
<ChartsProvider>
<div style={{ height: 360 }}>
<BarChartHorizontal
title="Customers by region"
dimension={region}
measures={[customers]}
results={results(rows)}
/>
</div>
</ChartsProvider>
);
const rows = [
{ region: 'North America', customers: 985 },
{ region: 'Europe', customers: 709 },
{ region: 'Asia Pacific', customers: 451 },
{ region: 'Latin America', customers: 240 },
{ region: 'Middle East', customers: 188 },
];Install with npm install em-kit. Needs <ChartsProvider> once and a parent with a height: Quick start.
Examples
Truncated labels
Long category names cut to eight characters on the axis; the tooltip shows them in full. maxCharacters is a field option on the dimension.
Show full code (39 lines)
import {
ChartsProvider,
BarChartHorizontal,
dimension,
measure,
results,
} from 'em-kit';
const region = dimension({
name: 'region',
title: 'Region',
inputs: { maxCharacters: 8 },
});
const customers = measure({
name: 'customers',
title: 'Customers',
inputs: { abbreviateLargeNumber: true },
});
export const Example = () => (
<ChartsProvider>
<div style={{ height: 360 }}>
<BarChartHorizontal
title="Customers by region"
dimension={region}
measures={[customers]}
results={results(rows)}
/>
</div>
</ChartsProvider>
);
const rows = [
{ region: 'North America', customers: 985 },
{ region: 'Europe', customers: 709 },
{ region: 'Asia Pacific', customers: 451 },
{ region: 'Latin America', customers: 240 },
{ region: 'Middle East', customers: 188 },
];const region = dimension({
name: 'region',
title: 'Region',
inputs: { maxCharacters: 8 },
});
<BarChartHorizontal
title="Customers by region"
dimension={region}
measures={[customers]}
results={results(rows)}
/>Props
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. | |
measuresrequired | Measure[] | The numeric fields to plot, one series each. Their inputs set the formatting. | |
resultsrequired | DataResponse | Your query’s state: { isLoading, data, error }, where data is your rows. results(rows) builds it from an array. | |
showLegend | boolean | true | Show the legend. A chart with one series shows none; entries wrap onto more lines when they do not fit. |
showLogarithmicScale | boolean | false | Use a logarithmic value axis, for values that span several orders of magnitude. |
showTooltips | boolean | true | Show a formatted tooltip on hover. |
showValueLabels | boolean | true | Print each value on the chart. |
xAxisLabel | string | A title under the x-axis. | |
yAxisLabel | string | A title beside the y-axis. | |
granularity | Granularity | Only sets the size of the date range a click reports (dimensionTimeRange). The axis labels and the gap filling come from the time field, dimension({ granularity }), and this prop follows the field when left out. One of "second", "minute", "hour", "day", "week", "month", "quarter", "year". | |
setGranularity | ( | Called with the granularity the reader picks in the card. The picker only shows when the time field sets showGranularityDropdown: true in its inputs. Store the value, set it as the field’s granularity and pass rows at that granularity. | |
onBarClicked | ( | Called with the clicked bar’s dimension value and, on a time axis, its date range. Use it as a filter.BarChartOptionsClickArg = { dimensionValue: string | number | undefined; dimensionTimeRange: TimeRange; measureValues?: Record<string, unknown> | undefined; } | |
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. |
reverseYAxis | boolean | false | Reverse the order of the y-axis. |
xAxisRangeMax | number | Fix the highest value on the x-axis. When unset, it fits the data. | |
xAxisRangeMin | number | Fix the lowest value on the x-axis. When unset, a horizontal bar chart’s axis includes zero, and a scatter or bubble chart’s fits the data. | |
yAxisMaxItems | number | Show at most this many y values. The rest are added up into one “Other” value. |
A blank default means the prop is unset unless you pass it.
| Type | Definition |
|---|---|
Granularity | "second" | |
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 |
|---|---|---|---|
color | string | measures | A colour for this measure’s bars, in place of the theme’s. |
showValueAsPercentage | boolean | measures | Label each value with its share of the total. The tooltip shows both. Default: false. |