maidr 1.8.1__tar.gz → 1.9.0__tar.gz

{maidr-1.8.1 → maidr-1.9.0}/CHANGELOG.md

@@ -1,6 +1,14 @@
 # CHANGELOG
 
 
+## v1.9.0 (2025-10-31)
+
+### Features
+
+- Add data_in_svg parameter for save_html ([#257](https://github.com/xability/py-maidr/pull/257),
+  [`17d65ee`](https://github.com/xability/py-maidr/commit/17d65eee06ac3209ef3a91ebd623a5a6d0b16e79))
+
+
 ## v1.8.1 (2025-10-16)
 
 ### Bug Fixes

{maidr-1.8.1 → maidr-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maidr
-Version: 1.8.1
+Version: 1.9.0
 Summary: Multimodal Access and Interactive Data Representations
 Project-URL: Homepage, https://xability.github.io/py-maidr
 Project-URL: Repository, https://github.com/xability/py-maidr

{maidr-1.8.1 → maidr-1.9.0}/maidr/__init__.py

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

{maidr-1.8.1 → maidr-1.9.0}/maidr/api.py

@@ -14,12 +14,12 @@ from maidr.core.figure_manager import FigureManager
 def _get_plot_or_current(plot: Any | None) -> Any:
     """
     Get the plot object or current matplotlib figure if plot is None.
-    
+
     Parameters
     ----------
     plot : Any or None
         The plot object. If None, returns the current matplotlib figure.
-        
+
     Returns
     -------
     Any
@@ -28,7 +28,7 @@ def _get_plot_or_current(plot: Any | None) -> Any:
     if plot is None:
         # Lazy import matplotlib.pyplot when needed
         import matplotlib.pyplot as plt
-        
+
         return plt.gcf()
     return plot
 
@@ -48,7 +48,7 @@ def render(plot: Any | None = None) -> Tag:
         The rendered HTML representation of the plot.
     """
     plot = _get_plot_or_current(plot)
-    
+
     ax = FigureManager.get_axes(plot)
     if isinstance(ax, list):
         for axes in ax:
@@ -82,7 +82,7 @@ def show(
         The display result.
     """
     plot = _get_plot_or_current(plot)
-    
+
     ax = FigureManager.get_axes(plot)
     if isinstance(ax, list):
         for axes in ax:
@@ -95,10 +95,11 @@ def show(
 
 def save_html(
     plot: Any | None = None,
-    *, 
+    *,
     file: str,
-    lib_dir: str | None = "lib", 
-    include_version: bool = True
+    lib_dir: str | None = "lib",
+    include_version: bool = True,
+    data_in_svg: bool = True,
 ) -> str:
     """
     Save a MAIDR plot as HTML file.
@@ -113,6 +114,8 @@ def save_html(
         Directory name for libraries.
     include_version : bool, default True
         Whether to include version information.
+    data_in_svg : bool, default True
+        Controls where the MAIDR JSON payload is placed in the HTML or SVG.
 
     Returns
     -------
@@ -120,19 +123,21 @@ def save_html(
         The path to the saved HTML file.
     """
     plot = _get_plot_or_current(plot)
-    
+
     ax = FigureManager.get_axes(plot)
     htmls = []
     if isinstance(ax, list):
         for axes in ax:
             maidr = FigureManager.get_maidr(axes.get_figure())
-            htmls.append(maidr._create_html_doc(use_iframe=False))
+            htmls.append(maidr._create_html_doc(use_iframe=False, data_in_svg=data_in_svg))
         return htmls[-1].save_html(
             file, libdir=lib_dir, include_version=include_version
         )
     else:
         maidr = FigureManager.get_maidr(ax.get_figure())
-        return maidr.save_html(file, lib_dir=lib_dir, include_version=include_version)
+        return maidr.save_html(
+            file, lib_dir=lib_dir, include_version=include_version, data_in_svg=data_in_svg
+        )
 
 
 def stacked(plot: Axes | BarContainer) -> Maidr:
@@ -150,6 +155,6 @@ def close(plot: Any | None = None) -> None:
         The plot object to close. If None, uses the current matplotlib figure.
     """
     plot = _get_plot_or_current(plot)
-    
+
     ax = FigureManager.get_axes(plot)
     FigureManager.destroy(ax.get_figure())

{maidr-1.8.1 → maidr-1.9.0}/maidr/core/maidr.py

@@ -72,7 +72,12 @@ class Maidr:
         return self._create_html_tag(use_iframe=True)
 
     def save_html(
-        self, file: str, *, lib_dir: str | None = "lib", include_version: bool = True
+        self,
+        file: str,
+        *,
+        lib_dir: str | None = "lib",
+        include_version: bool = True,
+        data_in_svg: bool = True,
     ) -> str:
         """
         Save the HTML representation of the figure with MAIDR to a file.
@@ -86,9 +91,11 @@ class Maidr:
             (relative to the file's directory).
         include_version : bool, default=True
             Whether to include the version number in the dependency folder name.
+        data_in_svg : bool, default=True
+            Controls where the MAIDR JSON payload is placed in the output HTML or SVG.
         """
         html = self._create_html_doc(
-            use_iframe=False
+            use_iframe=False, data_in_svg=data_in_svg
         )  # Always use direct HTML for saving
         return html.save_html(file, libdir=lib_dir, include_version=include_version)
 
@@ -180,8 +187,17 @@ class Maidr:
         else:
             webbrowser.open(f"file://{html_file_path}")
 
-    def _create_html_tag(self, use_iframe: bool = True) -> Tag:
-        """Create the MAIDR HTML using HTML tags."""
+    def _create_html_tag(self, use_iframe: bool = True, data_in_svg: bool = True) -> Tag:
+        """Create the MAIDR HTML using HTML tags.
+
+        Parameters
+        ----------
+        use_iframe : bool, default=True
+            Whether to render the plot inside an iframe (for notebooks and similar envs).
+        data_in_svg : bool, default=True
+            If True, the MAIDR JSON is embedded in the root <svg> under attribute 'maidr'.
+            If False, a <script>var maidr = {...}</script> tag is injected instead.
+        """
         tagged_elements: list[Any] = [
             element for plot in self._plots for element in plot.elements
         ]
@@ -191,16 +207,31 @@ class Maidr:
             for _ in plot.elements:
                 selector_ids.append(self.selector_ids[i])
 
+        # Build schema once so id stays consistent across SVG and global var
+        schema = self._flatten_maidr()
+
         with HighlightContextManager.set_maidr_elements(tagged_elements, selector_ids):
-            svg = self._get_svg()
-        maidr = f"\nlet maidr = {json.dumps(self._flatten_maidr(), indent=2)}\n"
+            svg = self._get_svg(embed_data=data_in_svg, schema=schema)
+
+        # Generate external payload if data is not embedded in SVG
+        maidr = None
+        if not data_in_svg:
+            maidr = f"\nvar maidr = {json.dumps(schema, indent=2)}\n"
 
         # Inject plot's svg and MAIDR structure into html tag.
         return Maidr._inject_plot(svg, maidr, self.maidr_id, use_iframe)
 
-    def _create_html_doc(self, use_iframe: bool = True) -> HTMLDocument:
-        """Create an HTML document from Tag objects."""
-        return HTMLDocument(self._create_html_tag(use_iframe), lang="en")
+    def _create_html_doc(self, use_iframe: bool = True, data_in_svg: bool = True) -> HTMLDocument:
+        """Create an HTML document from Tag objects.
+
+        Parameters
+        ----------
+        use_iframe : bool, default=True
+            Whether to render the plot inside an iframe (for notebooks and similar envs).
+        data_in_svg : bool, default=True
+            See _create_html_tag for details on payload placement strategy.
+        """
+        return HTMLDocument(self._create_html_tag(use_iframe, data_in_svg), lang="en")
 
     def _merge_plots_by_subplot_position(self) -> list[MaidrPlot]:
         """
@@ -312,10 +343,23 @@ class Maidr:
                 for cell in subplot_grid[i]
             ]
 
-        return {"id": Maidr._unique_id(), "subplots": subplot_grid}
+        return {
+            "id": Maidr._unique_id(),
+            "subplots": subplot_grid,
+        }
 
-    def _get_svg(self) -> HTML:
-        """Extract the chart SVG from ``matplotlib.figure.Figure``."""
+    def _get_svg(self, embed_data: bool = True, schema: dict | None = None) -> HTML:
+        """Extract the chart SVG from ``matplotlib.figure.Figure``.
+
+        Parameters
+        ----------
+        embed_data : bool, default=True
+            If True, embed the MAIDR JSON schema as an attribute named 'maidr' on
+            the root <svg> element. If False, do not embed JSON in the SVG.
+        schema : dict | None, default=None
+            If provided, this schema will be used (ensuring a consistent id across
+            the page). If None, a new schema will be generated.
+        """
         svg_buffer = io.StringIO()
         self._fig.savefig(svg_buffer, format="svg")
         str_svg = svg_buffer.getvalue()
@@ -323,12 +367,14 @@ class Maidr:
         etree.register_namespace("svg", "http://www.w3.org/2000/svg")
         tree_svg = etree.fromstring(str_svg.encode(), parser=None)
         root_svg = None
-        # Find the `svg` tag and set unique id if not present else use it.
+        # Find the `svg` tag and optionally embed MAIDR data.
         for element in tree_svg.iter(tag="{http://www.w3.org/2000/svg}svg"):
-            if "maidr-data" not in element.attrib:
-                element.attrib["maidr-data"] = json.dumps(
-                    self._flatten_maidr(), indent=2
-                )
+            current_schema = schema if schema is not None else self._flatten_maidr()
+            # Ensure SVG id matches schema id in both modes
+            if isinstance(current_schema, dict) and "id" in current_schema:
+                element.attrib["id"] = str(current_schema["id"])  # ensure match
+            if embed_data:
+                element.attrib["maidr"] = json.dumps(current_schema, indent=2)
             root_svg = element
             break
 
@@ -355,36 +401,41 @@ class Maidr:
         return str(uuid.uuid4())
 
     @staticmethod
-    def _inject_plot(plot: HTML, maidr: str, maidr_id, use_iframe: bool = True) -> Tag:
+    def _inject_plot(plot: HTML, maidr: str | None, maidr_id, use_iframe: bool = True) -> Tag:
         """Embed the plot and associated MAIDR scripts into the HTML structure."""
         # Get the latest version from npm registry
         MAIDR_TS_CDN_URL = "https://cdn.jsdelivr.net/npm/maidr@latest/dist/maidr.js"
 
         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();
-                }});
-            }}
+            (function() {{
+                var existing = document.querySelector('script[src="{MAIDR_TS_CDN_URL}"]');
+                if (!existing) {{
+                    var s = document.createElement('script');
+                    s.src = '{MAIDR_TS_CDN_URL}';
+                    s.onload = function() {{ if (window.main) window.main(); }};
+                    document.head.appendChild(s);
+                }} else {{
+                    if (document.readyState === 'loading') {{
+                        document.addEventListener('DOMContentLoaded', function() {{ if (window.main) window.main(); }});
+                    }} else {{
+                        if (window.main) window.main();
+                    }}
+                }}
+            }})();
         """
 
-        base_html = tags.div(
+        children = [
             tags.link(
                 rel="stylesheet",
                 href="https://cdn.jsdelivr.net/npm/maidr@latest/dist/maidr_style.css",
-            ),
-            tags.script(script, type="text/javascript"),
-            tags.div(plot),
-        )
+            )
+        ]
+        if maidr is not None:
+            children.append(tags.script(maidr, type="text/javascript"))
+        children.append(tags.script(script, type="text/javascript"))
+        children.append(tags.div(plot))
+
+        base_html = tags.div(*children)
 
         # is_quarto = os.getenv("IS_QUARTO") == "True"
 

{maidr-1.8.1 → maidr-1.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "maidr"
-version = "1.8.1"
+version = "1.9.0"
 description = "Multimodal Access and Interactive Data Representations"
 authors = [
     { name = "JooYoung Seo", email = "jseo1005@illinois.edu" },

{maidr-1.8.1 → maidr-1.9.0}/uv.lock

@@ -1876,7 +1876,7 @@ wheels = [
 
 [[package]]
 name = "maidr"
-version = "1.8.0"
+version = "1.8.1"
 source = { editable = "." }
 dependencies = [
     { name = "htmltools" },