flet-map 0.83.1__tar.gz → 0.84.0.dev0__tar.gz

{flet_map-0.83.1/src/flet_map.egg-info → flet_map-0.84.0.dev0}/PKG-INFO

@@ -1,17 +1,17 @@
 Metadata-Version: 2.4
 Name: flet-map
-Version: 0.83.1
+Version: 0.84.0.dev0
 Summary: Interactive map controls for Flet apps.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0
 Project-URL: Homepage, https://flet.dev
-Project-URL: Documentation, https://docs.flet.dev/map
+Project-URL: Documentation, https://flet.dev/docs/controls/map
 Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-map
 Project-URL: Issues, https://github.com/flet-dev/flet/issues
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: flet==0.83.1
+Requires-Dist: flet==0.84.0.dev0
 Dynamic: license-file
 
 # flet-map
@@ -19,7 +19,7 @@ Dynamic: license-file
 [![pypi](https://img.shields.io/pypi/v/flet-map.svg)](https://pypi.python.org/pypi/flet-map)
 [![downloads](https://static.pepy.tech/badge/flet-map/month)](https://pepy.tech/project/flet-map)
 [![python](https://img.shields.io/badge/python-%3E%3D3.10-%2334D058)](https://pypi.org/project/flet-map)
-[![docstring coverage](https://docs.flet.dev/assets/badges/docs-coverage/flet-map.svg)](https://docs.flet.dev/assets/badges/docs-coverage/flet-map.svg)
+[![docstring coverage](https://flet.dev/docs/assets/badges/docs-coverage/flet-map.svg)](https://flet.dev/docs/assets/badges/docs-coverage/flet-map.svg)
 [![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-map/LICENSE)
 
 A [Flet](https://flet.dev) extension for displaying interactive maps.
@@ -28,7 +28,7 @@ It is based on the [flutter_map](https://pub.dev/packages/flutter_map) Flutter p
 
 ## Documentation
 
-Detailed documentation to this package can be found [here](https://docs.flet.dev/map/).
+Detailed documentation to this package can be found [here](https://flet.dev/docs/controls/map/).
 
 ## Platform Support
 

{flet_map-0.83.1 → flet_map-0.84.0.dev0}/README.md

@@ -3,7 +3,7 @@
 [![pypi](https://img.shields.io/pypi/v/flet-map.svg)](https://pypi.python.org/pypi/flet-map)
 [![downloads](https://static.pepy.tech/badge/flet-map/month)](https://pepy.tech/project/flet-map)
 [![python](https://img.shields.io/badge/python-%3E%3D3.10-%2334D058)](https://pypi.org/project/flet-map)
-[![docstring coverage](https://docs.flet.dev/assets/badges/docs-coverage/flet-map.svg)](https://docs.flet.dev/assets/badges/docs-coverage/flet-map.svg)
+[![docstring coverage](https://flet.dev/docs/assets/badges/docs-coverage/flet-map.svg)](https://flet.dev/docs/assets/badges/docs-coverage/flet-map.svg)
 [![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-map/LICENSE)
 
 A [Flet](https://flet.dev) extension for displaying interactive maps.
@@ -12,7 +12,7 @@ It is based on the [flutter_map](https://pub.dev/packages/flutter_map) Flutter p
 
 ## Documentation
 
-Detailed documentation to this package can be found [here](https://docs.flet.dev/map/).
+Detailed documentation to this package can be found [here](https://flet.dev/docs/controls/map/).
 
 ## Platform Support
 

{flet_map-0.83.1 → flet_map-0.84.0.dev0}/pyproject.toml

@@ -1,18 +1,18 @@
 [project]
 name = "flet-map"
-version = "0.83.1"
+version = "0.84.0.dev0"
 description = "Interactive map controls for Flet apps."
 readme = "README.md"
 authors = [{ name = "Flet contributors", email = "hello@flet.dev" }]
 license = "Apache-2.0"
 requires-python = ">=3.10"
 dependencies = [
-    "flet==0.83.1",
+    "flet==0.84.0.dev0",
 ]
 
 [project.urls]
 Homepage = "https://flet.dev"
-Documentation = "https://docs.flet.dev/map"
+Documentation = "https://flet.dev/docs/controls/map"
 Repository = "https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-map"
 Issues = "https://github.com/flet-dev/flet/issues"
 

{flet_map-0.83.1 → flet_map-0.84.0.dev0}/src/flet_map/circle_layer.py

@@ -11,7 +11,7 @@ __all__ = ["CircleLayer", "CircleMarker"]
 class CircleMarker(ft.Control):
     """
     A circular marker displayed on the Map at the specified
-    location through the [`CircleLayer`][(p).].
+    location through the :class:`~flet_map.CircleLayer`.
     """
 
     radius: ft.Number
@@ -28,7 +28,7 @@ class CircleMarker(ft.Control):
     The color of the circle border line.
 
     Tip:
-        [`border_stroke_width`][(c).] must be greater than
+        :attr:`border_stroke_width` must be greater than
         `0.0` in order for this color to be visible.
     """
 
@@ -42,7 +42,7 @@ class CircleMarker(ft.Control):
 
     use_radius_in_meter: bool = False
     """
-    Whether the [`radius`][(c).] should use the unit meters.
+    Whether the :attr:`radius` should use the unit meters.
     """
 
     def before_update(self):
@@ -57,8 +57,8 @@ class CircleMarker(ft.Control):
 @ft.control("CircleLayer")
 class CircleLayer(MapLayer):
     """
-    A layer to display [`CircleMarker`][(p).]s.
+    A layer to display :class:`~flet_map.CircleMarker`.
     """
 
     circles: list[CircleMarker]
-    """A list of [`CircleMarker`][(p).]s to display."""
+    """A list of :class:`~flet_map.CircleMarker` to display."""

{flet_map-0.83.1 → flet_map-0.84.0.dev0}/src/flet_map/map.py

@@ -64,7 +64,7 @@ class Map(ft.LayoutControl):
     """
     Whether to enable the built in keep-alive functionality.
 
-    If the map is within a complex layout, such as a [`ListView`][flet.],
+    If the map is within a complex layout, such as a :class:`~flet.ListView`,
     the map will reset to its initial position after it appears back into view.
     To ensure this doesn't happen, enable this flag to prevent it from rebuilding.
     """
@@ -84,9 +84,9 @@ class Map(ft.LayoutControl):
     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()`][(c).zoom_in],
-    [`rotate_from()`][(c).rotate_from],
-    [`move_to()`][(c).move_to] etc.
+    when calling instance methods like :meth:`zoom_in`,
+    :meth:`rotate_from`,
+    :meth:`move_to` etc.
     """
 
     animation_duration: ft.DurationValue = field(
@@ -94,15 +94,15 @@ class Map(ft.LayoutControl):
     )
     """
     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.
+    when calling instance methods like :meth:`zoom_in`,
+    :meth:`rotate_from`,
+    :meth:`move_to` etc.
     """
 
     initial_camera_fit: Optional[CameraFit] = None
     """
     Defines the visible bounds when the map is first loaded.
-    Takes precedence over [`initial_center`][(c).]/[`initial_zoom`][(c).].
+    Takes precedence over :attr:`initial_center`/:attr:`initial_zoom`.
     """
 
     on_init: Optional[ft.ControlEventHandler["Map"]] = None
@@ -168,9 +168,10 @@ class Map(ft.LayoutControl):
         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`][(p).] will be used.
+                :attr:`flet_map.Map.animation_curve` will be used.
             animation_duration: The duration of the animation.
-                If None (the default), [`Map.animation_duration`][(p).] will be used.
+                If None (the default), :attr:`flet_map.Map.animation_duration` will be \
+                used.
             cancel_ongoing_animations: Whether to cancel/stop all
                 ongoing map-animations before starting this new one.
         """
@@ -195,9 +196,10 @@ class Map(ft.LayoutControl):
 
         Args:
             animation_curve: The curve of the animation. If None (the default),
-                [`Map.animation_curve`][(p).] will be used.
+                :attr:`flet_map.Map.animation_curve` will be used.
             animation_duration: The duration of the animation.
-                If None (the default), [`Map.animation_duration`][(p).] will be used.
+                If None (the default), :attr:`flet_map.Map.animation_duration` will be \
+                used.
             cancel_ongoing_animations: Whether to cancel/stop all
                 ongoing map-animations before starting this new one.
         """
@@ -221,9 +223,10 @@ class Map(ft.LayoutControl):
 
         Args:
             animation_curve: The curve of the animation. If None (the default),
-                [`Map.animation_curve`][(p).] will be used.
+                :attr:`flet_map.Map.animation_curve` will be used.
             animation_duration: The duration of the animation.
-                If None (the default), [`Map.animation_duration`][(p).] will be used.
+                If None (the default), :attr:`flet_map.Map.animation_duration` will be \
+                used.
             cancel_ongoing_animations: Whether to cancel/stop all
                 ongoing map-animations before starting this new one.
         """
@@ -247,9 +250,10 @@ class Map(ft.LayoutControl):
 
         Args:
             animation_curve: The curve of the animation. If `None` (the default),
-                [`Map.animation_curve`][(p).] will be used.
+                :attr:`flet_map.Map.animation_curve` will be used.
             animation_duration: The duration of the animation.
-                If None (the default), [`Map.animation_duration`][(p).] will be used.
+                If None (the default), :attr:`flet_map.Map.animation_duration` will be \
+                used.
             cancel_ongoing_animations: Whether to cancel/stop all
                 ongoing map-animations before starting this new one.
         """
@@ -275,9 +279,10 @@ class Map(ft.LayoutControl):
         Args:
             zoom: The zoom level to zoom to.
             animation_curve: The curve of the animation. If `None` (the default),
-                [`Map.animation_curve`][(p).] will be used.
+                :attr:`flet_map.Map.animation_curve` will be used.
             animation_duration: The duration of the animation.
-                If None (the default), [`Map.animation_duration`][(p).] will be used.
+                If None (the default), :attr:`flet_map.Map.animation_duration` will be \
+                used.
             cancel_ongoing_animations: Whether to cancel/stop all
                 ongoing map-animations before starting this new one.
         """
@@ -311,9 +316,10 @@ class Map(ft.LayoutControl):
             rotation: Rotation (in degrees) to be applied.
             offset: The offset to be used. Only works when `rotation` is `None`.
             animation_curve: The curve of the animation. If None (the default),
-                [`Map.animation_curve`][(p).] will be used.
+                :attr:`flet_map.Map.animation_curve` will be used.
             animation_duration: The duration of the animation.
-                If None (the default), [`Map.animation_duration`][(p).] will be used.
+                If None (the default), :attr:`flet_map.Map.animation_duration` will be \
+                used.
             cancel_ongoing_animations: Whether to cancel/stop all
                 ongoing map-animations before starting this new one.
 
@@ -350,9 +356,10 @@ class Map(ft.LayoutControl):
             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`][(p).] will be used.
+                :attr:`flet_map.Map.animation_curve` will be used.
             animation_duration: The duration of the animation.
-                If None (the default), [`Map.animation_duration`][(p).] will be used.
+                If None (the default), :attr:`flet_map.Map.animation_duration` will be \
+                used.
             cancel_ongoing_animations: Whether to cancel/stop all
                 ongoing map-animations before starting this new one.
         """
@@ -372,7 +379,7 @@ class Map(ft.LayoutControl):
         Gets the current camera snapshot of the map.
 
         Returns:
-            Current [`Camera`][flet_map.] state.
+            Current :class:`~flet_map.Camera` state.
         """
         camera = await self._invoke_method("get_camera")
         return from_dict(Camera, camera)

flet_map-0.84.0.dev0/src/flet_map/map_layer.py

@@ -0,0 +1,20 @@
+import flet as ft
+
+__all__ = ["MapLayer"]
+
+
+@ft.control("MapLayer")
+class MapLayer(ft.Control):
+    """
+    Abstract class for all map layers.
+
+    The following layers are available:
+
+    - :class:`~flet_map.CircleLayer`
+    - :class:`~flet_map.MarkerLayer`
+    - :class:`~flet_map.PolygonLayer`
+    - :class:`~flet_map.PolylineLayer`
+    - :class:`~flet_map.RichAttribution`
+    - :class:`~flet_map.SimpleAttribution`
+    - :class:`~flet_map.TileLayer`
+    """

{flet_map-0.83.1 → flet_map-0.84.0.dev0}/src/flet_map/marker_layer.py

@@ -12,15 +12,15 @@ __all__ = ["Marker", "MarkerLayer"]
 class Marker(ft.Control):
     """
     A marker displayed on the Map at the specified location
-    through the [`MarkerLayer`][(p).].
+    through the :class:`~flet_map.MarkerLayer`.
     """
 
     content: ft.Control
     """
-    The content to be displayed at [`coordinates`][(c).].
+    The content to be displayed at :attr:`coordinates`.
 
     Raises:
-        ValueError: If it is not [`visible`][flet.Control.visible].
+        ValueError: If it is not :attr:`~flet.Control.visible`.
     """
 
     coordinates: MapLatitudeLongitude
@@ -28,7 +28,7 @@ class Marker(ft.Control):
     The coordinates of the marker.
 
     This will be the center of the marker,
-    if [`alignment`][(c).] is [`Alignment.CENTER`][flet.].
+    if :attr:`alignment` is :attr:`flet.Alignment.CENTER`.
     """
 
     rotate: Optional[bool] = None
@@ -38,7 +38,7 @@ class Marker(ft.Control):
     So, when `True`, this marker will always appear upright and
     vertical from the user's perspective.
 
-    If `None`, defaults to the value of the parent [`MarkerLayer.rotate`][(p).].
+    If `None`, defaults to the value of the parent :attr:`flet_map.MarkerLayer.rotate`.
 
     Note:
         This is not used to apply a custom rotation in degrees to this marker.
@@ -47,7 +47,7 @@ class Marker(ft.Control):
 
     height: ft.Number = 30.0
     """
-    The height of the [`content`][(c).] Control.
+    The height of the :attr:`content` Control.
 
     Raises:
         ValueError: If it is less than `0.0`.
@@ -55,7 +55,7 @@ class Marker(ft.Control):
 
     width: ft.Number = 30.0
     """
-    The width of the [`content`][(c).] Control.
+    The width of the :attr:`content` Control.
 
     Raises:
         ValueError: If it is less than `0.0`.
@@ -63,9 +63,9 @@ class Marker(ft.Control):
 
     alignment: Optional[ft.Alignment] = None
     """
-    Alignment of the marker relative to the normal center at [`coordinates`][(c).].
+    Alignment of the marker relative to the normal center at :attr:`coordinates`.
 
-    Defaults to the value of the parent [`MarkerLayer.alignment`][(p).].
+    Defaults to the value of the parent :attr:`flet_map.MarkerLayer.alignment`.
     """
 
     def before_update(self):
@@ -90,7 +90,7 @@ class MarkerLayer(MapLayer):
 
     markers: list[Marker]
     """
-    A list of [`Marker`][(p).]s to display.
+    A list of :class:`~flet_map.Marker`s to display.
     """
 
     alignment: Optional[ft.Alignment] = field(
@@ -98,11 +98,11 @@ class MarkerLayer(MapLayer):
     )
     """
     The alignment of each marker relative to its normal center at
-    [`Marker.coordinates`][(p).].
+    :attr:`flet_map.Marker.coordinates`.
     """
 
     rotate: bool = False
     """
-    Whether to counter-rotate [`markers`][(c).] to the map's rotation,
+    Whether to counter-rotate :attr:`markers` to the map's rotation,
     to keep a fixed orientation.
     """

{flet_map-0.83.1 → flet_map-0.84.0.dev0}/src/flet_map/polygon_layer.py

@@ -10,7 +10,7 @@ __all__ = ["PolygonLayer", "PolygonMarker"]
 @ft.control("PolygonMarker")
 class PolygonMarker(ft.Control):
     """
-    A marker for the [`PolygonLayer`][(p).].
+    A marker for the :class:`~flet_map.PolygonLayer`.
     """
 
     coordinates: list[MapLatitudeLongitude]
@@ -26,7 +26,8 @@ class PolygonMarker(ft.Control):
         Specifying a label will reduce performance, as the internal
         canvas must be drawn to and 'saved' more frequently to ensure the proper
         stacking order is maintained. This can be avoided, potentially at the
-        expense of appearance, by setting [`PolygonLayer.draw_labels_last`][(p).].
+        expense of appearance, by setting \
+        :attr:`flet_map.PolygonLayer.draw_labels_last`.
     """
 
     label_text_style: Optional[ft.TextStyle] = None
@@ -90,7 +91,7 @@ class PolygonLayer(MapLayer):
 
     polygons: list[PolygonMarker]
     """
-    A list of [`PolygonMarker`][(p).]s to display.
+    A list of :class:`~flet_map.PolygonMarker`s to display.
     """
 
     polygon_culling: bool = True

{flet_map-0.83.1 → flet_map-0.84.0.dev0}/src/flet_map/polyline_layer.py

@@ -11,7 +11,7 @@ __all__ = ["PolylineLayer", "PolylineMarker"]
 @ft.control("PolylineMarker")
 class PolylineMarker(ft.Control):
     """
-    A marker for the [`PolylineLayer`][(p).].
+    A marker for the :class:`~flet_map.PolylineLayer`.
     """
 
     coordinates: list[MapLatitudeLongitude]
@@ -21,7 +21,7 @@ class PolylineMarker(ft.Control):
 
     colors_stop: Optional[list[ft.Number]] = None
     """
-    The stops for the [`gradient_colors`][(c).].
+    The stops for the :attr:`gradient_colors`.
     """
 
     gradient_colors: Optional[list[ft.ColorValue]] = None
@@ -93,12 +93,12 @@ class PolylineMarker(ft.Control):
 @ft.control("PolylineLayer")
 class PolylineLayer(MapLayer):
     """
-    A layer to display [`PolylineMarker`][(p).]s.
+    A layer to display :class:`~flet_map.PolylineMarker`s.
     """
 
     polylines: list[PolylineMarker]
     """
-    List of [`PolylineMarker`][(p).]s to be drawn.
+    List of :class:`~flet_map.PolylineMarker`s to be drawn.
     """
 
     culling_margin: ft.Number = 10.0

{flet_map-0.83.1 → flet_map-0.84.0.dev0}/src/flet_map/rich_attribution.py

@@ -20,8 +20,8 @@ class RichAttribution(MapLayer):
     """
     List of attributions to display.
 
-    [`TextSourceAttribution`][(p).]s are shown in a popup box,
-    unlike [`ImageSourceAttribution`][(p).], which are visible permanently.
+    :class:`~flet_map.TextSourceAttribution`s are shown in a popup box,
+    unlike :class:`~flet_map.ImageSourceAttribution`, which are visible permanently.
     """
 
     alignment: Optional[AttributionAlignment] = None
@@ -48,7 +48,7 @@ class RichAttribution(MapLayer):
 
     This is useful with certain sources/tile servers that make immediate
     attribution mandatory and are not attributed with a permanently
-    visible [`ImageSourceAttribution`][(p).].
+    visible :class:`~flet_map.ImageSourceAttribution`.
     """
 
     permanent_height: ft.Number = 24.0

{flet_map-0.83.1 → flet_map-0.84.0.dev0}/src/flet_map/simple_attribution.py

@@ -25,7 +25,7 @@ class SimpleAttribution(MapLayer):
 
     bgcolor: ft.ColorValue = ft.Colors.SURFACE
     """
-    The color of the box containing the [`text`][(c).].
+    The color of the box containing the :attr:`text`.
     """
 
     on_click: Optional[ft.ControlEventHandler["SimpleAttribution"]] = None

{flet_map-0.83.1 → flet_map-0.84.0.dev0}/src/flet_map/source_attribution.py

@@ -11,8 +11,8 @@ class SourceAttribution(ft.BaseControl):
     """
     Abstract class for source attribution controls:
 
-    - [`ImageSourceAttribution`][(p).]
-    - [`TextSourceAttribution`][(p).]
+    - :class:`~flet_map.ImageSourceAttribution`
+    - :class:`~flet_map.TextSourceAttribution`
     """
 
 
@@ -20,14 +20,14 @@ class SourceAttribution(ft.BaseControl):
 class ImageSourceAttribution(SourceAttribution):
     """
     An image attribution permanently displayed adjacent to the
-    open/close icon of a [`RichAttribution`][(p).] control.
+    open/close icon of a :class:`~flet_map.RichAttribution` control.
     For it to be displayed, it should be part of a
-    [`RichAttribution.attributions`][(p).] list.
+    :attr:`flet_map.RichAttribution.attributions` list.
     """
 
     image: ft.Image
     """
-    The [`Image`][flet.] to be displayed.
+    The :class:`~flet.Image` to be displayed.
 
     Raises:
         ValueError: If the image is not visible.
@@ -36,7 +36,7 @@ class ImageSourceAttribution(SourceAttribution):
     height: ft.Number = 24.0
     """
     The height of the image.
-    Should be the same as [`RichAttribution.permanent_height`][(p).],
+    Should be the same as :attr:`flet_map.RichAttribution.permanent_height`,
     otherwise layout issues may occur.
     """
 
@@ -57,18 +57,18 @@ class TextSourceAttribution(SourceAttribution):
     """
     A text source attribution displayed on the Map.
     For it to be displayed, it should be part of a
-    [`RichAttribution.attributions`][(p).] list.
+    :attr:`flet_map.RichAttribution.attributions` list.
     """
 
     text: str
-    """The text to display as attribution, styled with [`text_style`][(c).]."""
+    """The text to display as attribution, styled with :attr:`text_style`."""
 
     text_style: Optional[ft.TextStyle] = None
-    """Style used to display the [`text`][(c).]."""
+    """Style used to display the :attr:`text`."""
 
     prepend_copyright: bool = True
     """
-    Whether to add the '©' character to the start of [`text`][(c).] automatically.
+    Whether to add the '©' character to the start of :attr:`text` automatically.
     """
 
     on_click: Optional[ft.ControlEventHandler["TextSourceAttribution"]] = None