flet-charts 0.2.0.dev13__py3-none-any.whl

flet_charts/__init__.py

@@ -0,0 +1,35 @@
+from .bar_chart import (
+    BarChart,
+    BarChartEvent,
+    BarChartTooltip,
+    BarChartTooltipDirection,
+)
+from .bar_chart_group import BarChartGroup
+from .bar_chart_rod import BarChartRod, BarChartRodTooltip
+from .bar_chart_rod_stack_item import BarChartRodStackItem
+from .chart_axis import ChartAxis, ChartAxisLabel
+from .line_chart import (
+    LineChart,
+    LineChartEvent,
+    LineChartEventSpot,
+    LineChartTooltip,
+)
+from .line_chart_data import LineChartData
+from .line_chart_data_point import LineChartDataPoint, LineChartDataPointTooltip
+from .matplotlib_chart import MatplotlibChart
+from .pie_chart import PieChart, PieChartEvent
+from .pie_chart_section import PieChartSection
+from .plotly_chart import PlotlyChart
+from .scatter_chart import ScatterChart, ScatterChartEvent, ScatterChartTooltip
+from .scatter_chart_spot import ScatterChartSpot, ScatterChartSpotTooltip
+from .types import (
+    ChartCirclePoint,
+    ChartCrossPoint,
+    ChartDataPointTooltip,
+    ChartEventType,
+    ChartGridLines,
+    ChartHorizontalAlignment,
+    ChartPointLine,
+    ChartPointShape,
+    ChartSquarePoint,
+)

flet_charts/bar_chart.py

@@ -0,0 +1,237 @@
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import Any, Optional
+
+import flet as ft
+
+from .bar_chart_group import BarChartGroup
+from .chart_axis import ChartAxis
+from .types import ChartEventType, ChartGridLines
+
+__all__ = [
+    "BarChart",
+    "BarChartEvent",
+    "BarChartTooltipDirection",
+    "BarChartTooltip",
+]
+
+
+class BarChartTooltipDirection(Enum):
+    """Controls showing tooltip on top or bottom."""
+
+    AUTO = "auto"
+    """Tooltip shows on top if value is positive, on bottom if value is negative."""
+
+    TOP = "top"
+    """Tooltip always shows on top."""
+
+    BOTTOM = "bottom"
+    """Tooltip always shows on bottom."""
+
+
+@dataclass
+class BarChartTooltip:
+    """Configuration of the tooltip for [`BarChart`][(p).]s."""
+
+    bgcolor: ft.ColorValue = ft.Colors.SECONDARY
+    """
+    Background [color](https://flet.dev/docs/reference/colors) of tooltips.
+    """
+
+    border_radius: Optional[ft.BorderRadiusValue] = None
+    """
+    The border radius of the tooltip.
+    """
+
+    margin: Optional[ft.Number] = None
+    """
+    Applies a bottom margin for showing tooltip on top of rods.
+    """
+
+    padding: Optional[ft.PaddingValue] = None
+    """
+    Applies a padding for showing contents inside the tooltip.
+    """
+
+    max_width: Optional[ft.Number] = None
+    """
+    Restricts the tooltip's width.
+    """
+
+    rotate_angle: Optional[ft.Number] = None
+    """
+    The rotation angle of the tooltip.
+    """
+
+    horizontal_offset: Optional[ft.Number] = None
+    """
+    Applies horizontal offset for showing tooltip.
+    """
+
+    border_side: Optional[ft.BorderSide] = None
+    """
+    The tooltip border side.
+    """
+
+    fit_inside_horizontally: Optional[bool] = None
+    """
+    Forces the tooltip to shift horizontally inside the chart, if overflow happens.
+
+    Value is of type `bool`.
+    """
+
+    fit_inside_vertically: Optional[bool] = None
+    """
+    Forces the tooltip to shift vertically inside the chart, if overflow happens.
+
+    Value is of type `bool`.
+    """
+
+    direction: Optional[BarChartTooltipDirection] = None
+    """
+    Controls showing tooltip on top or bottom, default is auto.
+    """
+
+
+@dataclass
+class BarChartEvent(ft.Event["BarChart"]):
+    type: ChartEventType
+    """
+    The type of event that occurred on the chart.
+    """
+
+    group_index: Optional[int] = None
+    """
+    Bar's index or `-1` if chart is hovered or clicked outside of any bar.
+    """
+
+    rod_index: Optional[int] = None
+    """
+    Rod's index or `-1` if chart is hovered or clicked outside of any bar.
+    """
+
+    stack_item_index: Optional[int] = None
+    """
+    Stack item's index or `-1` if chart is hovered or clicked outside of any bar.
+    """
+
+
+@ft.control("BarChart")
+class BarChart(ft.ConstrainedControl):
+    """
+    Draws a bar chart.
+
+    ![Overview](assets/bar-chart/diagram.svg)
+    """
+
+    groups: list[BarChartGroup] = field(default_factory=list)
+    """
+    The list of [`BarChartGroup`][(p).]s to draw.
+    """
+
+    spacing: Optional[ft.Number] = None
+    """
+    A amount of space between bar groups.
+    """
+
+    animation: ft.AnimationValue = field(
+        default_factory=lambda: ft.Animation(
+            duration=ft.Duration(milliseconds=150), curve=ft.AnimationCurve.LINEAR
+        )
+    )
+    """
+    Controls chart implicit animation.
+
+    Value is of [`AnimationValue`](https://flet.dev/docs/reference/types/animationvalue)
+    type.
+    """
+
+    interactive: bool = True
+    """
+    Enables automatic tooltips when hovering chart bars.
+    """
+
+    bgcolor: Optional[ft.ColorValue] = None
+    """
+    Background [color](https://flet.dev/docs/reference/colors) of the chart.
+    """
+
+    border: Optional[ft.Border] = None
+    """
+    The border around the chart.
+
+    Value is of type [`Border`](https://flet.dev/docs/reference/types/border).
+    """
+
+    horizontal_grid_lines: Optional[ChartGridLines] = None
+    """
+    Controls drawing of chart's horizontal lines.
+
+    Value is of type [`ChartGridLines`][(p).].
+    """
+
+    vertical_grid_lines: Optional[ChartGridLines] = None
+    """
+    Controls drawing of chart's vertical lines.
+
+    Value is of type [`ChartGridLines`][(p).].
+    """
+
+    left_axis: ChartAxis = field(default_factory=lambda: ChartAxis(label_size=44))
+    """
+    The appearance of the left axis, its title and labels.
+
+    Value is of type [`ChartAxis`][(p).].
+    """
+
+    top_axis: ChartAxis = field(default_factory=lambda: ChartAxis(label_size=30))
+    """
+    The appearance of the top axis, its title and labels.
+
+    Value is of type [`ChartAxis`][(p).].
+    """
+
+    right_axis: ChartAxis = field(default_factory=lambda: ChartAxis(label_size=44))
+    """
+    The appearance of the right axis, its title and labels.
+
+    Value is of type [`ChartAxis`][(p).].
+    """
+
+    bottom_axis: ChartAxis = field(default_factory=lambda: ChartAxis(label_size=30))
+    """
+    The appearance of the bottom axis, its title and labels.
+
+    Value is of type [`ChartAxis`][(p).].
+    """
+
+    baseline_y: Optional[ft.Number] = None
+    """
+    Baseline value for Y axis.
+    """
+
+    min_y: Optional[ft.Number] = None
+    """
+    The minimum displayed value for Y axis.
+    """
+
+    max_y: Optional[ft.Number] = None
+    """
+    The maximum displayed value for Y axis.
+    """
+
+    tooltip: Optional[BarChartTooltip] = None
+    """
+    The tooltip configuration for the chart.
+    """
+
+    on_event: ft.OptionalEventHandler[BarChartEvent["BarChart"]] = None
+    """
+    Fires when a bar is hovered or clicked.
+
+    Event handler receives an instance of [`BarChartEvent`][(p).].
+    """
+
+    def __post_init__(self, ref: Optional[ft.Ref[Any]]):
+        super().__post_init__(ref)
+        self._internals["skip_properties"] = ["tooltip"]

flet_charts/bar_chart_group.py

@@ -0,0 +1,33 @@
+from dataclasses import field
+from typing import Optional
+
+import flet as ft
+
+from .bar_chart_rod import BarChartRod
+
+__all__ = ["BarChartGroup"]
+
+
+@ft.control("BarChartGroup")
+class BarChartGroup(ft.BaseControl):
+    x: int = 0
+    """
+    Group position on X axis.
+    """
+
+    rods: list[BarChartRod] = field(default_factory=list)
+    """
+    The list of [`BarChartRod`][(p).]
+    objects to display in the group.
+    """
+
+    group_vertically: bool = False
+    """
+    If set to `True` bar rods are drawn on top of each other; otherwise bar rods
+    are drawn next to each other.
+    """
+
+    spacing: Optional[ft.Number] = None
+    """
+    The amount of space between bar rods.
+    """

flet_charts/bar_chart_rod.py

@@ -0,0 +1,111 @@
+from dataclasses import dataclass, field
+from typing import Any, Optional
+
+import flet as ft
+
+from .bar_chart_rod_stack_item import BarChartRodStackItem
+from .types import ChartDataPointTooltip
+
+__all__ = ["BarChartRod", "BarChartRodTooltip"]
+
+
+@dataclass
+class BarChartRodTooltip(ChartDataPointTooltip):
+    """
+    Tooltip configuration for the  [`BarChartRod`][(p).].
+    """
+
+    text: Optional[str] = None
+    """
+    The text to display in the tooltip.
+
+    When `None`, defaults to [`BarChartRod.to_y`][(p).].
+    """
+
+
+@ft.control("BarChartRod")
+class BarChartRod(ft.BaseControl):
+    """A bar rod in a [`BarChartGroup`][(p).]."""
+
+    stack_items: list[BarChartRodStackItem] = field(default_factory=list)
+    """
+    Optional list of [`BarChartRodStackItem`][(p).] objects to draw a stacked bar.
+    """
+
+    from_y: ft.Number = 0
+    """
+    Specifies a starting position of this rod on Y axis.
+    """
+
+    to_y: Optional[ft.Number] = None
+    """
+    Specifies an ending position of this rod on Y axis.
+    """
+
+    width: Optional[ft.Number] = None
+    """
+    The width of this rod.
+    """
+
+    color: Optional[ft.ColorValue] = None
+    """
+    Rod [color](https://flet.dev/docs/reference/colors).
+    """
+
+    gradient: Optional[ft.Gradient] = None
+    """
+    Gradient to draw rod's background.
+
+    Value is of type [`Gradient`](https://flet.dev/docs/reference/types/gradient).
+    """
+
+    border_radius: Optional[ft.BorderRadiusValue] = None
+    """
+    Border radius of a bar rod.
+    """
+
+    border_side: Optional[ft.BorderSide] = None
+    """
+    Border to draw around rod.
+
+    Value is of type [`BorderSide`](https://flet.dev/docs/reference/types/borderside)
+    class.
+    """
+
+    bg_from_y: Optional[ft.Number] = None
+    """
+    An optional starting position of a background behind this rod.
+    """
+
+    bg_to_y: Optional[ft.Number] = None
+    """
+    An optional ending position of a background behind this rod.
+    """
+
+    bgcolor: Optional[ft.ColorValue] = None
+    """
+    An optional [color](https://flet.dev/docs/reference/colors) of a background behind
+    this rod.
+    """
+
+    background_gradient: Optional[ft.Gradient] = None
+    """
+    An optional gradient to draw a background with.
+    """
+
+    selected: bool = False
+    """
+    If set to `True` a tooltip is always shown on top of the bar when
+    `BarChart.interactive` is set to `False`.
+    """
+
+    tooltip: BarChartRodTooltip = field(default_factory=lambda: BarChartRodTooltip())
+    """
+    The rod's tooltip configuration for this rod.
+    """
+
+    show_tooltip: bool = True
+    """
+    Whether a tooltip should be shown on top of hovered bar.
+    """
+

flet_charts/bar_chart_rod_stack_item.py

@@ -0,0 +1,31 @@
+from dataclasses import field
+from typing import Optional
+
+import flet as ft
+
+__all__ = ["BarChartRodStackItem"]
+
+
+@ft.control("BarChartRodStackItem")
+class BarChartRodStackItem(ft.BaseControl):
+    from_y: Optional[ft.Number] = None
+    """
+    The starting position of this item inside a bar rod.
+    """
+
+    to_y: ft.Number = 0
+    """
+    The ending position of this item inside a bar rod.
+    """
+
+    color: Optional[ft.ColorValue] = None
+    """
+    The [color](https://flet.dev/docs/reference/colors) of this item.
+    """
+
+    border_side: ft.BorderSide = field(default_factory=lambda: ft.BorderSide.none())
+    """
+    A border around this item.
+
+    Value is of type [`BorderSide`](https://flet.dev/docs/reference/types/borderside).
+    """

flet_charts/chart_axis.py

@@ -0,0 +1,64 @@
+from dataclasses import field
+from typing import Optional, Union
+
+import flet as ft
+
+__all__ = ["ChartAxis", "ChartAxisLabel"]
+
+
+@ft.control("ChartAxisLabel")
+class ChartAxisLabel(ft.BaseControl):
+    """
+    Configures a custom label for specific value.
+    """
+
+    value: Optional[ft.Number] = None
+    """
+    A value to draw label for.
+    """
+
+    label: Optional[Union[ft.Control, str]] = None
+    """
+    The label to display for the specified `value`.
+    
+    Can be a string or a `Control`.
+    """
+
+
+@ft.control("ChartAxis")
+class ChartAxis(ft.BaseControl):
+    """
+    Configures chart axis.
+    """
+
+    title: Optional[ft.Control] = None
+    """
+    A `Control` to display as axis title.
+    """
+
+    title_size: ft.Number = 16
+    """
+    Width or height of title area.
+    """
+
+    show_labels: bool = True
+    """
+    Whether to display the `labels` along the axis. 
+    If `labels` is empty then automatic labels are displayed.
+    """
+
+    labels: list[ChartAxisLabel] = field(default_factory=list)
+    """
+    The list of [`ChartAxisLabel`][(p).]
+    objects to set custom axis labels for only specific values.
+    """
+
+    label_spacing: Optional[ft.Number] = None
+    """
+    The interval between automatic labels.
+    """
+
+    label_size: ft.Number = 22
+    """
+    Width or height of labels area.
+    """