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

flet_charts/pie_chart_section.py

@@ -0,0 +1,89 @@
+from dataclasses import field
+from typing import Optional
+
+import flet as ft
+
+__all__ = ["PieChartSection"]
+
+
+@ft.control("PieChartSection")
+class PieChartSection(ft.BaseControl):
+    """
+    Configures a [PieChart][(p).] section.
+
+    Raises:
+        AssertionError: If [`title_position`][(c).] or
+            [`badge_position`][(c).] is not between `0.0` and `1.0` inclusive.
+    """
+
+    value: ft.Number
+    """
+    Determines how much the section should occupy. This depends on sum of all sections,
+    each section should occupy (`value` / sum of all values) * `360` degrees.
+    """
+
+    radius: Optional[ft.Number] = None
+    """
+    External radius of the section.
+    """
+
+    color: Optional[ft.ColorValue] = None
+    """
+    Background [color](https://flet.dev/docs/reference/colors) of the section.
+    """
+
+    border_side: ft.BorderSide = field(default_factory=lambda: ft.BorderSide.none())
+    """
+    The border around section shape.
+
+    Value is of type [`BorderSide`](https://flet.dev/docs/reference/types/borderside).
+    """
+
+    title: Optional[str] = None
+    """
+    A title drawn at the center of the section.
+    """
+
+    title_style: Optional[ft.TextStyle] = None
+    """
+    The style to draw `title` with.
+
+    The value is an instance of [`TextStyle`](https://flet.dev/docs/reference/types/textstyle) 
+    class.
+    """
+
+    title_position: Optional[ft.Number] = None
+    """
+    The position/offset of the title relative to the section's center.
+    
+    By default the title is drawn in the middle of the section.
+    
+    Note:
+        Must be between `0.0` (near the center) 
+        and `1.0`(near the outside of the chart) inclusive.
+    """
+
+    badge: Optional[ft.Control] = None
+    """
+    An optional `Control` drawn in the middle of a section.
+    """
+
+    badge_position: Optional[ft.Number] = None
+    """
+    The position/offset of the badge relative to the section's center.
+    
+    By default the badge is drawn in the middle of the section.
+    
+    Note:
+        Must be between `0.0` (near the center) 
+        and `1.0`(near the outside of the chart) inclusive.
+    """
+
+    def before_update(self):
+        super().before_update()
+        assert self.title_position is None or (0.0 <= self.title_position <= 1.0), (
+            f"title_position ({self.title_position}) must be between 0.0 and 1.0 inclusive"
+        )
+        assert self.badge_position is None or (0.0 <= self.badge_position <= 1.0), (
+            f"badge_position ({self.badge_position}) must be between 0.0 and 1.0 inclusive"
+        )

flet_charts/plotly_chart.py

@@ -0,0 +1,56 @@
+import re
+import xml.etree.ElementTree as ET
+from dataclasses import field
+
+import flet as ft
+
+try:
+    from plotly.graph_objects import Figure
+except ImportError as e:
+    raise Exception(
+        'Install "plotly" Python package to use PlotlyChart control.'
+    ) from e
+
+__all__ = ["PlotlyChart"]
+
+
+@ft.control(kw_only=True)
+class PlotlyChart(ft.Container):
+    """
+    Displays a [Plotly](https://plotly.com/python/) chart.
+
+    Warning:
+        This control requires the [`plotly`](https://plotly.com/python/) Python package to be installed.
+
+        See this [installation guide](index.md#installation) for more information.
+    """
+
+    figure: Figure = field(metadata={"skip": True})
+    """
+    Plotly figure to draw - 
+    an instance of [`plotly.graph_objects.Figure`](https://plotly.com/python-api-reference/generated/plotly.graph_objects.Figure.html).
+    """
+
+    original_size: bool = False
+    """
+    Whether to display this chart in original size.
+
+    Set to `False` for it to fit it's configured bounds.
+    """
+
+    def init(self):
+        self.alignment = ft.Alignment.center()
+        self.__img = ft.Image(fit=ft.BoxFit.FILL)
+        self.content = self.__img
+
+    def before_update(self):
+        super().before_update()
+        if self.figure is not None:
+            svg = self.figure.to_image(format="svg").decode("utf-8")
+
+            if not self.original_size:
+                root = ET.fromstring(svg)
+                w = float(re.findall(r"\d+", root.attrib["width"])[0])
+                h = float(re.findall(r"\d+", root.attrib["height"])[0])
+                self.__img.aspect_ratio = w / h
+            self.__img.src = svg

flet_charts/scatter_chart.py

@@ -0,0 +1,218 @@
+from dataclasses import dataclass, field
+from typing import Any, Optional
+
+import flet as ft
+
+from .chart_axis import ChartAxis
+from .scatter_chart_spot import ScatterChartSpot
+from .types import ChartEventType, ChartGridLines, ChartHorizontalAlignment
+
+__all__ = ["ScatterChart", "ScatterChartEvent", "ScatterChartTooltip"]
+
+
+@dataclass
+class ScatterChartTooltip:
+    """Configuration of the tooltip for [`ScatterChart`][(p).]s."""
+
+    bgcolor: ft.ColorValue = "#FF607D8B"
+    """
+    The tooltip's background [color](https://flet.dev/docs/reference/colors).
+    """
+
+    border_radius: Optional[ft.BorderRadiusValue] = None
+    """
+    The tooltip's border radius.
+    """
+
+    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 tooltip's rotation angle in degrees.
+    """
+
+    horizontal_offset: Optional[ft.Number] = None
+    """
+    Applies horizontal offset for showing tooltip.
+    """
+
+    horizontal_alignment: Optional[ChartHorizontalAlignment] = None
+    """
+    The tooltip's horizontal alignment.
+    """
+
+    border_side: Optional[ft.BorderSide] = None
+    """
+    The tooltip's border side.
+    """
+
+    fit_inside_horizontally: Optional[bool] = None
+    """
+    Forces the tooltip to shift horizontally inside the chart, if overflow happens.
+    """
+
+    fit_inside_vertically: Optional[bool] = None
+    """
+    Forces the tooltip to shift vertically inside the chart, if overflow happens.
+    """
+
+
+@dataclass
+class ScatterChartEvent(ft.Event[ft.EventControlType]):
+    type: ChartEventType
+    """
+    Type of the event (e.g. tapDown, panUpdate)
+    """
+
+    spot_index: Optional[int] = None
+    """
+    Index of the touched spot, if any
+    """
+
+
+@ft.control("ScatterChart")
+class ScatterChart(ft.ConstrainedControl):
+    """
+    A scatter chart control.
+
+    ScatterChart draws some points in a square space,
+    points are defined by [`ScatterChartSpot`][(p).]s.
+    """
+
+    spots: list[ScatterChartSpot] = field(default_factory=list)
+    """
+    List of [`ScatterChartSpot`][(p).]s to show on the chart.
+    """
+
+    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.
+    """
+
+    handle_built_in_touches: bool = True
+    """
+    Whether to show a tooltip popup on top of the spots if a touch occurs.
+    """
+
+    long_press_duration: Optional[ft.DurationValue] = None
+    """
+    The duration of a long press on the chart.
+    """
+
+    bgcolor: Optional[ft.ColorValue] = None
+    """
+    The chart's background color.
+    """
+
+    border: Optional[ft.Border] = None
+    """
+    The border around the chart.
+    """
+
+    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())
+    """
+    Configures the appearance of the left axis, its title and labels.
+
+    Value is of type [`ChartAxis`][(p).].
+    """
+
+    top_axis: ChartAxis = field(default_factory=lambda: ChartAxis())
+    """
+    Configures the appearance of the top axis, its title and labels.
+
+    Value is of type [`ChartAxis`][(p).].
+    """
+
+    right_axis: ChartAxis = field(default_factory=lambda: ChartAxis())
+    """
+    Configures the appearance of the right axis, its title and labels.
+
+    Value is of type [`ChartAxis`][(p).].
+    """
+
+    bottom_axis: ChartAxis = field(default_factory=lambda: ChartAxis())
+    """
+    Configures the appearance of the bottom axis, its title and labels.
+
+    Value is of type [`ChartAxis`][(p).].
+    """
+
+    baseline_x: Optional[ft.Number] = None
+    """
+    The baseline value for X axis.
+    """
+
+    min_x: Optional[ft.Number] = None
+    """
+    The minimum displayed value for X axis.
+    """
+
+    max_x: Optional[ft.Number] = None
+    """
+    The maximum displayed value for X axis.
+    """
+
+    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[ScatterChartTooltip] = None
+    """
+    The tooltip configuration for the chart.
+    """
+
+    on_event: ft.OptionalEventHandler[ScatterChartEvent["ScatterChart"]] = None
+    """
+    Fires when an event occurs on the chart.
+    
+    Event handler receives an instance of [`ScatterChartEvent`][(p).].
+    """
+
+    def __post_init__(self, ref: Optional[ft.Ref[Any]]):
+        super().__post_init__(ref)
+        self._internals["skip_properties"] = ["tooltip"]

flet_charts/scatter_chart_spot.py

@@ -0,0 +1,102 @@
+from dataclasses import dataclass, field
+from typing import Any, Optional, Union
+
+import flet as ft
+
+from .types import ChartDataPointTooltip, ChartPointShape
+
+__all__ = ["ScatterChartSpot", "ScatterChartSpotTooltip"]
+
+
+@dataclass
+class ScatterChartSpotTooltip(ChartDataPointTooltip):
+    """
+    Tooltip configuration for the [`ScatterChartSpot`][(p).].
+    """
+
+    text: Optional[str] = None
+    """
+    The text to display in the tooltip.
+
+    When `None`, defaults to [`ScatterChartSpot.y`][(p).].
+    """
+
+
+@ft.control("ScatterChartSpot")
+class ScatterChartSpot(ft.BaseControl):
+    """A spot on a scatter chart."""
+
+    x: Optional[ft.Number] = None
+    """
+    The position of a spot on `X` axis.
+    """
+
+    y: Optional[ft.Number] = None
+    """
+    The position of a spot on `Y` axis.
+    """
+
+    visible: bool = True
+    """
+    Determines wether to show or hide the spot.
+    """
+
+    radius: Optional[ft.Number] = None
+    """
+    Radius of a spot.
+    """
+
+    color: Optional[ft.ColorValue] = None
+    """
+    Color of a spot.
+    """
+
+    render_priority: ft.Number = 0
+    """
+    Sort by this to manage overlap.
+    """
+
+    x_error: Optional[Any] = None
+    """
+    Determines the error range of the data point using 
+    (FlErrorRange)[https://github.com/imaNNeo/fl_chart/blob/main/repo_files/documentations/base_chart.md#flerrorrange] 
+    (which ontains lowerBy and upperValue) for the `X` axis.
+    """
+
+    y_error: Optional[Any] = None
+    """
+    Determines the error range of the data point using 
+    (FlErrorRange)[https://github.com/imaNNeo/fl_chart/blob/main/repo_files/documentations/base_chart.md#flerrorrange] 
+    (which ontains lowerBy and upperValue) for the `Y` axis.
+    """
+
+    selected: bool = False
+    """
+    TBD
+    """
+
+    tooltip: ScatterChartSpotTooltip = field(default_factory=lambda: ScatterChartSpotTooltip())
+    """
+    Tooltip configuration for this spot.
+    """
+
+    show_tooltip: bool = True
+    """
+    Wether to show the tooltip.
+    """
+
+    label_text: Optional[str] = None
+    """
+    TBD
+    """
+
+    label_style: Optional[ft.TextStyle] = None
+    """
+    TBD
+    """
+
+    point: Union[None, bool, ChartPointShape] = None
+    """
+    TBD
+    """
+