maidr 0.12.2__py3-none-any.whl → 0.13.0__py3-none-any.whl

maidr/__init__.py

@@ -1,5 +1,6 @@
-__version__ = "0.12.2"
+__version__ = "0.13.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/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/core/maidr.py

@@ -78,7 +78,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.
 
@@ -190,13 +193,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';
@@ -205,19 +206,36 @@ class Maidr:
                     window.init("{maidr_id}");
                 }});
                 document.head.appendChild(script);
+            }} else {{
+                window.init("{maidr_id}");
+            }}
+        """
+
+        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.init("{maidr_id}");
+                    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),
         )
 
@@ -225,7 +243,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/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/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/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.2.dist-info → maidr-0.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: maidr
-Version: 0.12.2
+Version: 0.13.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.2.dist-info → maidr-0.13.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-maidr/__init__.py,sha256=776ah3rShNOZYxAPziBeiZHPXdYh2HxKUv3yWFuhhZA,357
-maidr/api.py,sha256=Zt7p8LV1UT6ERlptKrJz4L6r43j3XwiwLGY9GJeEjoo,1206
+maidr/__init__.py,sha256=l8GxTHYGbPGuc6jgS4bbzP2Caqb90CQYYYwW7LWmbbo,369
+maidr/api.py,sha256=u2WOQ8RWmXpzseEgbZJCB7FFZs7cEy-ya-Q18tGAYB4,1350
 maidr/core/__init__.py,sha256=WgxLpSEYMc4k3OyEOf1shOxfEq0ASzppEIZYmE91ThQ,25
 maidr/core/context_manager.py,sha256=HSzD4wpiALdI4Vm0QTdWqi1MWR5Uqy8BX_lOlCM3JYY,3463
 maidr/core/enum/__init__.py,sha256=9ee78L0dlxEx4ulUGVlD-J23UcUZmrGu0rXms54up3c,93
@@ -7,15 +7,15 @@ maidr/core/enum/library.py,sha256=e8ujT_L-McJWfoVJd1ty9K_2bwITnf1j0GPLsnAcHes,10
 maidr/core/enum/maidr_key.py,sha256=LNtt74d2gurefDNPD3SLLsTxKqO9qTyo3PBAUAyofnc,736
 maidr/core/enum/plot_type.py,sha256=pyfyIwlq3taqe2Z1sVUSbMsTp5QTvYBlZXsMMMclEVM,293
 maidr/core/figure_manager.py,sha256=HyYLIX3QzE-PmatSsTez9MmncTEu0wzPdFktZzE3NQM,3891
-maidr/core/maidr.py,sha256=HhZDgviRREyMxnHnPW1AytQ3cMGOQ35z_Ej9MWNu5lo,10738
+maidr/core/maidr.py,sha256=2tOBxsyG9a_xIq7cg6P1U665WSC3_NkzKxuz1sS3KxU,11459
 maidr/core/plot/__init__.py,sha256=xDIpRGM-4DfaSSL3nKcXrjdMecCHJ6en4K4nA_fPefQ,83
-maidr/core/plot/barplot.py,sha256=ke4OWBbvWcczHrlwAcMAT2mRbfZLRg7_UOPu9HNmz8k,1834
+maidr/core/plot/barplot.py,sha256=iKob48QXYjezxw5Pqw8C_W8KZvQB2fioEGWCtOeQ3JM,2605
 maidr/core/plot/boxplot.py,sha256=roADG8xJYRQlZPYbfGBQSQRw8974lhVnngGKEKXJttk,6090
 maidr/core/plot/grouped_barplot.py,sha256=pRmSAr6obcdjK4PPOt7-U77tMMKLM4lkKOiOklS8TbA,2061
 maidr/core/plot/heatmap.py,sha256=_Hn_wXsu-BQBYs4YO440-WRhmXAJ1WeBndBGVEUAP5M,2447
 maidr/core/plot/histogram.py,sha256=QV5W-6ZJQQcZsrM91JJBX-ONktJzH7yg_et5_bBPfQQ,1525
 maidr/core/plot/lineplot.py,sha256=iHPJgQ7CByM7UItBMDUy7YnkVV6tBRyW_vY4QoWib34,1140
-maidr/core/plot/maidr_plot.py,sha256=-QL_k3NtbHUPUpy_T24HtttgUWjyKZDZKPCE-_ZL3hQ,2971
+maidr/core/plot/maidr_plot.py,sha256=_9Ugn3cUwi-URxeTRbDAKDZwASrB65p9TKOXhFX1zbU,3176
 maidr/core/plot/maidr_plot_factory.py,sha256=Ai-vFpn9YhZPQeVQxdjq0prVJNcGZ8NJvS3eKAxxZ_w,1681
 maidr/core/plot/scatterplot.py,sha256=sQhT80w0Sp9AsUAZi4v6lfWsHJAvuFcer2aAE2NpAYE,1240
 maidr/exception/__init__.py,sha256=PzaXoYBhyZxMDcJkuxJugDx7jZeseI0El6LpxIwXyG4,46
@@ -31,13 +31,13 @@ maidr/patch/histogram.py,sha256=tnyKkTMuzDXdyQBywhpHZgH3i2mXzOCSyfUSRM0tfUg,1315
 maidr/patch/lineplot.py,sha256=AIVsEPXMlkyUfYJ2xcU0GtZLpykEhHDLVFZjYnWCq9U,492
 maidr/patch/scatterplot.py,sha256=JZJXy3vWbJgzZh2zysNrqSA7MRcfSCms6lr_MY5CMD0,526
 maidr/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-maidr/util/environment.py,sha256=1WuqCD3sN_7amnucz2OkxT8U4RQPyuGG5Xxv9Ik5SDo,4200
+maidr/util/environment.py,sha256=xtfibTH4RXW2GC7R_9OQo119BTe5M3bx0u13eFZaiZs,4554
 maidr/util/mixin/__init__.py,sha256=aGJZNhtWh77yIVPc7ipIZm1OajigjMtCWYKPuDWTC-c,217
 maidr/util/mixin/extractor_mixin.py,sha256=Y-34424UR8ECHECAuQZ7zKhyk5QC6GOiUeCMRhI06QQ,3132
 maidr/util/mixin/merger_mixin.py,sha256=V0qLw_6DUB7X6CQ3BCMpsCQX_ZuwAhoSTm_E4xAJFKM,712
 maidr/widget/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maidr/widget/shiny.py,sha256=wrrw2KAIpE_A6CNQGBtNHauR1DjenA_n47qlFXX9_rk,745
-maidr-0.12.2.dist-info/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-maidr-0.12.2.dist-info/METADATA,sha256=hV_PtugpUUFkYjxqBRyjOrJCLoK6sugXYXDO8KsXTbA,2688
-maidr-0.12.2.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-maidr-0.12.2.dist-info/RECORD,,
+maidr-0.13.0.dist-info/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+maidr-0.13.0.dist-info/METADATA,sha256=WNQKQgPsz3s7J8J5-MK9AsZWJcu6zTfybnoDXRoKJWQ,2688
+maidr-0.13.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+maidr-0.13.0.dist-info/RECORD,,