Skip to content

graphical.chart

LabelChartRenderer

Renderer for labeled charts.

Parameters:

Name Type Description Default
title str

The title of the chart rendered at the top.

 required
ticks Tuple[float, float]

Minimum and maximum value to display on the x-axis.

 None
box Box

One of the constants in rich.box used to draw the edges.

 HEAVY
Source code in src/graphical/chart.py 
 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
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
class LabelChartRenderer:
    """Renderer for labeled charts.

    Args:
        title (str): The title of the chart rendered at the top.
        ticks (Tuple[float, float], optional): Minimum and maximum value to display on the x-axis.
        box (Box): One of the constants in rich.box used to draw the edges.
    """

    def __init__(
        self,
        title: str,
        ticks: Optional[Tuple[float, float]] = None,
        box: Box = HEAVY,
    ):
        self.title = title
        self.ticks = ticks
        self.box = box
        self.rows: List[LabelChartRow] = []

    def add_row(
        self,
        content: Union[RenderableType, Segment],
        content_width: int,
        label: str = "",
    ) -> LabelChartRow:
        """Add row to chart.

        Args:
            content (Union[RenderableType, Segment]): RenderableType representing the content.
            content_width (int): Width of the content.
            label (str): Label of the content line.

        Returns:
            LabelChartRow: Row created and added to LabelChartRenderer.
        """
        row = LabelChartRow(content, content_width, label)
        self.rows.append(row)
        return row

    def render(self) -> RenderResult:
        """Render the labeled chart.

        Returns:
            RenderResult: Rendered chart.
        """
        width_labels = max(len(d.label) for d in self.rows) + 1
        width_content = max(d.content_width for d in self.rows)

        yield Segment(" " * width_labels)
        yield Segment(f"{self.title: ^{width_content + 2}}")
        yield Segment("\n")

        yield Segment(" " * width_labels)
        yield Segment(self.box.top_left)
        yield Segment(self.box.top * width_content)
        yield Segment(self.box.top_right)
        yield Segment("\n")

        for row in self.rows:
            yield Segment(f"{row.label: >{width_labels - 1}} ")
            yield Segment(self.box.row_right)
            yield Segment(row.content) if type(row.content) is str else row.content
            yield Segment(" " * (width_content - row.content_width))
            yield Segment(self.box.mid_right)
            yield Segment("\n")

        yield Segment(" " * width_labels)
        yield Segment(self.box.bottom_left)
        yield Segment(self.box.bottom * width_content)
        yield Segment(self.box.bottom_right)
        yield Segment("\n")

        if self.ticks:
            yield Segment(" " * (width_labels + 1))
            yield Segment(f"{self.ticks[0]: <{width_content // 2}}")
            yield Segment(f"{self.ticks[1]: >{width_content - width_content // 2}}")
            yield Segment("\n")

add_row(content, content_width, label='')

Add row to chart.

Parameters:

Name Type Description Default
content Union[RenderableType, Segment]

RenderableType representing the content.

 required
content_width int

Width of the content.

 required
label str

Label of the content line.

 ''

Returns:

Name Type Description
LabelChartRow LabelChartRow

Row created and added to LabelChartRenderer.
Source code in src/graphical/chart.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def add_row(
    self,
    content: Union[RenderableType, Segment],
    content_width: int,
    label: str = "",
) -> LabelChartRow:
    """Add row to chart.

    Args:
        content (Union[RenderableType, Segment]): RenderableType representing the content.
        content_width (int): Width of the content.
        label (str): Label of the content line.

    Returns:
        LabelChartRow: Row created and added to LabelChartRenderer.
    """
    row = LabelChartRow(content, content_width, label)
    self.rows.append(row)
    return row

render()

Render the labeled chart.

Returns:

Name Type Description
RenderResult RenderResult

Rendered chart.
Source code in src/graphical/chart.py 
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self) -> RenderResult:
    """Render the labeled chart.

    Returns:
        RenderResult: Rendered chart.
    """
    width_labels = max(len(d.label) for d in self.rows) + 1
    width_content = max(d.content_width for d in self.rows)

    yield Segment(" " * width_labels)
    yield Segment(f"{self.title: ^{width_content + 2}}")
    yield Segment("\n")

    yield Segment(" " * width_labels)
    yield Segment(self.box.top_left)
    yield Segment(self.box.top * width_content)
    yield Segment(self.box.top_right)
    yield Segment("\n")

    for row in self.rows:
        yield Segment(f"{row.label: >{width_labels - 1}} ")
        yield Segment(self.box.row_right)
        yield Segment(row.content) if type(row.content) is str else row.content
        yield Segment(" " * (width_content - row.content_width))
        yield Segment(self.box.mid_right)
        yield Segment("\n")

    yield Segment(" " * width_labels)
    yield Segment(self.box.bottom_left)
    yield Segment(self.box.bottom * width_content)
    yield Segment(self.box.bottom_right)
    yield Segment("\n")

    if self.ticks:
        yield Segment(" " * (width_labels + 1))
        yield Segment(f"{self.ticks[0]: <{width_content // 2}}")
        yield Segment(f"{self.ticks[1]: >{width_content - width_content // 2}}")
        yield Segment("\n")

LabelChartRow dataclass

Content row for labeled chart.

Parameters:

Name Type Description Default
content Union[RenderableType, Segment]

RenderableType representing the content.

 required
content_width int

Width of the content.

 required
label str

Label of the content line.

 ''
Source code in src/graphical/chart.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
@dataclass
class LabelChartRow:
    """Content row for labeled chart.

    Args:
        content (Union[RenderableType, Segment]): RenderableType representing the content.
        content_width (int): Width of the content.
        label (str): Label of the content line.
    """

    content: Union[RenderableType, Segment]
    """Union[RenderableType, Segment]: Content line rendered in the chart."""
    content_width: int
    """int: Width of the chart"""
    label: str = ""
    """str: Label of the content line."""

content instance-attribute

Union[RenderableType, Segment]: Content line rendered in the chart.

content_width instance-attribute

int: Width of the chart

label = '' class-attribute instance-attribute

str: Label of the content line.