ComponentsLine chart

Line chart

The LineChart component is used for visualising data as a line chart. It provides a simple way to include charts without the need for using external libraries to generate an image.

Schema

Below are two examples of the schema required to define a LineChart.

{
    "type": "LineChart",
    "options": {
        "width": "2/4",
        "data": [{"x": 0, "y": 5}, ...],
        "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"
    }
},
{
    "type": "LineChart",
    "options": {
        "data": [{"x": 0, "y": 5}, ...],
        "x_label": "X axis label",
        "y_label": "Y axis label"
    }
}

Description

KeyDescription
dataThe data to plot in the chart, which should be an array of objects with keys x and y.
x_labelThe X-axis label.
y_labelThe Y-axis label.
colour_byOptional. The key in the data objects to use to colour each line by.
chart_titleOptional. The chart title.
captionOptional. Caption below the chart.
widthOptional. The width of the component, when inside a Section or Row component with their columns option set to null.

Data

The data key must be an array of objects, with each object containing the keys x and y. Both these keys should contain numbers (not strings). A maximum of 500 points can be plotted on a chart.

Multiple lines

To draw multiple lines, you will need to add an additional key to the objects in data. The name of this key must be provided to the colour_by option key, so Hybiscus can use it to group the data and colour the lines.

{
    "type": "LineChart",
    "options": {
        "data": [
            {"x": 0, "y": 5, "category": "Label A"},
            {"x": 1, "y": 9, "category": "Label A"},
            {"x": 2, "y": 4, "category": "Label A"},

            {"x": 0, "y": 6, "category": "Label B"},
            {"x": 1, "y": 12, "category": "Label B"},
            {"x": 2, "y": 7, "category": "Label B"}
        ],
        "colour_by": "category",
        "x_label": "X axis label",
        "y_label": "Y axis label"
    }
}

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.

Theming

The colour of the line / curve is automatically chosen by the theme selected for the report. For more details see Theming. This only applies if you have not used the colour_by option.

Plotting

By default, the lines are smoothed to make them more visually appealing. These charts should not be used for communicating data very precisely, but rather for showing general trends.

Example

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