maidr 0.14.0__tar.gz → 0.16.0__tar.gz

{maidr-0.14.0 → maidr-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: maidr
-Version: 0.14.0
+Version: 0.16.0
 Summary: Multimodal Access and Interactive Data Representations
 License: GPL-3.0-or-later
 Keywords: accessibility,visualization,sonification,braille,tactile,multimodal,data representation,blind,low vision,visual impairments

{maidr-0.14.0 → maidr-0.16.0}/maidr/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.14.0"
+__version__ = "0.16.0"
 
 from .api import close, render, save_html, set_engine, show, stacked
 from .core import Maidr

{maidr-0.14.0 → maidr-0.16.0}/maidr/core/figure_manager.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
-from typing import Any
+
 import threading
+from typing import Any
 
 from matplotlib.artist import Artist
 from matplotlib.axes import Axes
@@ -57,17 +58,16 @@ class FigureManager:
             raise ValueError(f"No figure found for axis: {ax}.")
 
         # Add plot to the Maidr object associated with the plot's figure.
-        maidr = cls._get_maidr(ax.get_figure())
+        maidr = cls._get_maidr(ax.get_figure(), plot_type)
         plot = MaidrPlotFactory.create(ax, plot_type, **kwargs)
         maidr.plots.append(plot)
-
         return maidr
 
     @classmethod
-    def _get_maidr(cls, fig: Figure) -> Maidr:
+    def _get_maidr(cls, fig: Figure, plot_type: PlotType) -> Maidr:
         """Retrieve or create a Maidr instance for the given Figure."""
         if fig not in cls.figs.keys():
-            cls.figs[fig] = Maidr(fig)
+            cls.figs[fig] = Maidr(fig, plot_type)
         return cls.figs[fig]
 
     @classmethod

{maidr-0.14.0 → maidr-0.16.0}/maidr/core/maidr.py

@@ -14,6 +14,7 @@ from matplotlib.figure import Figure
 
 from maidr.core.context_manager import HighlightContextManager
 from maidr.core.enum.maidr_key import MaidrKey
+from maidr.core.enum.plot_type import PlotType
 from maidr.core.plot import MaidrPlot
 from maidr.util.environment import Environment
 
@@ -39,12 +40,13 @@ class Maidr:
         Displays the rendered HTML content in the specified rendering context.
     """
 
-    def __init__(self, fig: Figure) -> None:
+    def __init__(self, fig: Figure, plot_type: PlotType = PlotType.LINE) -> None:
         """Create a new Maidr for the given ``matplotlib.figure.Figure``."""
         self._fig = fig
         self._plots = []
         self.maidr_id = None
         self.selector_id = Maidr._unique_id()
+        self.plot_type = plot_type
 
     @property
     def fig(self) -> Figure:
@@ -137,6 +139,8 @@ class Maidr:
 
     def _flatten_maidr(self) -> dict | list[dict]:
         """Return a single plot schema or a list of schemas from the Maidr instance."""
+        if self.plot_type == PlotType.LINE:
+            self._plots = [self._plots[0]]
         maidr = [plot.schema for plot in self._plots]
 
         # Replace the selector having maidr='true' with maidr={self.maidr_id}

{maidr-0.14.0 → maidr-0.16.0}/maidr/core/plot/grouped_barplot.py

@@ -16,7 +16,7 @@ from maidr.util.mixin import (
 class GroupedBarPlot(
     MaidrPlot, ContainerExtractorMixin, LevelExtractorMixin, DictMergerMixin
 ):
-    def __init__(self, ax: Axes, plot_type: PlotType) -> None:
+    def __init__(self, ax: Axes, plot_type: PlotType, **kwargs) -> None:
         super().__init__(ax, plot_type)
         self._support_highlighting = False
 

maidr-0.16.0/maidr/core/plot/lineplot.py

@@ -0,0 +1,102 @@
+from matplotlib.axes import Axes
+from matplotlib.lines import Line2D
+
+from maidr.core.enum.maidr_key import MaidrKey
+from maidr.core.enum.plot_type import PlotType
+from maidr.core.plot.maidr_plot import MaidrPlot
+from maidr.exception.extraction_error import ExtractionError
+from maidr.util.environment import Environment
+from maidr.util.mixin.extractor_mixin import LineExtractorMixin
+
+
+class MultiLinePlot(MaidrPlot, LineExtractorMixin):
+    """
+    A class for extracting and processing data from line plots.
+
+    This class can handle both single-line and multi-line plots, extracting
+    coordinate data and line identifiers. It processes matplotlib Line2D objects
+    and converts them into structured data for further processing or visualization.
+
+    Parameters
+    ----------
+    ax : Axes
+        The matplotlib axes object containing the line plot(s).
+    **kwargs : dict
+        Additional keyword arguments to pass to the parent class.
+
+    Attributes
+    ----------
+    type : PlotType
+        Set to PlotType.LINE to identify this as a line plot.
+
+    Notes
+    -----
+    - When using the JavaScript engine, only single-line plots are supported.
+    - For multi-line plots, use the TypeScript engine.
+    - The extracted data structure includes x, y coordinates and line identifiers
+      (fill values) for each point.
+    """
+
+    def __init__(self, ax: Axes, **kwargs):
+        super().__init__(ax, PlotType.LINE)
+
+    def _get_selector(self) -> str:
+        return "g[maidr='true'] > path"
+
+    def _extract_plot_data(self) -> list[dict]:
+        plot = self.extract_lines(self.ax)
+        data = self._extract_line_data(plot)
+        engine = Environment.get_engine()
+        if engine == "js":
+            if len(data) > 1:
+                raise Exception(
+                    "MultiLine Plot not supported in JS. Use TypeScript Engine for this plot!"
+                )
+            data = data[0]
+
+        if data is None:
+            raise ExtractionError(self.type, plot)
+
+        return data
+
+    def _extract_line_data(self, plot: list[Line2D] | None) -> list[dict] | None:
+        """
+        Extract data from multiple line objects.
+
+        Parameters
+        ----------
+        plot : list[Line2D] | None
+            List of Line2D objects to extract data from.
+
+        Returns
+        -------
+        list[dict] | None
+            List of dictionaries containing x,y coordinates and line identifiers,
+            or None if the plot data is invalid.
+        """
+        if plot is None or len(plot) == 0:
+            return None
+
+        all_line_data = []
+
+        # Process each line in the plot
+        for i, line in enumerate(plot):
+            if line.get_xydata() is None:
+                continue
+
+            # Tag the element for highlighting
+            self._elements.append(line)
+
+            # Extract data from this line
+            line_data = [
+                {
+                    MaidrKey.X: float(x),
+                    MaidrKey.Y: float(y),
+                    MaidrKey.FILL: line.get_label(),
+                }
+                for x, y in line.get_xydata()  # type: ignore
+            ]
+
+            all_line_data.append(line_data)
+
+        return all_line_data if all_line_data else None

{maidr-0.14.0 → maidr-0.16.0}/maidr/core/plot/maidr_plot_factory.py

@@ -8,7 +8,7 @@ from maidr.core.plot.boxplot import BoxPlot
 from maidr.core.plot.grouped_barplot import GroupedBarPlot
 from maidr.core.plot.heatmap import HeatPlot
 from maidr.core.plot.histogram import HistPlot
-from maidr.core.plot.lineplot import LinePlot
+from maidr.core.plot.lineplot import MultiLinePlot
 from maidr.core.plot.maidr_plot import MaidrPlot
 from maidr.core.plot.scatterplot import ScatterPlot
 
@@ -39,7 +39,7 @@ class MaidrPlotFactory:
         elif PlotType.HIST == plot_type:
             return HistPlot(ax)
         elif PlotType.LINE == plot_type:
-            return LinePlot(ax)
+            return MultiLinePlot(ax)
         elif PlotType.SCATTER == plot_type:
             return ScatterPlot(ax)
         elif PlotType.DODGED == plot_type or PlotType.STACKED == plot_type:

maidr-0.16.0/maidr/patch/lineplot.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+import wrapt
+from matplotlib.axes import Axes
+from matplotlib.lines import Line2D
+
+from maidr.core.enum import PlotType
+from maidr.patch.common import common
+
+
+def line(wrapped, instance, args, kwargs) -> Axes | list[Line2D]:
+    """
+    Wrapper function for line plotting functions in matplotlib and seaborn.
+
+    Parameters
+    ----------
+    wrapped : callable
+        The wrapped function (plot or lineplot)
+    instance : object
+        The object to which the wrapped function belongs
+    args : tuple
+        Positional arguments passed to the wrapped function
+    kwargs : dict
+        Keyword arguments passed to the wrapped function
+
+    Returns
+    -------
+    Axes | list[Line2D]
+        The result of the wrapped function after processing
+    """
+    return common(PlotType.LINE, wrapped, instance, args, kwargs)
+
+
+# Patch matplotlib function.
+wrapt.wrap_function_wrapper(Axes, "plot", line)
+
+# Patch seaborn function.
+wrapt.wrap_function_wrapper("seaborn", "lineplot", line)

{maidr-0.14.0 → maidr-0.16.0}/maidr/util/mixin/extractor_mixin.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 from typing import Any
 
 from matplotlib.axes import Axes
@@ -64,6 +65,16 @@ class LineExtractorMixin:
         # `maidr` package supports the same.
         return ax.get_lines()[-1]
 
+    @staticmethod
+    def extract_lines(ax: Axes) -> list[Line2D] | None:
+        """Retrieve all line objects from Axes, if available."""
+        if ax is None or ax.get_lines() is None:
+            return None
+
+        # Since the upstream MaidrJS library currently supports only the last plot line,
+        # `maidr` package supports the same.
+        return ax.get_lines()
+
 
 class CollectionExtractorMixin:
     @staticmethod

{maidr-0.14.0 → maidr-0.16.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "maidr"
-version = "0.14.0"
+version = "0.16.0"
 description = "Multimodal Access and Interactive Data Representations"
 authors = [
     "JooYoung Seo <jseo1005@illinois.edu>",

maidr-0.14.0/maidr/core/plot/lineplot.py

@@ -1,45 +0,0 @@
-from __future__ import annotations
-
-from matplotlib.axes import Axes
-from matplotlib.lines import Line2D
-
-from maidr.core.enum import MaidrKey, PlotType
-from maidr.core.plot import MaidrPlot
-from maidr.exception import ExtractionError
-from maidr.util.environment import Environment
-from maidr.util.mixin import LineExtractorMixin
-
-
-class LinePlot(MaidrPlot, LineExtractorMixin):
-    def __init__(self, ax: Axes) -> None:
-        super().__init__(ax, PlotType.LINE)
-
-    def _get_selector(self) -> str:
-        return "g[maidr='true'] > path"
-
-    def _extract_plot_data(self) -> list[dict]:
-        plot = self.extract_line(self.ax)
-        data = self._extract_line_data(plot)
-        engine = Environment.get_engine()
-        if engine == "ts":
-            data = [data]
-
-        if data is None:
-            raise ExtractionError(self.type, plot)
-
-        return data
-
-    def _extract_line_data(self, plot: Line2D | None) -> list[dict] | None:
-        if plot is None or plot.get_xydata() is None:
-            return None
-
-        # Tag the elements for highlighting.
-        self._elements.append(plot)
-
-        return [
-            {
-                MaidrKey.X: float(x),
-                MaidrKey.Y: float(y),
-            }
-            for x, y in plot.get_xydata()
-        ]

maidr-0.14.0/maidr/patch/lineplot.py

@@ -1,20 +0,0 @@
-from __future__ import annotations
-
-import wrapt
-
-from matplotlib.axes import Axes
-from matplotlib.lines import Line2D
-
-from maidr.core.enum import PlotType
-from maidr.patch.common import common
-
-
-def line(wrapped, instance, args, kwargs) -> Axes | list[Line2D]:
-    return common(PlotType.LINE, wrapped, instance, args, kwargs)
-
-
-# Patch matplotlib function.
-wrapt.wrap_function_wrapper(Axes, "plot", line)
-
-# Patch seaborn function.
-wrapt.wrap_function_wrapper("seaborn", "lineplot", line)