QuasarCode 0.30.1__tar.gz → 0.30.3__tar.gz

{quasarcode-0.30.1 → quasarcode-0.30.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: QuasarCode
-Version: 0.30.1
+Version: 0.30.3
 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.30.1 → quasarcode-0.30.3}/src/QuasarCode/Plotting/_CachedFigureGrid.py

@@ -87,6 +87,7 @@ class CachedFigureGrid(CacheableStruct):
             self.columns = max(len(row) for row in self.mosaic)
 
         self.plots = {}
+        self.colourbars = {}
         
     def set_resolution_custom(self, width_pixels: int|None = None, height_pixels: int|None = None, file_only: bool = False) -> None:
         """
@@ -439,6 +440,17 @@ class CachedFigureGrid(CacheableStruct):
         except KeyError: pass
 
     def set_colourbar(self, name: str, colourbar: CachedPlotColourbar, target_plot: str, target_element: str) -> None:
+        """
+        Link an axis name in the figure layout with a CachedPlotColourbar instance for easy rendering.
+        Note: this circumvents the need to create a separate CachedPlot instance to host the colourbar.
+        Adding colourbars into the layout mosaic is recommended as this allows greater control over the sizes of individual plots.
+
+        Parameters:
+            str name:
+                Name of the axis to link.
+            CachedPlotColourbar colourbar:
+                CachedPlotColourbar instance to insert.
+        """
         if name in self.colourbars:
             raise KeyError(f"A colourbar already exists with the name \"{name}\".")
         if not any([name in row for row in self.mosaic]):

{quasarcode-0.30.1 → quasarcode-0.30.3}/src/QuasarCode/Plotting/_CachedPlotElements.py

@@ -227,8 +227,8 @@ class CachedPlotColourbar(CachedPlotElement[Colorbar]):
         """
         self._result = figure.colorbar(
             target,
-            ax = axis if not self.add_to_axis else None,
-            cax = axis if self.add_to_axis else None,
+            ax = axis if self.add_to_axis else None,
+            cax = axis if not self.add_to_axis else None,
             location = self.location if not self.add_to_axis else None,
             label = self.label,
             extend = self.extend,

quasarcode-0.30.3/src/QuasarCode/__about__.py

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

quasarcode-0.30.1/src/QuasarCode/__about__.py

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