Timeseries Chart

The Chart.Timeseries component allows you to visualise timeseries data in your reports, with powerful customisation options.

Below is an example of the JSON required to define a Chart.Timeseries component:

{
    "type": "Chart.Timeseries",
    "options": {
        "data": [
            { "x": "2022-01-01 09:00:00", "y": 56 },
            { "x": "2022-01-02 09:00:00", "y": 72 },
            { "x": "2022-01-04 09:00:00", "y": 78 }
        ],
        "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"
    }
}

The data key must be an array of objects, with each object containing the keys x and y. Values can be grouped by providing a label key, which is used to plot data points as separate lines. A maximum of 1,000 points can be plotted on a chart.

The time_format option refers to how Hybiscus parses the X-values, which is by default set to %Y-%m-%d %H:%M:%s. This string format is based on the striptime / strftime functions. For more details, refer to this link.

The format of the strings in the ticks of the X-axis is automatic, and adapts to the range and scale of values provided (i.e. over minutes, days, months or years). This can be overrided using the tick_format option, which accepts time format strings as described above.

The curve interpolation algorithm used to connect the dots between data points can be customised. By default, it is set to MonotoneX. Any of the following options are allowed:

• Linear
• Step
• Basis
• Step
• StepBefore
• StepAfter
• Natural
• Cardinal
• CatmullRom
• MonotoneX

The interpolation algorithms are based on the implementations in the D3.js data visualisation library, detailed here. Examples of the different algorithms are shown below:

The colour of the line is automatically chosen by the theme selected for the report. For more details see Theming. If the data key contains data that can be grouped with multiple label values, the color_scheme key must be set to an option from color brewer scales. Allowed values include:

• Category10
• Accent
• Dark2
• Paired
• Pastel1
• Pastel2
• Set1
• Set2
• Set3
• Tableau10

For details on the width key, please see here.