maidr 0.12.3__tar.gz → 0.14.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: maidr
-Version: 0.12.3
+Version: 0.14.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.12.3 → maidr-0.14.0}/maidr/__init__.py

@@ -1,5 +1,6 @@
-__version__ = "0.12.3"
+__version__ = "0.14.0"
 
+from .api import close, render, save_html, set_engine, show, stacked
 from .core import Maidr
 from .core.enum import PlotType
 from .patch import (
@@ -12,7 +13,6 @@ from .patch import (
     lineplot,
     scatterplot,
 )
-from .api import close, render, save_html, show, stacked
 
 __all__ = [
     "close",

{maidr-0.12.3 → maidr-0.14.0}/maidr/api.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Literal, Any
+from typing import Any, Literal
 
 from htmltools import Tag
 from matplotlib.axes import Axes
@@ -9,6 +9,7 @@ from matplotlib.container import BarContainer
 from maidr.core import Maidr
 from maidr.core.enum import PlotType
 from maidr.core.figure_manager import FigureManager
+from maidr.util.environment import Environment
 
 
 def render(plot: Any) -> Tag:
@@ -39,3 +40,7 @@ def stacked(plot: Axes | BarContainer) -> Maidr:
 def close(plot: Any) -> None:
     ax = FigureManager.get_axes(plot)
     FigureManager.destroy(ax.get_figure())
+
+
+def set_engine(engine: Literal["js", "ts"] = "js"):
+    Environment._set_engine(engine=engine)

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

@@ -44,6 +44,7 @@ class Maidr:
         self._fig = fig
         self._plots = []
         self.maidr_id = None
+        self.selector_id = Maidr._unique_id()
 
     @property
     def fig(self) -> Figure:
@@ -78,7 +79,10 @@ class Maidr:
         html = self._create_html_doc()
         return html.save_html(file, libdir=lib_dir, include_version=include_version)
 
-    def show(self, renderer: Literal["auto", "ipython", "browser"] = "auto") -> object:
+    def show(
+        self,
+        renderer: Literal["auto", "ipython", "browser"] = "auto",
+    ) -> object:
         """
         Preview the HTML content using the specified renderer.
 
@@ -122,7 +126,7 @@ class Maidr:
         maidr = f"\nlet maidr = {json.dumps(self._flatten_maidr(), indent=2)}\n"
 
         # In SVG we will replace maidr=id with the unique id.
-        svg = svg.replace('maidr="true"', f'maidr="{self.maidr_id}"')
+        svg = svg.replace('maidr="true"', f'maidr="{self.selector_id}"')
 
         # Inject plot's svg and MAIDR structure into html tag.
         return Maidr._inject_plot(svg, maidr, self.maidr_id)
@@ -139,7 +143,7 @@ class Maidr:
         for plot in maidr:
             if MaidrKey.SELECTOR in plot:
                 plot[MaidrKey.SELECTOR] = plot[MaidrKey.SELECTOR].replace(
-                    "maidr='true'", f"maidr='{self.maidr_id}'"
+                    "maidr='true'", f"maidr='{self.selector_id}'"
                 )
 
         return maidr if len(maidr) != 1 else maidr[0]
@@ -190,13 +194,11 @@ class Maidr:
     def _inject_plot(plot: HTML, maidr: str, maidr_id) -> Tag:
         """Embed the plot and associated MAIDR scripts into the HTML structure."""
 
-        script_check = f"""
-            function initializeMaidr(maidrId) {{
-                if (window.init) {{
-                    window.init(maidrId);
-                }}
-            }}
+        engine = Environment.get_engine()
+
+        MAIDR_TS_CDN_URL = "https://cdn.jsdelivr.net/npm/maidr-ts/dist/maidr.js"
 
+        maidr_js_script = f"""
             if (!document.querySelector('script[src="https://cdn.jsdelivr.net/npm/maidr/dist/maidr.min.js"]')) {{
                 var script = document.createElement('script');
                 script.type = 'text/javascript';
@@ -210,12 +212,31 @@ class Maidr:
             }}
         """
 
+        maidr_ts_script = f"""
+            if (!document.querySelector('script[src="{MAIDR_TS_CDN_URL}"]'))
+            {{
+                var script = document.createElement('script');
+                script.type = 'module';
+                script.src = '{MAIDR_TS_CDN_URL}';
+                script.addEventListener('load', function() {{
+                    window.main();
+                }});
+                document.head.appendChild(script);
+            }} else {{
+                document.addEventListener('DOMContentLoaded', function (e) {{
+                    window.main();
+                }});
+            }}
+        """
+
+        script = maidr_js_script if engine == "js" else maidr_ts_script
+
         base_html = tags.div(
             tags.link(
                 rel="stylesheet",
                 href="https://cdn.jsdelivr.net/npm/maidr/dist/maidr_style.min.css",
             ),
-            tags.script(script_check, type="text/javascript"),
+            tags.script(script, type="text/javascript"),
             tags.div(plot),
         )
 
@@ -223,7 +244,10 @@ class Maidr:
 
         # Render the plot inside an iframe if in a Jupyter notebook, Google Colab
         # or VSCode notebook. No need for iframe if this is a Quarto document.
-        if Environment.is_notebook() and not is_quarto:
+        # For TypeScript we will use iframe by default for now
+        if (Environment.is_notebook() and not is_quarto) or (
+            engine == "ts" and Environment.is_notebook()
+        ):
             unique_id = "iframe_" + Maidr._unique_id()
 
             def generate_iframe_script(unique_id: str) -> str:

{maidr-0.12.3 → maidr-0.14.0}/maidr/core/plot/barplot.py

@@ -6,6 +6,7 @@ from matplotlib.container import BarContainer
 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 (
     ContainerExtractorMixin,
     DictMergerMixin,
@@ -18,18 +19,34 @@ class BarPlot(MaidrPlot, ContainerExtractorMixin, LevelExtractorMixin, DictMerge
         super().__init__(ax, PlotType.BAR)
 
     def _extract_axes_data(self) -> dict:
+        engine = Environment.get_engine()
+
         base_schema = super()._extract_axes_data()
-        bar_ax_schema = {
-            MaidrKey.X: {
-                MaidrKey.LEVEL: self.extract_level(self.ax),
-            },
-        }
+        bar_ax_schema = {}
+        if engine == "js":
+            bar_ax_schema = {
+                MaidrKey.X: {
+                    MaidrKey.LEVEL: self.extract_level(self.ax),
+                },
+            }
         return self.merge_dict(base_schema, bar_ax_schema)
 
     def _extract_plot_data(self) -> list:
+        engine = Environment.get_engine()
         plot = self.extract_container(self.ax, BarContainer, include_all=True)
         data = self._extract_bar_container_data(plot)
-
+        levels = self.extract_level(self.ax)
+        if engine == "ts":
+            formatted_data = []
+            combined_data = (
+                zip(levels, data) if plot[0].orientation == "vertical" else zip(levels, data)  # type: ignore
+            )
+            if len(data) == len(plot):  # type: ignore
+                for x, y in combined_data:  # type: ignore
+                    formatted_data.append({"x": x, "y": y})
+                return formatted_data
+            if len(formatted_data) == 0:
+                raise ExtractionError(self.type, plot)
         if data is None:
             raise ExtractionError(self.type, plot)
 

{maidr-0.12.3 → maidr-0.14.0}/maidr/core/plot/lineplot.py

@@ -6,6 +6,7 @@ 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
 
 
@@ -19,6 +20,9 @@ class LinePlot(MaidrPlot, LineExtractorMixin):
     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)

{maidr-0.12.3 → maidr-0.14.0}/maidr/core/plot/maidr_plot.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
+
 from abc import ABC, abstractmethod
 
 from matplotlib.axes import Axes
 
 from maidr.core.enum import MaidrKey, PlotType
+from maidr.util.environment import Environment
 
 
 class MaidrPlot(ABC):
@@ -65,6 +67,9 @@ class MaidrPlot(ABC):
 
     def _extract_axes_data(self) -> dict:
         """Extract the plot's axes data"""
+        engine = Environment.get_engine()
+        if engine == "ts":
+            return {MaidrKey.X: self.ax.get_xlabel(), MaidrKey.Y: self.ax.get_ylabel()}
         return {
             MaidrKey.X: {
                 MaidrKey.LABEL: self.ax.get_xlabel(),

{maidr-0.12.3 → maidr-0.14.0}/maidr/util/environment.py

@@ -1,8 +1,21 @@
 import json
 import os
+from typing import Literal
 
 
 class Environment:
+    _engine = "js"
+
+    @classmethod
+    def _set_engine(cls, engine: Literal["js", "ts"]) -> None:
+        """Set the engine to use for the MAIDR instance."""
+        cls._engine = engine
+
+    @classmethod
+    def get_engine(cls) -> str:
+        """Get the engine to use for the MAIDR instance."""
+        return cls._engine
+
     @staticmethod
     def is_interactive_shell() -> bool:
         """Return True if the environment is an interactive shell."""

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

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