Premium components
Bar Chart (v2)
Premium feature

This is a premium feature which requires a paid plan to be used. See here for more details.

Bar Chart (v2)

The Chart.Bar component is part of the premium set of chart components, with greater control over their layout and design. The bar chart allows visualising data on vertical bars, with either a categorical or numerical X-axis.

Schema

Below is an example of the schema required to define a Chart.Bar component:

{
    "type": "Chart.Bar",
    "options": {
        "width": "2/4",
        "data": [{"x": 0, "y": 5}, ...],
        "color_scheme": "Tableau10",
        "font_size": 12,
        "aspect_ratio": 1.2,
        "x_label": "X axis label",
        "y_label": "Y axis label",
        "chart_title": "Chart title",
        "caption": "Lorem ipsum dolor, sit amet consectetur adipisicing elit. Repudiandae provident ipsa culpa officiis illum commodi voluptas, sequi repellat veniam adipisci laboriosam amet nesciunt nam explicabo voluptate minima inventore, minus sint"
    }
}

Config options

KeyDescription
dataThe data to plot in the chart. See below for more details.
font_sizeOptional. The font size in pixels. Defaults to 16.
aspect_ratioOptional. The aspect ratio of the chart (width / height). Defaults to 1.6.
color_schemeOptional. A Brewer color scheme to color each bar using.
x_labelThe X-axis label.
y_labelThe Y-axis label.
chart_titleOptional. The chart title.
captionOptional. Caption below the chart.
horizontal_marginOptional. Margin added horizontally to the element. Defaults to 3. Accepts any integer between 1 - 12, 14 or 16.
vertical_marginOptional. Margin added vertically to the element. Defaults to 1. Accepts any integer between 1 - 12, 14 or 16.
marginOptional. Instead of setting horizontal or vertical margins separately, a global value can be set here.
widthOptional. The width of the component, when inside a Section or Row component with their columns option set to null.
grouped_barsOptional. Whether to group the bars by their X value, and colour by the label key. Defaults to false.

Data

The data key must be an array of objects, with each object containing the keys x and y. To set the colour for each bar, provide a color key with a hex value. Values for x may be categorical or numerical. A maximum of 1,000 points can be plotted on a chart.

If using the grouped_bars option, you must also supply an additional key, label, which is used to label the different bars at a single X-position.

Theming

The colour of the bars can be set in one of three ways:

  • Automatically chosen by the theme selected for the report. For more details see Theming.
  • Overriding the color of each bar by passing a color key for each object in the data key.
  • Setting the color_scheme key to an option from color brewer scales. Allowed values include:
    • Category10
    • Accent
    • Dark2
    • Paired
    • Pastel1
    • Pastel2
    • Set1
    • Set2
    • Set3
    • Tableau10

Width

The width key supports defining the width using a fraction specified as a string e.g. 1/3. The values for the denominator supported are 2, 3, 4, 5, 6 and 12, whilst the numerator can be any value up to the value of the denominator.

If the width key is set to null, then the component will attempt to fill all the available horizontal space.

Examples

Grouped bars

If you set grouped_bars to true, Hybiscus can group your data at each X-position. To do this, ensure each object in the data key's array has a label key. This key is used to colour the bars at each X-position and produce the legend above the chart. It is also recommended to use the color_scheme key, rather than manually setting colors on each datum object.

Below is an example schema (try copying it straight into the Cloud Editor):

{
    "type": "Chart.Bar",
    "options": {
        "width": "5/12",
        "color_scheme": "Set2",
        "grouped_bars": true,
        "x_label": "Penguin species",
        "y_label": "Body mass (g)",
        "data": [
            {"x": "Adelie", "label": "Male", "y": 4000},
            {"x": "Adelie", "label": "Female", "y": 3300},
            {"x": "Chinstrap", "label": "Male", "y": 3800},
            {"x": "Chinstrap", "label": "Female", "y": 3500},
            {"x": "Gentoo", "label": "Male", "y": 5500},
            {"x": "Gentoo", "label": "Female", "y": 4800}
        ]
    }
}

The generated component will look like below:


More examples

Missing something?

Hybiscus is continuously improving and adding new features. If you think we are missing a critical feature, please do not hesitate to contact us and offer your feedback at info@hybiscus.dev