Ecoscope fork merge

lonboard/__init__.py

@@ -19,3 +19,14 @@
 from ._map import Map
 from ._version import __version__
 from ._viz import viz
+from ._deck_widget import (
+    BaseDeckWidget,
+    FullscreenWidget,
+    ZoomWidget,
+    CompassWidget,
+    TitleWidget,
+    NorthArrowWidget,
+    LegendWidget,
+    ScaleWidget,
+    SaveImageWidget,
+)

lonboard/_deck_widget.py

@@ -0,0 +1,96 @@
+import traitlets
+from lonboard._base import BaseWidget
+
+class BaseDeckWidget(BaseWidget):
+
+    # props = traitlets.Dict({}).tag(sync=True) # make me a class
+    placement = traitlets.Enum(
+        values=["top-left", "top-right", "bottom-left", "bottom-right", "fill"],
+        default_value=None, 
+        allow_none=True
+    ).tag(sync=True)
+    class_name = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+class FullscreenWidget(BaseDeckWidget):
+    _widget_type = traitlets.Unicode("fullscreen").tag(sync=True)
+
+    enter_label = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+    exit_label = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+    style = traitlets.Dict(default_value=None, allow_none=True).tag(sync=True)
+    class_name = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+class ZoomWidget(BaseDeckWidget):
+    _widget_type = traitlets.Unicode("zoom").tag(sync=True)
+
+    zoom_in_label = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+    zoom_out_label = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+    transition_duration = traitlets.Int(default_value=None, allow_none=True).tag(sync=True)
+    style = traitlets.Dict(default_value=None, allow_none=True).tag(sync=True)
+    class_name = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+class CompassWidget(BaseDeckWidget):
+    _widget_type = traitlets.Unicode("compass").tag(sync=True)
+
+    label = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+    transition_duration = traitlets.Int(default_value=None, allow_none=True).tag(sync=True)
+    style = traitlets.Dict(default_value=None, allow_none=True).tag(sync=True)
+    class_name = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+class NorthArrowWidget(BaseDeckWidget):
+    _widget_type = traitlets.Unicode("north-arrow").tag(sync=True)
+
+    label = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+    transition_duration = traitlets.Int(default_value=None, allow_none=True).tag(sync=True)
+    style = traitlets.Dict(default_value=None, allow_none=True).tag(sync=True)
+    class_name = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+class TitleWidget(BaseDeckWidget):
+
+    _widget_type = traitlets.Unicode("title").tag(sync=True)
+    title = traitlets.Unicode(allow_none=False).tag(sync=True)
+    style = traitlets.Dict(default_value=None, allow_none=True).tag(sync=True)
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+class LegendWidget(BaseDeckWidget):
+
+    _widget_type = traitlets.Unicode("legend").tag(sync=True)
+    title = traitlets.Unicode(default_value=None, allow_none=True).tag(sync=True)
+    labels = traitlets.List(traitlets.Unicode()).tag(sync=True)
+    colors = traitlets.List(traitlets.Unicode()).tag(sync=True)
+    style = traitlets.Dict(default_value=None, allow_none=True).tag(sync=True)
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+class ScaleWidget(BaseDeckWidget):
+
+    _widget_type = traitlets.Unicode("scale").tag(sync=True)
+    style = traitlets.Dict(default_value=None, allow_none=True).tag(sync=True)
+    max_width = traitlets.Int(default_value=None, allow_none=True).tag(sync=True)
+    use_imperial = traitlets.Bool(default_value=None, allow_none=True).tag(sync=True)
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+class SaveImageWidget(BaseDeckWidget):
+
+    _widget_type = traitlets.Unicode("save-image").tag(sync=True)
+    style = traitlets.Dict(default_value=None, allow_none=True).tag(sync=True)
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)

lonboard/_map.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import sys
+from math import log2
 from io import StringIO
 from pathlib import Path
 from typing import IO, TYPE_CHECKING, Optional, Sequence, TextIO, Union, overload
@@ -12,6 +13,7 @@
 from lonboard._base import BaseAnyWidget
 from lonboard._environment import DEFAULT_HEIGHT
 from lonboard._layer import BaseLayer
+from lonboard._deck_widget import BaseDeckWidget
 from lonboard._viewport import compute_view
 from lonboard.basemap import CartoBasemap
 from lonboard.traits import DEFAULT_INITIAL_VIEW_STATE, BasemapUrl, ViewStateTrait
@@ -123,11 +125,20 @@ def __init__(
 
     """
 
-    _height = traitlets.Int(default_value=DEFAULT_HEIGHT, allow_none=True).tag(
-        sync=True
-    )
+    height = traitlets.Union(
+        [traitlets.Int(),traitlets.Unicode()],
+        default_value=DEFAULT_HEIGHT, allow_none=True
+    ).tag(sync=True)
     """Height of the map in pixels.
 
+    This API is not yet stabilized and may change in the future.
+    """
+    width = traitlets.Union(
+        [traitlets.Int(),traitlets.Unicode()],
+        default_value=DEFAULT_HEIGHT, allow_none=True
+    ).tag(sync=True)
+    """Width of the map in pixels.
+
     This API is not yet stabilized and may change in the future.
     """
 
@@ -156,7 +167,17 @@ def __init__(
     - Default: `5`
     """
 
-    basemap_style = BasemapUrl(CartoBasemap.PositronNoLabels)
+    deck_widgets = traitlets.List(trait=traitlets.Instance(BaseDeckWidget)).tag(
+        sync=True, **ipywidgets.widget_serialization
+    )
+    """One or more `Widget` objects to display on this map.
+    """
+
+    controller = traitlets.Bool(default_value=True).tag(sync=True)
+    """Whether or not the map is interactive
+    """
+
+    basemap_style = traitlets.Unicode(CartoBasemap.PositronNoLabels).tag(sync=True)
     """
     A URL to a MapLibre-compatible basemap style.
 

lonboard/_viz.py

@@ -220,6 +220,48 @@ def viz(
 
     return Map(layers=layers, **map_kwargs)
 
+def viz_layer(
+    data: Union[VizDataInput, List[VizDataInput], Tuple[VizDataInput, ...]],
+    *,
+    scatterplot_kwargs: Optional[ScatterplotLayerKwargs] = None,
+    path_kwargs: Optional[PathLayerKwargs] = None,
+    polygon_kwargs: Optional[PolygonLayerKwargs] = None,
+    map_kwargs: Optional[MapKwargs] = None,
+    con: Optional[duckdb.DuckDBPyConnection] = None,
+) -> List[Union[ScatterplotLayer, PathLayer, PolygonLayer]]:
+    """Same as viz but returns only the created layers
+    """
+    color_ordering = COLORS.copy()
+    shuffle(color_ordering)
+
+    if isinstance(data, (list, tuple)):
+        layers: List[Union[ScatterplotLayer, PathLayer, PolygonLayer]] = []
+        for i, item in enumerate(data):
+            ls = create_layers_from_data_input(
+                item,
+                _viz_color=color_ordering[i % len(color_ordering)],
+                scatterplot_kwargs=scatterplot_kwargs,
+                path_kwargs=path_kwargs,
+                polygon_kwargs=polygon_kwargs,
+                con=con,
+            )
+            layers.extend(ls)
+    else:
+        layers = create_layers_from_data_input(
+            data,
+            _viz_color=color_ordering[0],
+            scatterplot_kwargs=scatterplot_kwargs,
+            path_kwargs=path_kwargs,
+            polygon_kwargs=polygon_kwargs,
+            con=con,
+        )
+
+    map_kwargs = {} if not map_kwargs else map_kwargs
+
+    if "basemap_style" not in map_kwargs.keys():
+        map_kwargs["basemap_style"] = CartoBasemap.DarkMatter
+
+    return layers
 
 DUCKDB_PY_CONN_ERROR = dedent("""\
     Must pass in DuckDBPyRelation object, not DuckDBPyConnection.