QuasarCode 0.32.16__tar.gz → 0.33.0__tar.gz

{quasarcode-0.32.16 → quasarcode-0.33.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: QuasarCode
-Version: 0.32.16
+Version: 0.33.0
 Summary: A general purpose library for Python applications.
 Project-URL: Documentation, https://github.com/QuasarX1/QuasarCode/blob/master/README.md
 Project-URL: Issues, https://github.com/QuasarX1/QuasarCode/issues

{quasarcode-0.32.16 → quasarcode-0.33.0}/src/QuasarCode/Plotting/_CachedFigureGrid.py

@@ -469,6 +469,28 @@ class CachedFigureGrid(CacheableStruct):
             self.colourbars.pop(name)
         except KeyError: pass
 
+    def add_legend(self, name: str) -> None:
+        self.custom_legends[name] = CachedPlotCustomLegend()
+
+    def add_to_legend(self, plot_name: str, element_name: str, label: Optional[str] = None, legend_name: Optional[str] = None) -> None:
+        if legend_name is None:
+            if len(self.custom_legends) > 1:
+                raise KeyError("Unable to assume legend name where multiple legends are specified.")
+            if len(self.custom_legends) == 0:
+                legend_name = "legend"
+                self.add_legend(legend_name)
+            else:
+                legend_name = list(self.custom_legends.keys())[0]
+        if label is None:
+            element = self.plots[plot_name].plot_elements[element_name]
+            try:
+                label = element.label
+                if element.label is None:
+                    raise KeyError()
+            except:
+                raise KeyError("Element has no assigned label.")
+        self.custom_legends[legend_name].add_element(label, (plot_name, element_name))
+
     def get_axis_rect_relative(self, name: str) -> Rect:
         """
         Get a Rect instance containing the relative position and size of a named axis.

{quasarcode-0.32.16 → quasarcode-0.33.0}/src/QuasarCode/Plotting/_CachedPlot.py

@@ -136,6 +136,30 @@ class CachedPlot(CacheableStruct):
             raise KeyError(f"No element exists with the target name \"{colourbar.target_element}\".")
         self.colourbars[name] = colourbar
 
+    def add_legend(self, name: str, *element_names: str) -> None:
+        self.custom_legends[name] = CachedPlotCustomLegend()
+        for element_name in element_names:
+            self.add_to_legend(element_name, legend_name = name)
+
+    def add_to_legend(self, element_name: str, label: Optional[str] = None, legend_name: Optional[str] = None) -> None:
+        if legend_name is None:
+            if len(self.custom_legends) > 1:
+                raise KeyError("Unable to assume legend name where multiple legends are specified.")
+            if len(self.custom_legends) == 0:
+                legend_name = "legend"
+                self.add_legend(legend_name)
+            else:
+                legend_name = list(self.custom_legends.keys())[0]
+        if label is None:
+            element = self.plot_elements[element_name]
+            try:
+                label = element.label
+                if element.label is None:
+                    raise KeyError()
+            except:
+                raise KeyError("Element has no assigned label.")
+        self.custom_legends[legend_name].add_element(label, element_name)
+
     def render(self, figure: Figure, axis: Axes, figure_default_font: Optional[CachedPlotFontInfo] = None, forward_kwargs: dict[str, dict[str, Any]]|None = None, forward_colourbar_kwargs: dict[str, dict[str, Any]]|None = None) -> None:
         if forward_kwargs is None:
             forward_kwargs = {}
@@ -263,7 +287,7 @@ class CachedPlot(CacheableStruct):
                 functions = tuple(self.alt_y_axis_functions)
             )
             if self.alt_y_axis_label is not None:
-                self._alt_y_axis.set_xlabel(self.alt_y_axis_label, **self.alt_y_axis_label_font.with_default(self.y_axis_label_font).with_default(self.default_font).with_default(figure_default_font).fontdict)
+                self._alt_y_axis.set_ylabel(self.alt_y_axis_label, **self.alt_y_axis_label_font.with_default(self.y_axis_label_font).with_default(self.default_font).with_default(figure_default_font).fontdict)
             if self.alt_y_tick_locations is not None:
                 self._alt_y_axis.yaxis.set_major_locator(FixedLocator(self.alt_y_tick_locations))
             if self.alt_y_tick_format is not None:

{quasarcode-0.32.16 → quasarcode-0.33.0}/src/QuasarCode/Plotting/_CachedPlotCustomLegend.py

@@ -29,6 +29,7 @@ class CachedPlotLegendBoxProperties(CacheableStruct):
 class CachedPlotCustomLegend(CacheableStruct):
     title                           = AutoProperty            [str                          ](allow_uninitialised = True)
     element_targets                 = AutoProperty_NonNullable[dict[str,str|tuple[str,str]] ]() # Label : target element | (target plot, target element)
+    order                           = AutoProperty            [list[str]                    ]() # List of labels
     reverse_order                   = AutoProperty_NonNullable[bool                         ](default_value = False)
     columns                         = AutoProperty_NonNullable[int                          ](default_value = 1)
     position                        = AutoProperty_NonNullable[Literal["best", "upper left", "upper center", "upper right", "center left", "center", "center right", "lower left", "lower center", "lower right"]|tuple[float, float]](default_value = "best")
@@ -58,7 +59,7 @@ class CachedPlotCustomLegend(CacheableStruct):
     def __init__(self, **kwargs):
         super().__init__(
             cacheable_attributes = [
-                "title", "element_targets", "reverse_order", "columns", "position",
+                "title", "element_targets", "order", "reverse_order", "columns", "position",
                 "anchor_region", "anchor", "anchor_space", "label_font", "label_colours",
                 "title_font", "alignment", "line_render_points", "scatter_render_points",
                 "scatter_render_points_y_offsets", "marker_scale", "marker_location",
@@ -76,22 +77,31 @@ class CachedPlotCustomLegend(CacheableStruct):
         if "box" not in kwargs:
             self.box = CachedPlotLegendBoxProperties()
 
+    def add_element(self, label: str, target: str|tuple[str,str]) -> None:
+        if self.order is None:
+            self.order = list(self.element_targets.keys())
+        self.element_targets[label] = target
+        self.order.append(label)
+
     def render(self, figure: Figure, axis: Axes|None, default_font: CachedPlotFontInfo, plot_elements: Optional[dict[str, CachedPlotElement]] = None, elements_by_figure_plot: Optional[dict[str, dict[str, CachedPlotElement]]] = None, *args: Any, **kwargs: Any) -> None:
 
         if plot_elements is None and elements_by_figure_plot is None:
             raise ValueError("At least one of plot_elements or elements_by_figure_plot must be provided to render a CachedPlotCustomLegend.")
-        
+
         if self.anchor is None and self.anchor_region is not None:
             raise ValueError("Only one of anchor or anchor_region may be set.")
-        
+
         if self.anchor_space is not None and self.anchor_space != "figure-space" and axis is None:
             raise ValueError("anchor_space cannot be set to a value other than 'figure-space' if axis is not provided.")
-        
+
         anchor_transform = None if self.anchor_space is None else figure.transFigure if self.anchor_space == "figure-space" else axis.transAxes if self.anchor_space == "axis-space" else axis.transData
 
+        target_labels_in_order = self.order if self.order is not None else list(self.element_targets.keys())
+
         artists = []
         labels = []
-        for label, target in self.element_targets.items():
+        for label in target_labels_in_order:
+            target = self.element_targets[label]
             target_plot: str|None
             target_element: str
             artist: Artist
@@ -146,4 +156,4 @@ class CachedPlotCustomLegend(CacheableStruct):
             columnspacing        = self.horizontal_spacing,
 #            handler_map          =,
             draggable            =self.mouse_draggable,
-        )
+        )

quasarcode-0.33.0/src/QuasarCode/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.33.0"

quasarcode-0.32.16/src/QuasarCode/__about__.py

@@ -1 +0,0 @@
-__version__ = "0.32.16"