Bar charts are a type of chart consisting of a series of bars that describe a dataset.
Bar charts should include a title and be contained in an EzCard
. The card title can optionally have a description and icon.
To chart a dataset as a bar chart, provide a dataset as a data
array of objects with x
and y
values.
For example:
data = [{x: 'first', y: 1}, {x: 'second', y: 2}, {x: 'third', y: 3}];
Always provide title
and a detailed description
for assistive devices.
Typically, the independent axis will be the x-axis and the dependent axis will be the y-axis. To format the point labels on each axis, optionally pass a function to each dependentAxisLabelFormatter
and/or independentAxisLabelFormatter
. To customize which labels appear on each axis, optionally pass an array of values of the same type as the respective data
values to each dependentAxisLabelValues
and/or independentAxisLabelValues
. Axis labels do not have to be passed as a static array, they can be dynamically generated as an array of values.
To customize the highest independent and dependent values displayed on the axes, pass numeric values to maxIndependentValue
and maxDependentValue
, respectively. Avoid explicitly defining independentAxisLabelValues
and dependentAxisLabelValues
simultaneously with maxIndependentValue
or maxDependentValue
.
Bar colors can be customized with theme colors. The default is primary
.
If your dataset may sometimes be an empty array, work with design to render something other than a blank chart, perhaps an EzBlankState
.
In some cases, like server-side rendering, a deterministic id may be needed. If needed, use prop idPrefix
.
EzBarChart
supports theme palette properties (primary
, secondary
, error
, warning
, info
, alert
, neutral
, and success
) as well as all supported theme colors (ex. common.red100
). Colors should have high enough contrast for accessibility.
The default barColor
is primary
.
See WAI-ARIA accessibility guidelines for SVG charts.
All charts should have a title
and description
.
Name | Type | Default | Description |
---|---|---|---|
data* | Datum[] | Array of data with x and y values of type string, number, array of strings, or function. | |
description* | string | Detailed accessible description for the chart. | |
title* | string | Accessible title for the chart. | |
barColor | EzThemeColors | primary | Bar chart bar color. |
idPrefix | string | number | Deterministic id for the chart. | |
dependentAxisLabelFormatter | func | The function to format the dependent axis points. | |
dependentAxisLabelValues | AxisLabelValue[] | Array of axis label values to customize the dependent axis labels. | |
independentAxisLabelFormatter | func | The function to format the independent axis points. | |
independentAxisLabelValues | AxisLabelValue[] | Array of axis label values to customize the independent axis labels. |