flet-map 0.2.0.dev46__py3-none-any.whl → 0.2.0.dev58__py3-none-any.whl

flet_map/__init__.py

@@ -39,3 +39,47 @@ from .types import (
     TileDisplay,
     TileLayerEvictErrorTileStrategy,
 )
+
+__all__ = [
+    "AttributionAlignment",
+    "Camera",
+    "CameraFit",
+    "CircleLayer",
+    "CircleMarker",
+    "CursorKeyboardRotationConfiguration",
+    "CursorRotationBehaviour",
+    "DashedStrokePattern",
+    "DottedStrokePattern",
+    "FadeInTileDisplay",
+    "ImageSourceAttribution",
+    "InstantaneousTileDisplay",
+    "InteractionConfiguration",
+    "InteractionFlag",
+    "KeyboardConfiguration",
+    "Map",
+    "MapEvent",
+    "MapEventSource",
+    "MapHoverEvent",
+    "MapLatitudeLongitude",
+    "MapLatitudeLongitudeBounds",
+    "MapPointerEvent",
+    "MapPositionChangeEvent",
+    "MapTapEvent",
+    "Marker",
+    "MarkerLayer",
+    "MultiFingerGesture",
+    "PatternFit",
+    "PolygonLayer",
+    "PolygonMarker",
+    "PolylineLayer",
+    "PolylineMarker",
+    "RichAttribution",
+    "SimpleAttribution",
+    "SolidStrokePattern",
+    "SourceAttribution",
+    "StrokePattern",
+    "TextSourceAttribution",
+    "TileDisplay",
+    "TileLayer",
+    "TileLayerEvictErrorTileStrategy",
+]

flet_map/circle_layer.py

@@ -1,17 +1,18 @@
-from typing import List, Optional
+from typing import Optional
 
 import flet as ft
 
 from .map_layer import MapLayer
 from .types import MapLatitudeLongitude
 
-__all__ = ["CircleMarker", "CircleLayer"]
+__all__ = ["CircleLayer", "CircleMarker"]
 
 
 @ft.control("CircleMarker")
 class CircleMarker(ft.Control):
     """
-    A circular marker displayed on the Map at the specified location through the [`CircleLayer`][(p).].
+    A circular marker displayed on the Map at the specified
+    location through the [`CircleLayer`][(p).].
 
     Raises:
         AssertionError: If the [`border_stroke_width`][(c).] is negative.
@@ -29,14 +30,16 @@ class CircleMarker(ft.Control):
     border_color: Optional[ft.ColorValue] = None
     """
     The color of the circle border line.
-    
-    Needs [`border_stroke_width`][..] to be greater than `0.0` in order to be visible.
+
+    Note:
+        [`border_stroke_width`][..] must to be greater than
+        `0.0` in order for this color to be visible.
     """
 
     border_stroke_width: ft.Number = 0.0
     """
-    The stroke width for the circle border. 
-    
+    The stroke width for the circle border.
+
     Note:
         Must be non-negative.
     """
@@ -48,9 +51,10 @@ class CircleMarker(ft.Control):
 
     def before_update(self):
         super().before_update()
-        assert (
-            self.border_stroke_width >= 0
-        ), "border_stroke_width must be greater than or equal to 0"
+        assert self.border_stroke_width >= 0, (
+            f"border_stroke_width must be greater than or equal to 0, "
+            f"got {self.border_stroke_width}"
+        )
 
 
 @ft.control("CircleLayer")
@@ -59,5 +63,5 @@ class CircleLayer(MapLayer):
     A layer to display [`CircleMarker`][(p).]s.
     """
 
-    circles: List[CircleMarker]
+    circles: list[CircleMarker]
     """A list of [`CircleMarker`][(p).]s to display."""

flet_map/map.py

@@ -22,14 +22,12 @@ __all__ = ["Map"]
 @ft.control("Map")
 class Map(ft.ConstrainedControl):
     """
-    An interactive map control that allows displaying various layers.
+    An interactive map that displays various layers.
     """
 
     layers: list[MapLayer]
     """
     A list of layers to be displayed (stack-like) on the map.
-
-    Value is of type [`MapLayer`][(p).].
     """
 
     initial_center: MapLatitudeLongitude = field(
@@ -37,8 +35,6 @@ class Map(ft.ConstrainedControl):
     )
     """
     The initial center of the map.
-
-    Value is of type `MapLatitudeLongitude`.
     """
 
     initial_rotation: ft.Number = 0.0
@@ -48,7 +44,7 @@ class Map(ft.ConstrainedControl):
 
     initial_zoom: ft.Number = 13.0
     """
-    The zoom when the map is first loaded. 
+    The zoom when the map is first loaded.
     If initial_camera_fit is defined this has no effect.
     """
 
@@ -67,110 +63,96 @@ class Map(ft.ConstrainedControl):
     keep_alive: bool = False
     """
     Whether to enable the built in keep-alive functionality.
-    
-    If the map is within a complex layout, such as a `ListView`,
+
+    If the map is within a complex layout, such as a [`ListView`][flet.ListView],
     the map will reset to it's inital position after it appears back into view.
     To ensure this doesn't happen, enable this flag to prevent it from rebuilding.
     """
 
     max_zoom: Optional[ft.Number] = None
     """
-    The maximum (highest) zoom level of every layer. 
+    The maximum (highest) zoom level of every layer.
     Each layer can specify additional zoom level restrictions.
     """
 
     min_zoom: Optional[ft.Number] = None
     """
-    The minimum (smallest) zoom level of every layer. 
+    The minimum (smallest) zoom level of every layer.
     Each layer can specify additional zoom level restrictions.
     """
 
     animation_curve: ft.AnimationCurve = ft.AnimationCurve.FAST_OUT_SLOWIN
     """
-    The default animation curve to be used for map-animations 
-    when calling instance methods like `zoom_in()`, `rotate_from()`, `move_to()` etc.
+    The default animation curve to be used for map-animations
+    when calling instance methods like [`zoom_in()`][(c).zoom_in],
+    [`rotate_from()`][(c).rotate_from],
+    [`move_to()`][(c).move_to] etc.
     """
 
     animation_duration: ft.DurationValue = field(
         default_factory=lambda: ft.Duration(milliseconds=500)
     )
     """
-    The default animation duration to be used for map-animations 
-    when calling instance methods like `zoom_in()`, `rotate_from()`, `move_to()` etc.
+    The default animation duration to be used for map-animations
+    when calling instance methods like [`zoom_in()`][(c).zoom_in],
+    [`rotate_from()`][(c).rotate_from],
+    [`move_to()`][(c).move_to] etc.
     """
 
     initial_camera_fit: Optional[CameraFit] = None
     """
-    Defines the visible bounds when the map is first loaded. 
-    Takes precedence over `initial_center`/`initial_zoom`.
+    Defines the visible bounds when the map is first loaded.
+    Takes precedence over [`initial_center`][..]/[`initial_zoom`][..].
     """
 
-    on_init: ft.OptionalControlEventHandler["Map"] = None
+    on_init: Optional[ft.ControlEventHandler["Map"]] = None
     """
     Fires when the map is initialized.
     """
 
-    on_tap: ft.OptionalEventHandler[MapTapEvent["Map"]] = None
+    on_tap: Optional[ft.EventHandler[MapTapEvent]] = None
     """
     Fires when a tap event occurs.
-
-    Event handler argument is of type [`MapTapEvent`][(p).].
     """
 
-    on_hover: ft.OptionalEventHandler[MapHoverEvent["Map"]] = None
+    on_hover: Optional[ft.EventHandler[MapHoverEvent]] = None
     """
     Fires when a hover event occurs.
-
-    Event handler argument is of type [`MapHoverEvent`][(p).].
     """
 
-    on_secondary_tap: ft.OptionalEventHandler[MapTapEvent["Map"]] = None
+    on_secondary_tap: Optional[ft.EventHandler[MapTapEvent]] = None
     """
     Fires when a secondary tap event occurs.
-
-    Event handler argument is of type [`MapTapEvent`][(p).].
     """
 
-    on_long_press: ft.OptionalEventHandler[MapTapEvent["Map"]] = None
+    on_long_press: Optional[ft.EventHandler[MapTapEvent]] = None
     """
     Fires when a long press event occurs.
-
-    Event handler argument is of type [`MapTapEvent`][(p).].
     """
 
-    on_event: ft.OptionalEventHandler[MapEvent["Map"]] = None
+    on_event: Optional[ft.EventHandler[MapEvent]] = None
     """
     Fires when any map events occurs.
-
-    Event handler argument is of type [`MapEvent`][(p).].
     """
 
-    on_position_change: ft.OptionalEventHandler[MapPositionChangeEvent["Map"]] = None
+    on_position_change: Optional[ft.EventHandler[MapPositionChangeEvent]] = None
     """
     Fires when the map position changes.
-
-    Event handler argument is of type [`MapPositionChangeEvent`][(p).].
     """
 
-    on_pointer_down: ft.OptionalEventHandler[MapPointerEvent["Map"]] = None
+    on_pointer_down: Optional[ft.EventHandler[MapPointerEvent]] = None
     """
     Fires when a pointer down event occurs.
-
-    Event handler argument is of type [`MapPointerEvent`][(p).].
     """
 
-    on_pointer_cancel: ft.OptionalEventHandler[MapPointerEvent["Map"]] = None
+    on_pointer_cancel: Optional[ft.EventHandler[MapPointerEvent]] = None
     """
     Fires when a pointer cancel event occurs.
-    
-    Event handler argument is of type [`MapPointerEvent`][(p).].
     """
 
-    on_pointer_up: ft.OptionalEventHandler[MapPointerEvent["Map"]] = None
+    on_pointer_up: Optional[ft.EventHandler[MapPointerEvent]] = None
     """
     Fires when a pointer up event occurs.
-
-    Event handler argument is of type [`MapPointerEvent`][(p).].
     """
 
     async def rotate_from_async(
@@ -185,9 +167,12 @@ class Map(ft.ConstrainedControl):
 
         Args:
             degree: The number of degrees to increment to the current rotation.
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         await self._invoke_method_async(
             method_name="rotate_from",
@@ -211,13 +196,19 @@ class Map(ft.ConstrainedControl):
 
         Args:
             degree: The number of degrees to increment to the current rotation.
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         asyncio.create_task(
             self.rotate_from_async(
-                degree, animation_curve, animation_duration, cancel_ongoing_animations
+                degree=degree,
+                animation_curve=animation_curve,
+                animation_duration=animation_duration,
+                cancel_ongoing_animations=cancel_ongoing_animations,
             )
         )
 
@@ -231,9 +222,12 @@ class Map(ft.ConstrainedControl):
         Resets the map's rotation to 0 degrees.
 
         Args:
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         await self._invoke_method_async(
             method_name="reset_rotation",
@@ -254,13 +248,18 @@ class Map(ft.ConstrainedControl):
         Resets the map's rotation to 0 degrees.
 
         Args:
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         asyncio.create_task(
             self.reset_rotation_async(
-                animation_curve, animation_duration, cancel_ongoing_animations
+                animation_curve=animation_curve,
+                animation_duration=animation_duration,
+                cancel_ongoing_animations=cancel_ongoing_animations,
             )
         )
 
@@ -274,9 +273,12 @@ class Map(ft.ConstrainedControl):
         Zooms in by one zoom-level from the current one.
 
         Args:
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         await self._invoke_method_async(
             method_name="zoom_in",
@@ -297,13 +299,18 @@ class Map(ft.ConstrainedControl):
         Zooms in by one zoom-level from the current one.
 
         Args:
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         asyncio.create_task(
             self.zoom_in_async(
-                animation_curve, animation_duration, cancel_ongoing_animations
+                animation_curve=animation_curve,
+                animation_duration=animation_duration,
+                cancel_ongoing_animations=cancel_ongoing_animations,
             )
         )
 
@@ -317,9 +324,12 @@ class Map(ft.ConstrainedControl):
         Zooms out by one zoom-level from the current one.
 
         Args:
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         await self._invoke_method_async(
             method_name="zoom_out",
@@ -340,13 +350,18 @@ class Map(ft.ConstrainedControl):
         Zooms out by one zoom-level from the current one.
 
         Args:
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         asyncio.create_task(
             self.zoom_out_async(
-                animation_curve, animation_duration, cancel_ongoing_animations
+                animation_curve=animation_curve,
+                animation_duration=animation_duration,
+                cancel_ongoing_animations=cancel_ongoing_animations,
             )
         )
 
@@ -362,9 +377,12 @@ class Map(ft.ConstrainedControl):
 
         Args:
             zoom: The zoom level to zoom to.
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         await self._invoke_method_async(
             method_name="zoom_to",
@@ -388,13 +406,19 @@ class Map(ft.ConstrainedControl):
 
         Args:
             zoom: The zoom level to zoom to.
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         asyncio.create_task(
             self.zoom_to_async(
-                zoom, animation_curve, animation_duration, cancel_ongoing_animations
+                zoom=zoom,
+                animation_curve=animation_curve,
+                animation_duration=animation_duration,
+                cancel_ongoing_animations=cancel_ongoing_animations,
             )
         )
 
@@ -413,17 +437,23 @@ class Map(ft.ConstrainedControl):
 
         Args:
             destination: The destination point to move to.
-            zoom: The zoom level to be applied. If provided, must be greater than or equal to `0.0`.
+            zoom: The zoom level to be applied. If provided,
+                must be greater than or equal to `0.0`.
             rotation: Rotation (in degrees) to be applied.
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
             offset: The offset to be used. Only works when `rotation` is `None`.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
 
         Raises:
             AssertionError: If `zoom` is not `None` and is negative.
         """
-        assert zoom is None or zoom >= 0, "zoom must be greater than or equal to zero"
+        assert zoom is None or zoom >= 0, (
+            f"zoom must be greater than or equal to zero, got {zoom}"
+        )
         await self._invoke_method_async(
             method_name="move_to",
             arguments={
@@ -452,25 +482,29 @@ class Map(ft.ConstrainedControl):
 
         Args:
             destination: The destination point to move to.
-            zoom: The zoom level to be applied. If provided, must be greater than or equal to `0.0`.
+            zoom: The zoom level to be applied. If provided,
+                must be greater than or equal to `0.0`.
             rotation: Rotation (in degrees) to be applied.
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
             offset: The offset to be used. Only works when `rotation` is `None`.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
 
         Raises:
             AssertionError: If `zoom` is not `None` and is negative.
         """
         asyncio.create_task(
             self.move_to_async(
-                destination,
-                zoom,
-                rotation,
-                animation_curve,
-                animation_duration,
-                offset,
-                cancel_ongoing_animations,
+                destination=destination,
+                zoom=zoom,
+                rotation=rotation,
+                animation_curve=animation_curve,
+                animation_duration=animation_duration,
+                offset=offset,
+                cancel_ongoing_animations=cancel_ongoing_animations,
             )
         )
 
@@ -488,9 +522,12 @@ class Map(ft.ConstrainedControl):
         Args:
             point: The point on which to center the map.
             zoom: The zoom level to be applied.
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         await self._invoke_method_async(
             method_name="center_on",
@@ -517,16 +554,19 @@ class Map(ft.ConstrainedControl):
         Args:
             point: The point on which to center the map.
             zoom: The zoom level to be applied.
-            animation_curve: The curve of the animation. If None (the default), `Map.animation_curve` will be used.
-            animation_duration: The duration of the animation. If None (the default), `Map.animation_duration` will be used.
-            cancel_ongoing_animations: Whether to cancel/stop all ongoing map-animations before starting this new one.
+            animation_curve: The curve of the animation. If None (the default),
+                [`Map.animation_curve`][(p).] will be used.
+            animation_duration: The duration of the animation.
+                If None (the default), [`Map.animation_duration`][(p).] will be used.
+            cancel_ongoing_animations: Whether to cancel/stop all
+                ongoing map-animations before starting this new one.
         """
         asyncio.create_task(
             self.center_on_async(
-                point,
-                zoom,
-                animation_curve,
-                animation_duration,
-                cancel_ongoing_animations,
+                point=point,
+                zoom=zoom,
+                animation_curve=animation_curve,
+                animation_duration=animation_duration,
+                cancel_ongoing_animations=cancel_ongoing_animations,
             )
         )