flet-charts 0.2.0.dev18__tar.gz → 0.2.0.dev40__tar.gz

{flet_charts-0.2.0.dev18/src/flet_charts.egg-info → flet_charts-0.2.0.dev40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-charts
-Version: 0.2.0.dev18
+Version: 0.2.0.dev40
 Summary: A Flet extension for creating interactive charts and graphs.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0

{flet_charts-0.2.0.dev18 → flet_charts-0.2.0.dev40}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flet-charts"
-version = "0.2.0.dev18"
+version = "0.2.0.dev40"
 description = "A Flet extension for creating interactive charts and graphs."
 readme = "README.md"
 authors = [{ name = "Flet contributors", email = "hello@flet.dev" }]
@@ -25,24 +25,43 @@ plotly = ["plotly>=6.0.1"]
 matplotlib = ["matplotlib>=3.10.1"]
 
 [dependency-groups]
+test = [
+    "pytest >=7.2.0",
+]
+lint = [
+    "ruff >=0.11.7",
+]
 dev = [
-    "pre-commit>=4.2.0",
-    "ruff>=0.11.7",
-    "matplotlib>=3.10.1",
-    "plotly>=6.0.1",
+    "pre-commit >=4.2.0",
+    { include-group = 'lint' },
+    { include-group = 'test' },
+]
+docs-coverage = [
+    "docstr-coverage >=2.3.2",
 ]
 docs = [
-    "mkdocs",
-    "mkdocs-material",
-    "mkdocstrings[python]",
-    "mkdocstrings-python-xref",
-    "mike",
-    "markdown>=3.6",
-    "pymdown-extensions",
-    "mkdocs-glightbox",
-    "mkdocs-section-index",
-    "griffe-modernized-annotations",
-    "pygments>=2.16",
+    "mkdocs >=1.6.1",
+    "mkdocs-material >=9.6.15",
+    "mkdocstrings-python >=1.16.12",
+    "mkdocstrings-python-xref >=1.16.3",
+    "mike >=2.1.3",
+    "markdown >=3.6",
+    "pymdown-extensions >=10.16",
+    "mkdocs-exclude >=1.0.2",
+    "mkdocs-glightbox >=0.4.0",
+    "mkdocs-open-in-new-tab >=1.0.8",
+    "mkdocs-section-index >=0.3.10",
+    "griffe-modernized-annotations >=1.0.8",
+    "griffe-warnings-deprecated >=1.1.0",
+    "pygments >=2.16",
+    "markdown-exec[ansi] >=1.11.0",
+    "pydocstyle >=6.3.0",
+    "linkcheckmd >=1.4.0",
+    { include-group = 'docs-coverage' },
+]
+all = [
+    { include-group = 'dev' },
+    { include-group = 'docs' },
 ]
 
 [tool.ruff]
@@ -67,6 +86,7 @@ select = [
     "I"
 ]
 preview = true
+pydocstyle = { convention = 'google' }
 
 [tool.ruff.format]
 quote-style = "double"

{flet_charts-0.2.0.dev18 → flet_charts-0.2.0.dev40}/src/flet_charts/__init__.py

@@ -33,3 +33,42 @@ from .types import (
     ChartPointShape,
     ChartSquarePoint,
 )
+
+__all__ = [
+    "BarChart",
+    "BarChartEvent",
+    "BarChartGroup",
+    "BarChartRod",
+    "BarChartRodStackItem",
+    "BarChartRodTooltip",
+    "BarChartTooltip",
+    "BarChartTooltipDirection",
+    "ChartAxis",
+    "ChartAxisLabel",
+    "ChartCirclePoint",
+    "ChartCrossPoint",
+    "ChartDataPointTooltip",
+    "ChartEventType",
+    "ChartGridLines",
+    "ChartHorizontalAlignment",
+    "ChartPointLine",
+    "ChartPointShape",
+    "ChartSquarePoint",
+    "LineChart",
+    "LineChartData",
+    "LineChartDataPoint",
+    "LineChartDataPointTooltip",
+    "LineChartEvent",
+    "LineChartEventSpot",
+    "LineChartTooltip",
+    "MatplotlibChart",
+    "PieChart",
+    "PieChartEvent",
+    "PieChartSection",
+    "PlotlyChart",
+    "ScatterChart",
+    "ScatterChartEvent",
+    "ScatterChartSpot",
+    "ScatterChartSpotTooltip",
+    "ScatterChartTooltip",
+]

{flet_charts-0.2.0.dev18 → flet_charts-0.2.0.dev40}/src/flet_charts/bar_chart.py

@@ -11,8 +11,8 @@ from .types import ChartEventType, ChartGridLines
 __all__ = [
     "BarChart",
     "BarChartEvent",
-    "BarChartTooltipDirection",
     "BarChartTooltip",
+    "BarChartTooltipDirection",
 ]
 
 
@@ -35,7 +35,7 @@ class BarChartTooltip:
 
     bgcolor: ft.ColorValue = ft.Colors.SECONDARY
     """
-    Background [color](https://flet.dev/docs/reference/colors) of tooltips.
+    Background color of tooltips.
     """
 
     border_radius: Optional[ft.BorderRadiusValue] = None
@@ -76,15 +76,11 @@ class BarChartTooltip:
     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
@@ -92,6 +88,48 @@ class BarChartTooltip:
     Controls showing tooltip on top or bottom, default is auto.
     """
 
+    def copy_with(
+        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,
+        rotate_angle: 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,
+    ) -> "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,
+            rotate_angle=rotate_angle
+            if rotate_angle is not None
+            else self.rotate_angle,
+            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,
+        )
+
 
 @dataclass
 class BarChartEvent(ft.Event["BarChart"]):
@@ -141,9 +179,6 @@ class BarChart(ft.ConstrainedControl):
     )
     """
     Controls chart implicit animation.
-
-    Value is of [`AnimationValue`](https://flet.dev/docs/reference/types/animationvalue)
-    type.
     """
 
     interactive: bool = True
@@ -153,56 +188,42 @@ class BarChart(ft.ConstrainedControl):
 
     bgcolor: Optional[ft.ColorValue] = None
     """
-    Background [color](https://flet.dev/docs/reference/colors) of the chart.
+    Background color 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
@@ -225,11 +246,9 @@ class BarChart(ft.ConstrainedControl):
     The tooltip configuration for the chart.
     """
 
-    on_event: ft.OptionalEventHandler[BarChartEvent["BarChart"]] = None
+    on_event: Optional[ft.EventHandler[BarChartEvent]] = 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]]):

{flet_charts-0.2.0.dev18 → flet_charts-0.2.0.dev40}/src/flet_charts/bar_chart_rod.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass, field
-from typing import Any, Optional
+from typing import Optional, Union
 
 import flet as ft
 
@@ -22,6 +22,26 @@ class BarChartRodTooltip(ChartDataPointTooltip):
     When `None`, defaults to [`BarChartRod.to_y`][(p).].
     """
 
+    def copy_with(
+        self,
+        *,
+        text: Optional[str] = None,
+        text_style: Optional[ft.TextStyle] = None,
+        text_align: Optional[ft.TextAlign] = None,
+        text_spans: Optional[list[ft.TextSpan]] = 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),
+        )
+
 
 @ft.control("BarChartRod")
 class BarChartRod(ft.BaseControl):
@@ -49,14 +69,12 @@ class BarChartRod(ft.BaseControl):
 
     color: Optional[ft.ColorValue] = None
     """
-    Rod [color](https://flet.dev/docs/reference/colors).
+    Rod color.
     """
 
     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
@@ -67,9 +85,6 @@ class BarChartRod(ft.BaseControl):
     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
@@ -84,7 +99,7 @@ class BarChartRod(ft.BaseControl):
 
     bgcolor: Optional[ft.ColorValue] = None
     """
-    An optional [color](https://flet.dev/docs/reference/colors) of a background behind
+    An optional color of a background behind
     this rod.
     """
 
@@ -96,10 +111,12 @@ class BarChartRod(ft.BaseControl):
     selected: bool = False
     """
     If set to `True` a tooltip is always shown on top of the bar when
-    `BarChart.interactive` is set to `False`.
+    [`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.
     """
@@ -109,3 +126,10 @@ 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-0.2.0.dev18 → flet_charts-0.2.0.dev40}/src/flet_charts/bar_chart_rod_stack_item.py

@@ -20,12 +20,10 @@ class BarChartRodStackItem(ft.BaseControl):
 
     color: Optional[ft.ColorValue] = None
     """
-    The [color](https://flet.dev/docs/reference/colors) of this item.
+    The color 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-0.2.0.dev18 → flet_charts-0.2.0.dev40}/src/flet_charts/line_chart.py

@@ -27,9 +27,23 @@ class LineChartEventSpot:
     The line's point index or `-1` if no point was hovered.
     """
 
+    def copy_with(
+        self,
+        *,
+        bar_index: Optional[int] = None,
+        spot_index: Optional[int] = None,
+    ) -> "LineChartEventSpot":
+        """
+        Returns a copy of this object with the specified properties overridden.
+        """
+        return LineChartEventSpot(
+            bar_index=bar_index if bar_index is not None else self.bar_index,
+            spot_index=spot_index if spot_index is not None else self.spot_index,
+        )
+
 
 @dataclass
-class LineChartEvent(ft.Event[ft.EventControlType]):
+class LineChartEvent(ft.Event["LineChart"]):
     type: ChartEventType
     """
     The type of event that occured.
@@ -47,7 +61,7 @@ class LineChartTooltip:
 
     bgcolor: ft.ColorValue = "#FF607D8B"
     """
-    Background [color](https://flet.dev/docs/reference/colors) of tooltip.
+    Background color of tooltip.
     """
 
     border_radius: Optional[ft.BorderRadiusValue] = None
@@ -65,8 +79,6 @@ class LineChartTooltip:
     )
     """
     Applies a padding for showing contents inside the tooltip.
-
-    Value is of type [`PaddingValue`](https://flet.dev/docs/reference/types/aliases#paddingvalue).
     """
 
     max_width: ft.Number = 120
@@ -104,6 +116,50 @@ class LineChartTooltip:
     Whether to force the tooltip container to top of the line.
     """
 
+    def copy_with(
+        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,
+        rotate_angle: 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,
+        show_on_top_of_chart_box_area: Optional[bool] = None,
+    ) -> "LineChartTooltip":
+        """
+        Returns a copy of this object with the specified properties overridden.
+        """
+        return LineChartTooltip(
+            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,
+            rotate_angle=rotate_angle
+            if rotate_angle is not None
+            else self.rotate_angle,
+            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,
+            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,
+        )
+
 
 @ft.control("LineChart")
 class LineChart(ft.ConstrainedControl):
@@ -126,8 +182,6 @@ class LineChart(ft.ConstrainedControl):
     )
     """
     Controls chart implicit animation.
-
-    Value is of type [`AnimationValue`](https://flet.dev/docs/reference/types/animationvalue).
     """
 
     interactive: bool = True
@@ -151,56 +205,42 @@ class LineChart(ft.ConstrainedControl):
 
     bgcolor: Optional[ft.ColorValue] = None
     """
-    Background [color](https://flet.dev/docs/reference/colors) of the chart.
+    Background color 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))
     """
     Defines 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))
     """
     Defines 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))
     """
     Defines 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))
     """
     Defines the appearance of the bottom axis, its title and labels.
-
-    Value is of type [`ChartAxis`][(p).].
     """
 
     baseline_x: Optional[ft.Number] = None
@@ -238,11 +278,9 @@ class LineChart(ft.ConstrainedControl):
     The tooltip configuration for this chart.
     """
 
-    on_event: ft.OptionalEventHandler[LineChartEvent["LineChart"]] = None
+    on_event: Optional[ft.EventHandler[LineChartEvent]] = None
     """
     Fires when a chart line is hovered or clicked.
-
-    Value is of type [`LineChartEvent`][(p).].
     """
 
     def __post_init__(self, ref: Optional[ft.Ref[Any]]):

{flet_charts-0.2.0.dev18 → flet_charts-0.2.0.dev40}/src/flet_charts/line_chart_data.py

@@ -24,14 +24,12 @@ class LineChartData(ft.BaseControl):
 
     color: ft.ColorValue = ft.Colors.CYAN
     """
-    A [color](https://flet.dev/docs/reference/colors) of chart line.
+    A color of chart line.
     """
 
     gradient: Optional[ft.Gradient] = None
     """
     Gradient to draw line's background.
-
-    Value is of type [`Gradient`](https://flet.dev/docs/reference/types/gradient).
     """
 
     stroke_width: ft.Number = 2.0
@@ -62,17 +60,17 @@ class LineChartData(ft.BaseControl):
     drawn.
     """
 
-    shadow: ft.BoxShadow = field(default_factory=lambda: ft.BoxShadow(color=ft.Colors.TRANSPARENT))
+    shadow: ft.BoxShadow = field(
+        default_factory=lambda: ft.BoxShadow(color=ft.Colors.TRANSPARENT)
+    )
     """
     Shadow to drop by a chart line.
-
-    Value is of type [`BoxShadow`](https://flet.dev/docs/reference/types/boxshadow).
     """
 
     above_line_bgcolor: Optional[ft.ColorValue] = None
     """
     Fill the area above chart line with the specified
-    [color](https://flet.dev/docs/reference/colors).
+    color.
     """
 
     above_line_gradient: Optional[ft.Gradient] = None
@@ -88,14 +86,12 @@ class LineChartData(ft.BaseControl):
     above_line: Optional[ChartPointLine] = None
     """
     A vertical line drawn between a line point and the top edge of the chart.
-
-    Value is of type [`ChartPointLine`][(p).].
     """
 
     below_line_bgcolor: Optional[ft.ColorValue] = None
     """
     Fill the area below chart line with the specified
-    [color](https://flet.dev/docs/reference/colors).
+    color.
     """
 
     below_line_gradient: Optional[ft.Gradient] = None
@@ -111,30 +107,24 @@ class LineChartData(ft.BaseControl):
     below_line: Optional[ChartPointLine] = None
     """
     A vertical line drawn between a line point and the bottom edge of the chart.
-
-    Value is of type [`ChartPointLine`][(p).].
     """
 
     selected_below_line: Union[None, bool, ChartPointLine] = None
     """
     A vertical line drawn between selected line point and the bottom adge of the
-    chart. The value is either `True` - draw a line with default style, `False` - do
-    not draw a line under selected point, or an instance of
-    [`ChartPointLine`][(p).] class to
-    specify line style to draw.
+    chart.
+
+    Setting this property to `True` will draw a line with default style.
     """
 
     point: Union[None, bool, ChartPointShape] = None
     """
     Defines the appearance and shape of a line point (dot).
 
-    Value is of type bool (`True` - draw a point with default style or `False` - do
-    not draw a line point) or of type [`ChartPointShape`][(p).].
+    Setting this property to `True` will draw a point with default style.
     """
 
     selected_point: Union[None, bool, ChartPointShape] = None
     """
     Defines the appearance and shape of a selected line point.
-
-    Value is of type [`ChartPointShape`][(p).].
     """