legends, part 1 (#406)

kushalkolar · web-flow · commit 8919d7c09d9b · 2024-02-28T23:29:23.000-05:00
* start legends, not functional yet * add faq (#400) * fix bug when remove_graphic() is used (#405) * add 'Deleted' as a graphic feature (#404) * very basic adding line legends works * use OrderedDict for legend items * allow accessing legend items via Graphic, updating colors works * legend mesh resizes properly * remove legend items and reorder works * enforce all legend labels to be unique * add legends property to PlotArea * checks for Graphic name * highlight linegraphic when legend item is clicked * legend is moveable * remove weird characters that were committed for some reason * progress on legend grid placement, not yet working * max_rows works for legend * just allow max_rows kwarg for legends, no cols * line that snuck in from another branch * small changes
diff --git a/fastplotlib/__init__.py b/fastplotlib/__init__.py
@@ -3,7 +3,7 @@
 from .layouts import Plot, GridPlot
 from .graphics import *
 from .graphics.selectors import *
-from .utils import _notebook_print_banner, config
+from .legends import *
 
 from wgpu.gui.auto import run
 
@@ -23,14 +23,13 @@
         "No WGPU adapters found, fastplotlib will not work."
     )
 
-_notebook_print_banner()
-
 with open(Path(__file__).parent.joinpath("VERSION"), "r") as f:
     __version__ = f.read().split("\n")[0]
 
 __all__ = [
     "Plot",
     "GridPlot",
     "run",
-    "ImageWidget"
+    "ImageWidget",
+    "Legend",
 ]
diff --git a/fastplotlib/graphics/_base.py b/fastplotlib/graphics/_base.py
@@ -48,6 +48,7 @@ class Graphic(BaseGraphic):
     feature_events = {}
 
     def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
         # all graphics give off a feature event when deleted
         cls.feature_events = {*cls.feature_events, "deleted"}
 
@@ -62,14 +63,16 @@ def __init__(
         Parameters
         ----------
         name: str, optional
-            name this graphic, makes it indexable within plots
+            name this graphic to use it as a key to access from the plot
 
         metadata: Any, optional
             metadata attached to this Graphic, this is for the user to manage
 
         """
+        if (name is not None) and (not isinstance(name, str)):
+            raise TypeError("Graphic `name` must be of type <str>")
 
-        self.name = name
+        self._name = name
         self.metadata = metadata
         self.collection_index = collection_index
         self.registered_callbacks = dict()
@@ -80,6 +83,20 @@ def __init__(
 
         self.deleted = Deleted(self, False)
 
+        self._plot_area = None
+
+    @property
+    def name(self) -> Union[str, None]:
+        """str name reference for this item"""
+        return self._name
+
+    @name.setter
+    def name(self, name: str):
+        if not isinstance(name, str):
+            raise TypeError("`Graphic` name must be of type <str>")
+        if self._plot_area is not None:
+            self._plot_area._check_graphic_name_exists(name)
+
     @property
     def world_object(self) -> WorldObject:
         """Associated pygfx WorldObject. Always returns a proxy, real object cannot be accessed directly."""
diff --git a/fastplotlib/layouts/_plot_area.py b/fastplotlib/layouts/_plot_area.py
@@ -12,6 +12,7 @@
 from ._utils import create_camera, create_controller
 from ..graphics._base import Graphic
 from ..graphics.selectors._base_selector import BaseSelector
+from ..legends import Legend
 
 # dict to store Graphic instances
 # this is the only place where the real references to Graphics are stored in a Python session
@@ -62,7 +63,7 @@ def __init__(
 
         name: str, optional
             name this ``subplot`` or ``plot``
-
+            
         """
 
         self._parent: PlotArea = parent
@@ -208,6 +209,8 @@ def graphics(self) -> Tuple[Graphic, ...]:
         proxies = list()
         for loc in self._graphics:
             p = weakref.proxy(GRAPHICS[loc])
+            if p.__class__.__name__ == "Legend":
+                continue
             proxies.append(p)
 
         return tuple(proxies)
@@ -222,6 +225,17 @@ def selectors(self) -> Tuple[BaseSelector, ...]:
 
         return tuple(proxies)
 
+    @property
+    def legends(self) -> Tuple[Legend, ...]:
+        """Legends in the plot area."""
+        proxies = list()
+        for loc in self._graphics:
+            p = weakref.proxy(GRAPHICS[loc])
+            if p.__class__.__name__ == "Legend":
+                proxies.append(p)
+
+        return tuple(proxies)
+
     @property
     def name(self) -> Any:
         """The name of this plot area"""
@@ -486,6 +500,9 @@ def _check_graphic_name_exists(self, name):
         for s in self.selectors:
             graphic_names.append(s.name)
 
+        for l in self.legends:
+            graphic_names.append(l.name)
+
         if name in graphic_names:
             raise ValueError(
                 f"graphics must have unique names, current graphic names are:\n {graphic_names}"
@@ -666,6 +683,10 @@ def __getitem__(self, name: str):
             if selector.name == name:
                 return selector
 
+        for legend in self.legends:
+            if legend.name == name:
+                return legend
+
         graphic_names = list()
         for g in self.graphics:
             graphic_names.append(g.name)
@@ -681,7 +702,7 @@ def __getitem__(self, name: str):
         )
 
     def __contains__(self, item: Union[str, Graphic]):
-        to_check = [*self.graphics, *self.selectors]
+        to_check = [*self.graphics, *self.selectors, *self.legends]
 
         if isinstance(item, Graphic):
             if item in to_check:
diff --git a/fastplotlib/legends/__init__.py b/fastplotlib/legends/__init__.py
@@ -0,0 +1,3 @@
+from .legend import Legend
+
+__all__ = ["Legend"]
diff --git a/fastplotlib/legends/legend.py b/fastplotlib/legends/legend.py
diff --git a/fastplotlib/utils/mesh_masks.py b/fastplotlib/utils/mesh_masks.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from .legend import Legend`
	`2`	`+`
	`3`	`+__all__ = ["Legend"]`