Skip to content

Bar

Bar chart.

Bar

Bases: _AxisChart

Bar chart with categorical x-axis.

Uses a single dataset. Only datasets[0] is rendered.

Parameters:

Name Type Description Default
title str | None

Chart title.

 None
x_label str | None

Label for the x-axis.

 None
y_label str | None

Label for the y-axis.

 None
labels Any

Category names for the x-axis.

 required
datasets Any

List containing one dataset dict with a data key (list of numeric values) and an optional label key.

 required
options Any

Dict of chart options.

 None

Options:

  • backgroundColor (str): Background color (default 'white').
  • dataColors (list[str]): Bar colors.
  • fontFamily (str): Font family (default 'xkcd').
  • strokeColor (str): Axis/border color (default 'black').
  • unxkcdify (bool): Disable hand-drawn style (default False).
  • yTickCount (int): Number of y-axis ticks (default 3).

Example:

Bar(
    title="Monthly Sales",
    x_label="Month",
    y_label="Revenue",
    labels=["Jan", "Feb", "Mar"],
    datasets=[{"data": [10, 20, 30]}],
)
Source code in src/chart_xkcd/bar.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
class Bar(_AxisChart):
    """Bar chart with categorical x-axis.

    Uses a single dataset. Only `datasets[0]` is rendered.

    Args:
        title: Chart title.
        x_label: Label for the x-axis.
        y_label: Label for the y-axis.
        labels: Category names for the x-axis.
        datasets: List containing one dataset dict with a `data` key
            (list of numeric values) and an optional `label` key.
        options: Dict of chart options.

    Options:

    - `backgroundColor` (str): Background color (default `'white'`).
    - `dataColors` (list[str]): Bar colors.
    - `fontFamily` (str): Font family (default `'xkcd'`).
    - `strokeColor` (str): Axis/border color (default `'black'`).
    - `unxkcdify` (bool): Disable hand-drawn style (default False).
    - `yTickCount` (int): Number of y-axis ticks (default 3).

    Example:

    ```
    Bar(
        title="Monthly Sales",
        x_label="Month",
        y_label="Revenue",
        labels=["Jan", "Feb", "Mar"],
        datasets=[{"data": [10, 20, 30]}],
    )
    ```
    """

    def __init__(
        self,
        *,
        title: str | None = None,
        x_label: str | None = None,
        y_label: str | None = None,
        labels: Any,
        datasets: Any,
        options: Any = None,
    ):
        _check_labels_datasets(labels, datasets, "Bar")
        data = {"labels": list(labels), "datasets": list(datasets)}
        super().__init__(
            title=title, x_label=x_label, y_label=y_label, data=data, options=options
        )