flet-charts 0.2.0.dev35__py3-none-any.whl → 0.70.0.dev6555__py3-none-any.whl

flet_charts/__init__.py

@@ -1,37 +1,65 @@
-from .bar_chart import (
+from flet_charts.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 (
+from flet_charts.bar_chart_group import BarChartGroup
+from flet_charts.bar_chart_rod import BarChartRod, BarChartRodTooltip
+from flet_charts.bar_chart_rod_stack_item import BarChartRodStackItem
+from flet_charts.candlestick_chart import (
+    CandlestickChart,
+    CandlestickChartEvent,
+    CandlestickChartTooltip,
+)
+from flet_charts.candlestick_chart_spot import (
+    CandlestickChartSpot,
+    CandlestickChartSpotTooltip,
+)
+from flet_charts.chart_axis import ChartAxis, ChartAxisLabel
+from flet_charts.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 (
+from flet_charts.line_chart_data import LineChartData
+from flet_charts.line_chart_data_point import (
+    LineChartDataPoint,
+    LineChartDataPointTooltip,
+)
+from flet_charts.matplotlib_chart import (
+    MatplotlibChart,
+    MatplotlibChartMessageEvent,
+    MatplotlibChartToolbarButtonsUpdateEvent,
+)
+from flet_charts.matplotlib_chart_with_toolbar import MatplotlibChartWithToolbar
+from flet_charts.pie_chart import PieChart, PieChartEvent
+from flet_charts.pie_chart_section import PieChartSection
+from flet_charts.plotly_chart import PlotlyChart
+from flet_charts.radar_chart import (
+    RadarChart,
+    RadarChartEvent,
+    RadarChartTitle,
+    RadarShape,
+)
+from flet_charts.radar_data_set import RadarDataSet, RadarDataSetEntry
+from flet_charts.scatter_chart import (
+    ScatterChart,
+    ScatterChartEvent,
+    ScatterChartTooltip,
+)
+from flet_charts.scatter_chart_spot import ScatterChartSpot, ScatterChartSpotTooltip
+from flet_charts.types import (
     ChartCirclePoint,
     ChartCrossPoint,
     ChartDataPointTooltip,
     ChartEventType,
     ChartGridLines,
-    ChartHorizontalAlignment,
     ChartPointLine,
     ChartPointShape,
     ChartSquarePoint,
+    HorizontalAlignment,
 )
 
 __all__ = [
@@ -43,6 +71,11 @@ __all__ = [
     "BarChartRodTooltip",
     "BarChartTooltip",
     "BarChartTooltipDirection",
+    "CandlestickChart",
+    "CandlestickChartEvent",
+    "CandlestickChartSpot",
+    "CandlestickChartSpotTooltip",
+    "CandlestickChartTooltip",
     "ChartAxis",
     "ChartAxisLabel",
     "ChartCirclePoint",
@@ -50,10 +83,10 @@ __all__ = [
     "ChartDataPointTooltip",
     "ChartEventType",
     "ChartGridLines",
-    "ChartHorizontalAlignment",
     "ChartPointLine",
     "ChartPointShape",
     "ChartSquarePoint",
+    "HorizontalAlignment",
     "LineChart",
     "LineChartData",
     "LineChartDataPoint",
@@ -62,10 +95,19 @@ __all__ = [
     "LineChartEventSpot",
     "LineChartTooltip",
     "MatplotlibChart",
+    "MatplotlibChartMessageEvent",
+    "MatplotlibChartToolbarButtonsUpdateEvent",
+    "MatplotlibChartWithToolbar",
     "PieChart",
     "PieChartEvent",
     "PieChartSection",
     "PlotlyChart",
+    "RadarChart",
+    "RadarChartEvent",
+    "RadarChartTitle",
+    "RadarDataSet",
+    "RadarDataSetEntry",
+    "RadarShape",
     "ScatterChart",
     "ScatterChartEvent",
     "ScatterChartSpot",

flet_charts/bar_chart.py

@@ -3,10 +3,9 @@ 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
+from flet_charts.bar_chart_group import BarChartGroup
+from flet_charts.chart_axis import ChartAxis
+from flet_charts.types import ChartEventType, ChartGridLines, HorizontalAlignment
 
 __all__ = [
     "BarChart",
@@ -43,12 +42,14 @@ class BarChartTooltip:
     The border radius of the tooltip.
     """
 
-    margin: Optional[ft.Number] = None
+    margin: ft.Number = 16
     """
     Applies a bottom margin for showing tooltip on top of rods.
     """
 
-    padding: Optional[ft.PaddingValue] = None
+    padding: ft.PaddingValue = field(
+        default_factory=lambda: ft.Padding.symmetric(vertical=8, horizontal=16)
+    )
     """
     Applies a padding for showing contents inside the tooltip.
     """
@@ -58,14 +59,14 @@ class BarChartTooltip:
     Restricts the tooltip's width.
     """
 
-    rotate_angle: Optional[ft.Number] = None
+    rotation: ft.Number = 0.0
     """
     The rotation angle of the tooltip.
     """
 
-    horizontal_offset: Optional[ft.Number] = None
+    horizontal_offset: ft.Number = 0.0
     """
-    Applies horizontal offset for showing tooltip.
+    The horizontal offset of this tooltip.
     """
 
     border_side: Optional[ft.BorderSide] = None
@@ -73,20 +74,69 @@ class BarChartTooltip:
     The tooltip border side.
     """
 
-    fit_inside_horizontally: Optional[bool] = None
+    fit_inside_horizontally: bool = False
     """
     Forces the tooltip to shift horizontally inside the chart, if overflow happens.
     """
 
-    fit_inside_vertically: Optional[bool] = None
+    fit_inside_vertically: bool = False
     """
     Forces the tooltip to shift vertically inside the chart, if overflow happens.
     """
 
-    direction: Optional[BarChartTooltipDirection] = None
-    """
-    Controls showing tooltip on top or bottom, default is auto.
-    """
+    direction: BarChartTooltipDirection = BarChartTooltipDirection.AUTO
+    """
+    Defines the direction of this tooltip.
+    """
+
+    horizontal_alignment: HorizontalAlignment = HorizontalAlignment.CENTER
+    """
+    Defines the horizontal alignment of this tooltip.
+    """
+
+    def copy(
+        self,
+        *,
+        bgcolor: Optional[ft.ColorValue] = None,
+        border_radius: Optional[ft.BorderRadiusValue] = None,
+        margin: Optional[ft.Number] = None,
+        padding: Optional[ft.PaddingValue] = None,
+        max_width: Optional[ft.Number] = None,
+        rotation: Optional[ft.Number] = None,
+        horizontal_offset: Optional[ft.Number] = None,
+        border_side: Optional[ft.BorderSide] = None,
+        fit_inside_horizontally: Optional[bool] = None,
+        fit_inside_vertically: Optional[bool] = None,
+        direction: Optional[BarChartTooltipDirection] = None,
+        horizontal_alignment: Optional[HorizontalAlignment] = None,
+    ) -> "BarChartTooltip":
+        """
+        Returns a copy of this object with the specified properties overridden.
+        """
+        return BarChartTooltip(
+            bgcolor=bgcolor if bgcolor is not None else self.bgcolor,
+            border_radius=border_radius
+            if border_radius is not None
+            else self.border_radius,
+            margin=margin if margin is not None else self.margin,
+            padding=padding if padding is not None else self.padding,
+            max_width=max_width if max_width is not None else self.max_width,
+            rotation=rotation if rotation is not None else self.rotation,
+            horizontal_offset=horizontal_offset
+            if horizontal_offset is not None
+            else self.horizontal_offset,
+            border_side=border_side if border_side is not None else self.border_side,
+            fit_inside_horizontally=fit_inside_horizontally
+            if fit_inside_horizontally is not None
+            else self.fit_inside_horizontally,
+            fit_inside_vertically=fit_inside_vertically
+            if fit_inside_vertically is not None
+            else self.fit_inside_vertically,
+            direction=direction if direction is not None else self.direction,
+            horizontal_alignment=horizontal_alignment
+            if horizontal_alignment is not None
+            else self.horizontal_alignment,
+        )
 
 
 @dataclass
@@ -113,11 +163,9 @@ class BarChartEvent(ft.Event["BarChart"]):
 
 
 @ft.control("BarChart")
-class BarChart(ft.ConstrainedControl):
+class BarChart(ft.LayoutControl):
     """
     Draws a bar chart.
-
-    ![Overview](assets/bar-chart/diagram.svg)
     """
 
     groups: list[BarChartGroup] = field(default_factory=list)
@@ -125,9 +173,17 @@ class BarChart(ft.ConstrainedControl):
     The list of [`BarChartGroup`][(p).]s to draw.
     """
 
-    spacing: Optional[ft.Number] = None
+    group_spacing: ft.Number = 16.0
     """
-    A amount of space between bar groups.
+    An amount of space between bar [`groups`][(c).].
+    """
+
+    group_alignment: ft.MainAxisAlignment = ft.MainAxisAlignment.SPACE_EVENLY
+    """
+    The alignment of the bar [`groups`][(c).] within this chart.
+
+    If set to [`MainAxisAlignment.CENTER`][flet.MainAxisAlignment.CENTER],
+    the space between the `groups` can be specified using [`group_spacing`][(c).].
     """
 
     animation: ft.AnimationValue = field(
@@ -137,9 +193,6 @@ class BarChart(ft.ConstrainedControl):
     )
     """
     Controls chart implicit animation.
-
-    Value is of [`AnimationValue`](https://flet.dev/docs/reference/types/animationvalue)
-    type.
     """
 
     interactive: bool = True
@@ -167,22 +220,22 @@ class BarChart(ft.ConstrainedControl):
     Controls drawing of chart's vertical lines.
     """
 
-    left_axis: ChartAxis = field(default_factory=lambda: ChartAxis(label_size=44))
+    left_axis: Optional[ChartAxis] = None
     """
     The appearance of the left axis, its title and labels.
     """
 
-    top_axis: ChartAxis = field(default_factory=lambda: ChartAxis(label_size=30))
+    top_axis: Optional[ChartAxis] = None
     """
     The appearance of the top axis, its title and labels.
     """
 
-    right_axis: ChartAxis = field(default_factory=lambda: ChartAxis(label_size=44))
+    right_axis: Optional[ChartAxis] = None
     """
     The appearance of the right axis, its title and labels.
     """
 
-    bottom_axis: ChartAxis = field(default_factory=lambda: ChartAxis(label_size=30))
+    bottom_axis: Optional[ChartAxis] = None
     """
     The appearance of the bottom axis, its title and labels.
     """
@@ -202,14 +255,18 @@ class BarChart(ft.ConstrainedControl):
     The maximum displayed value for Y axis.
     """
 
-    tooltip: Optional[BarChartTooltip] = None
+    tooltip: Optional[BarChartTooltip] = field(
+        default_factory=lambda: BarChartTooltip()
+    )
     """
-    The tooltip configuration for the chart.
+    The tooltip configuration for this chart.
+
+    If set to `None`, tooltips will not shown throughout this chart.
     """
 
     on_event: Optional[ft.EventHandler[BarChartEvent]] = None
     """
-    Fires when a bar is hovered or clicked.
+    Called when an event occurs on this chart, such as a click or hover.
     """
 
     def __post_init__(self, ref: Optional[ft.Ref[Any]]):

flet_charts/bar_chart_group.py

@@ -2,8 +2,7 @@ from dataclasses import field
 from typing import Optional
 
 import flet as ft
-
-from .bar_chart_rod import BarChartRod
+from flet_charts.bar_chart_rod import BarChartRod
 
 __all__ = ["BarChartGroup"]
 

flet_charts/bar_chart_rod.py

@@ -1,10 +1,9 @@
 from dataclasses import dataclass, field
-from typing import Optional
+from typing import Optional, Union
 
 import flet as ft
-
-from .bar_chart_rod_stack_item import BarChartRodStackItem
-from .types import ChartDataPointTooltip
+from flet_charts.bar_chart_rod_stack_item import BarChartRodStackItem
+from flet_charts.types import ChartDataPointTooltip
 
 __all__ = ["BarChartRod", "BarChartRodTooltip"]
 
@@ -22,6 +21,28 @@ class BarChartRodTooltip(ChartDataPointTooltip):
     When `None`, defaults to [`BarChartRod.to_y`][(p).].
     """
 
+    def copy(
+        self,
+        *,
+        text: Optional[str] = None,
+        text_style: Optional[ft.TextStyle] = None,
+        text_align: Optional[ft.TextAlign] = None,
+        text_spans: Optional[list[ft.TextSpan]] = None,
+        rtl: Optional[bool] = None,
+    ) -> "BarChartRodTooltip":
+        """
+        Returns a copy of this object with the specified properties overridden.
+        """
+        return BarChartRodTooltip(
+            text=text if text is not None else self.text,
+            text_style=text_style if text_style is not None else self.text_style,
+            text_align=text_align if text_align is not None else self.text_align,
+            text_spans=text_spans.copy()
+            if text_spans is not None
+            else (self.text_spans.copy() if self.text_spans is not None else None),
+            rtl=rtl if rtl is not None else self.rtl,
+        )
+
 
 @ft.control("BarChartRod")
 class BarChartRod(ft.BaseControl):
@@ -94,7 +115,9 @@ class BarChartRod(ft.BaseControl):
     [`BarChart.interactive`][(p).] is set to `False`.
     """
 
-    tooltip: BarChartRodTooltip = field(default_factory=lambda: BarChartRodTooltip())
+    tooltip: Union[BarChartRodTooltip, str] = field(
+        default_factory=lambda: BarChartRodTooltip()
+    )
     """
     The rod's tooltip configuration for this rod.
     """
@@ -103,3 +126,11 @@ class BarChartRod(ft.BaseControl):
     """
     Whether a tooltip should be shown on top of hovered bar.
     """
+
+    def before_update(self):
+        super().before_update()
+        self._internals["tooltip"] = (
+            BarChartRodTooltip(text=self.tooltip)
+            if isinstance(self.tooltip, str)
+            else self.tooltip
+        )

flet_charts/candlestick_chart.py

@@ -0,0 +1,269 @@
+from dataclasses import dataclass, field
+from typing import Any, Optional
+
+import flet as ft
+from flet_charts.candlestick_chart_spot import CandlestickChartSpot
+from flet_charts.chart_axis import ChartAxis
+from flet_charts.types import ChartEventType, ChartGridLines, HorizontalAlignment
+
+__all__ = [
+    "CandlestickChart",
+    "CandlestickChartEvent",
+    "CandlestickChartTooltip",
+]
+
+
+@dataclass
+class CandlestickChartTooltip:
+    """Configuration of the tooltip for [`CandlestickChart`][(p).]s."""
+
+    bgcolor: ft.ColorValue = "#FFFFECEF"
+    """
+    Background color applied to the tooltip bubble.
+    """
+
+    border_radius: ft.BorderRadiusValue = field(
+        default_factory=lambda: ft.BorderRadius.all(4)
+    )
+    """
+    Corner radius of the tooltip bubble.
+    """
+
+    padding: ft.PaddingValue = field(
+        default_factory=lambda: ft.Padding.symmetric(vertical=8, horizontal=16)
+    )
+    """
+    Padding inside the tooltip bubble.
+    """
+
+    max_width: ft.Number = 120
+    """
+    Maximum width of the tooltip bubble.
+    """
+
+    rotation: ft.Number = 0.0
+    """
+    Rotation angle (in degrees) applied to the tooltip bubble.
+    """
+
+    horizontal_offset: ft.Number = 0
+    """
+    Horizontal offset applied to the tooltip bubble.
+    """
+
+    horizontal_alignment: HorizontalAlignment = HorizontalAlignment.CENTER
+    """
+    Horizontal alignment of the tooltip relative to the tapped candlestick.
+    """
+
+    border_side: ft.BorderSide = field(default_factory=lambda: ft.BorderSide.none())
+    """
+    The tooltip bubble border.
+    """
+
+    fit_inside_horizontally: bool = False
+    """
+    Forces the tooltip bubble to remain inside the chart horizontally.
+    """
+
+    fit_inside_vertically: bool = False
+    """
+    Forces the tooltip bubble to remain inside the chart vertically.
+    """
+
+    show_on_top_of_chart_box_area: bool = False
+    """
+    When set to `True`, the tooltip is drawn at the top of the chart box.
+    """
+
+    def copy(
+        self,
+        *,
+        bgcolor: Optional[ft.ColorValue] = None,
+        border_radius: Optional[ft.BorderRadiusValue] = None,
+        padding: Optional[ft.PaddingValue] = None,
+        max_width: Optional[ft.Number] = None,
+        rotation: Optional[ft.Number] = None,
+        horizontal_offset: Optional[ft.Number] = None,
+        horizontal_alignment: Optional[HorizontalAlignment] = None,
+        border_side: Optional[ft.BorderSide] = None,
+        fit_inside_horizontally: Optional[bool] = None,
+        fit_inside_vertically: Optional[bool] = None,
+        show_on_top_of_chart_box_area: Optional[bool] = None,
+    ) -> "CandlestickChartTooltip":
+        """
+        Returns a copy of this object with the specified properties overridden.
+        """
+        return CandlestickChartTooltip(
+            bgcolor=bgcolor if bgcolor is not None else self.bgcolor,
+            border_radius=border_radius
+            if border_radius is not None
+            else self.border_radius,
+            padding=padding if padding is not None else self.padding,
+            max_width=max_width if max_width is not None else self.max_width,
+            rotation=rotation if rotation is not None else self.rotation,
+            horizontal_offset=horizontal_offset
+            if horizontal_offset is not None
+            else self.horizontal_offset,
+            horizontal_alignment=horizontal_alignment
+            if horizontal_alignment is not None
+            else self.horizontal_alignment,
+            border_side=border_side if border_side is not None else self.border_side,
+            fit_inside_horizontally=fit_inside_horizontally
+            if fit_inside_horizontally is not None
+            else self.fit_inside_horizontally,
+            fit_inside_vertically=fit_inside_vertically
+            if fit_inside_vertically is not None
+            else self.fit_inside_vertically,
+            show_on_top_of_chart_box_area=show_on_top_of_chart_box_area
+            if show_on_top_of_chart_box_area is not None
+            else self.show_on_top_of_chart_box_area,
+        )
+
+
+@dataclass
+class CandlestickChartEvent(ft.Event["CandlestickChart"]):
+    """Event raised for interactions with a [`CandlestickChart`][(p).]."""
+
+    type: ChartEventType
+    """
+    Type of pointer gesture that triggered the event.
+    """
+
+    spot_index: Optional[int] = None
+    """
+    Index of the candlestick that was interacted with; `None` if none.
+    """
+
+
+@ft.control("CandlestickChart")
+class CandlestickChart(ft.LayoutControl):
+    """
+    Draws a candlestick chart representing OHLC values.
+    """
+
+    spots: list[CandlestickChartSpot] = field(default_factory=list)
+    """
+    Candlesticks to display on the chart.
+    """
+
+    animation: ft.AnimationValue = field(
+        default_factory=lambda: ft.Animation(
+            duration=ft.Duration(milliseconds=150), curve=ft.AnimationCurve.LINEAR
+        )
+    )
+    """
+    Controls chart implicit animations.
+    """
+
+    interactive: bool = True
+    """
+    Enables automatic tooltips and highlighting when hovering the chart.
+    """
+
+    show_tooltips_for_selected_spots_only: bool = False
+    """
+    Whether to permanently and only show the tooltips of spots with their
+    [`selected`][(p).CandlestickChartSpot.selected] property set to `True`.
+    """
+
+    long_press_duration: Optional[ft.DurationValue] = None
+    """
+    The duration of a long press on the chart.
+    """
+
+    touch_spot_threshold: ft.Number = 4
+    """
+    The distance threshold to consider a touch near a candlestick.
+    """
+
+    bgcolor: Optional[ft.ColorValue] = None
+    """
+    Background color of the chart.
+    """
+
+    border: Optional[ft.Border] = None
+    """
+    Border drawn around the chart.
+    """
+
+    horizontal_grid_lines: Optional[ChartGridLines] = None
+    """
+    Horizontal grid lines configuration.
+    """
+
+    vertical_grid_lines: Optional[ChartGridLines] = None
+    """
+    Vertical grid lines configuration.
+    """
+
+    left_axis: Optional[ChartAxis] = None
+    """
+    Appearance of the left axis, its title and labels.
+    """
+
+    top_axis: Optional[ChartAxis] = None
+    """
+    Appearance of the top axis, its title and labels.
+    """
+
+    right_axis: Optional[ChartAxis] = None
+    """
+    Appearance of the right axis, its title and labels.
+    """
+
+    bottom_axis: Optional[ChartAxis] = None
+    """
+    Appearance of the bottom axis, its title and labels.
+    """
+
+    baseline_x: Optional[ft.Number] = None
+    """
+    Baseline value on the X axis.
+    """
+
+    min_x: Optional[ft.Number] = None
+    """
+    Minimum value displayed on the X axis.
+    """
+
+    max_x: Optional[ft.Number] = None
+    """
+    Maximum value displayed on the X axis.
+    """
+
+    baseline_y: Optional[ft.Number] = None
+    """
+    Baseline value on the Y axis.
+    """
+
+    min_y: Optional[ft.Number] = None
+    """
+    Minimum value displayed on the Y axis.
+    """
+
+    max_y: Optional[ft.Number] = None
+    """
+    Maximum value displayed on the Y axis.
+    """
+
+    rotation_quarter_turns: ft.Number = 0
+    """
+    Number of quarter turns (90-degree increments) to rotate the chart.
+    """
+
+    tooltip: Optional[CandlestickChartTooltip] = field(
+        default_factory=lambda: CandlestickChartTooltip()
+    )
+    """
+    Tooltip configuration for the chart.
+    """
+
+    on_event: Optional[ft.EventHandler[CandlestickChartEvent]] = None
+    """
+    Called when an event occurs on this chart.
+    """
+
+    def __post_init__(self, ref: Optional[ft.Ref[Any]]):
+        super().__post_init__(ref)
+        self._internals["skip_properties"] = ["tooltip"]