Added plotly backend

Author: max-models

.gitignore

@@ -183,4 +183,4 @@ cython_debug/
 env*
 
 # VS code
-.vscode/
+.vscode/*

.vscode/settings.json

@@ -16,9 +16,11 @@ classifiers = [
 ]
 dependencies = [
     "matplotlib",
+    "plotly",
     "pytest",
     "black",
     "isort",
+    "jupyterlab",
 ]
 
 [project.optional-dependencies]

pyproject.toml

@@ -108,63 +108,4 @@ def create_lineplot(
         constrained_layout=False,
         gridspec_kw=gridspec_kw,
     )
-    return fig, axs
-
-def create_3dplot(width=426.79135, dpi=300, ratio="golden"):
-    """
-    Creates a 3D plot figure and axis.
-    """
-    fig_width, fig_height = set_size(width, ratio=ratio)
-    fig = plt.figure(figsize=(fig_width, fig_height), dpi=dpi)
-    ax = fig.add_subplot(111, projection="3d")
-    return fig, ax
-
-def set_common_xlabel(fig, xlabel="common X", fontsize=14):
-    """
-    Sets a common X label for the figure.
-    """
-    fig.text(0.5, -0.075, xlabel, va="center", ha="center", fontsize=fontsize)
-
-def get_axis(axs, subfigure):
-    """
-    Retrieves the specified axis from the axes array.
-    """
-    if subfigure == -1:
-        return axs
-    elif not isinstance(subfigure, list):
-        return axs[subfigure]
-    elif isinstance(subfigure, list) and len(subfigure) == 2:
-        return axs[subfigure[0], subfigure[1]]
-    else:
-        raise ValueError("Invalid subfigure index.")
-
-def get_limits(ax=None):
-    """
-    Gets the current axis limits.
-    """
-    if ax is None:
-        ax = plt.gca()
-    xxmin, xxmax = ax.get_xlim()
-    yymin, yymax = ax.get_ylim()
-    return [xxmin, xxmax, yymin, yymax]
-
-def set_labels(ax, delta, point, axis="x"):
-    """
-    Sets custom tick labels on the specified axis.
-    """
-    if axis == "x":
-        xmin, xmax = ax.get_xlim()
-        width = int((xmax - xmin) / delta + 1) * delta
-        xvec = np.arange(point - width, point + width + delta, delta)
-        xvec = xvec[(xvec >= xmin) & (xvec <= xmax)]
-        ax.set_xticks(xvec)
-        ax.set_xticklabels([f"{x:.2f}" for x in xvec])
-    elif axis == "y":
-        ymin, ymax = ax.get_ylim()
-        width = int((ymax - ymin) / delta + 1) * delta
-        yvec = np.arange(point - width, point + width + delta, delta)
-        yvec = yvec[(yvec >= ymin) & (yvec <= ymax)]
-        ax.set_yticks(yvec)
-        ax.set_yticklabels([f"{y:.2f}" for y in yvec])
-    else:
-        raise ValueError("Axis must be 'x' or 'y'.")
+    return fig, axs

src/maxplotlib/backends/matplotlib/utils.py

@@ -1,8 +1,10 @@
 import matplotlib.pyplot as plt
 import maxplotlib.subfigure.line_plot as lp
 import maxplotlib.backends.matplotlib.utils as plt_utils
+import plotly.graph_objects as go
+from plotly.subplots import make_subplots
 class Canvas:
-    def __init__(self, nrows=1, ncols=1, caption=None, description=None, label=None, figsize=(10, 6)):
+    def __init__(self, **kwargs):
         """
         Initialize the Canvas class for multiple subplots.
 
@@ -11,94 +13,25 @@ def __init__(self, nrows=1, ncols=1, caption=None, description=None, label=None,
         ncols (int): Number of subplot columns. Default is 1.
         figsize (tuple): Figure size.
         """
-        self._nrows = nrows
-        self._ncols = ncols
-        self._figsize = figsize
-        self._caption = caption
-        self._description = description
-        self._label = label
+
+        #nrows=1, ncols=1, caption=None, description=None, label=None, figsize=None
+        self._nrows = kwargs.get('nrows', 1)
+        self._ncols = kwargs.get('ncols', 1)
+        self._figsize = kwargs.get('figsize', None)
+        self._caption = kwargs.get('caption', None)
+        self._description = kwargs.get('description', None)
+        self._label = kwargs.get('label', None)
+
+        self._width=kwargs.get('width', 426.79135)
+        self._ratio=kwargs.get('ratio', "golden")
+        self._gridspec_kw = kwargs.get('gridspec_kw', {"wspace": 0.08, "hspace": 0.1})
 
         # Dictionary to store lines for each subplot
         # Key: (row, col), Value: list of lines with their data and kwargs
         self.subplots = {}
         self._num_subplots = 0
 
-        self._subplot_matrix = [[None] * ncols for _ in range(nrows)]
-
-    # Property getters
-    @property
-    def nrows(self):
-        return self._nrows
-
-    @property
-    def ncols(self):
-        return self._ncols
-
-    @property
-    def caption(self):
-        return self._caption
-
-    @property
-    def description(self):
-        return self._description
-
-    @property
-    def label(self):
-        return self._label
-
-    @property
-    def figsize(self):
-        return self._figsize
-
-    @property
-    def subplot_matrix(self):
-        return self._subplot_matrix
-
-    # Property setters
-    @nrows.setter
-    def nrows(self, value):
-        self._nrows = value
-
-    @ncols.setter
-    def ncols(self, value):
-        self._ncols = value
-
-    @caption.setter
-    def caption(self, value):
-        self._caption = value
-
-    @description.setter
-    def description(self, value):
-        self._description = value
-
-    @label.setter
-    def label(self, value):
-        self._label = value
-
-    @figsize.setter
-    def figsize(self, value):
-        self._figsize = value
-
-    # Magic methods
-    def __str__(self):
-        return f"Canvas(nrows={self.nrows}, ncols={self.ncols}, figsize={self.figsize})"
-
-    def __repr__(self):
-        return f"Canvas(nrows={self.nrows}, ncols={self.ncols}, caption={self.caption}, label={self.label})"
-
-    def __getitem__(self, key):
-        """Allows accessing subplots by tuple index."""
-        row, col = key
-        if row >= self.nrows or col >= self.ncols:
-            raise IndexError("Subplot index out of range")
-        return self._subplot_matrix[row][col]
-
-    def __setitem__(self, key, value):
-        """Allows setting a subplot by tuple index."""
-        row, col = key
-        if row >= self.nrows or col >= self.ncols:
-            raise IndexError("Subplot index out of range")
-        self._subplot_matrix[row][col] = value
+        self._subplot_matrix = [[None] * self.ncols for _ in range(self.nrows)]
 
     def add_subplot(self, **kwargs):
         """
@@ -141,14 +74,15 @@ def add_subplot(self, **kwargs):
         return line_plot
     def savefig(self, filename, backend = 'matplotlib'):
         if backend == 'matplotlib':
-            fig = self.plot(show=False, savefig=True)
+            fig, axs = self.plot(show=False, backend='matplotlib', savefig=True)
             fig.savefig(filename)
-            #plt.savefig(filename)
     # def add_line(self, label, x_data, y_data, **kwargs):
 
     def plot(self, backend='matplotlib', show=True, savefig=False):
         if backend == 'matplotlib':
             return self.plot_matplotlib(show=show, savefig=savefig)
+        elif backend == 'plotly':
+            self.plot_plotly(show=show, savefig=savefig)
     def plot_matplotlib(self, show=True, savefig=False):
         """
         Generate and optionally display the subplots.
@@ -166,7 +100,13 @@ def plot_matplotlib(self, show=True, savefig=False):
             grid_alpha=1.0,
             grid_linestyle="dotted",
         )
-        fig, axes = plt.subplots(self.nrows, self.ncols, figsize=self.figsize, squeeze=False)
+
+        if self._figsize is not None:
+            fig_width, fig_height = self._figsize
+        else:
+            fig_width, fig_height = plt_utils.set_size(width=self._width, ratio=self._ratio)
+        
+        fig, axes = plt.subplots(self.nrows, self.ncols, figsize=(fig_width, fig_height), squeeze=False)
 
         for (row, col), line_plot in self.subplots.items():
             ax = axes[row][col]
@@ -180,8 +120,129 @@ def plot_matplotlib(self, show=True, savefig=False):
             plt.show()
         else:
             plt.close()
+        return fig, axes
+
+    def plot_plotly(self, show=True, savefig=None):
+        """
+        Generate and optionally display the subplots using Plotly.
+
+        Parameters:
+        show (bool): Whether to display the plot.
+        savefig (str, optional): Filename to save the figure if provided.
+        """
+        fontsize = 14
+        tex_fonts = plt_utils.setup_tex_fonts(fontsize=fontsize)  # adjust or redefine for Plotly if needed
+
+        # Set default width and height if not specified
+        if self._figsize is not None:
+            fig_width, fig_height = self._figsize
+        else:
+            fig_width, fig_height = plt_utils.set_size(width=self._width, ratio=self._ratio)
+
+        # Create subplots
+        fig = make_subplots(rows=self.nrows, cols=self.ncols, subplot_titles=[
+            f"Subplot ({row}, {col})" for (row, col) in self.subplots.keys()
+        ])
+
+        # Plot each subplot
+        for (row, col), line_plot in self.subplots.items():
+            traces = line_plot.plot_plotly()  # Generate Plotly traces for the line_plot
+            for trace in traces:
+                fig.add_trace(trace, row=row + 1, col=col + 1)
+
+        # Update layout settings
+        fig.update_layout(
+            width=fig_width,
+            height=fig_height,
+            font=dict(size=fontsize),
+            margin=dict(l=10, r=10, t=40, b=10),  # Adjust margins if needed
+        )
+
+        # Optionally save the figure
+        if savefig:
+            fig.write_image(savefig)
+
+        # Show or return the figure
+        if show:
+            fig.show()
         return fig
 
+
+    # Property getters
+    @property
+    def nrows(self):
+        return self._nrows
+
+    @property
+    def ncols(self):
+        return self._ncols
+
+    @property
+    def caption(self):
+        return self._caption
+
+    @property
+    def description(self):
+        return self._description
+
+    @property
+    def label(self):
+        return self._label
+
+    @property
+    def figsize(self):
+        return self._figsize
+
+    @property
+    def subplot_matrix(self):
+        return self._subplot_matrix
+
+    # Property setters
+    @nrows.setter
+    def nrows(self, value):
+        self._nrows = value
+
+    @ncols.setter
+    def ncols(self, value):
+        self._ncols = value
+
+    @caption.setter
+    def caption(self, value):
+        self._caption = value
+
+    @description.setter
+    def description(self, value):
+        self._description = value
+
+    @label.setter
+    def label(self, value):
+        self._label = value
+
+    @figsize.setter
+    def figsize(self, value):
+        self._figsize = value
+
+    # Magic methods
+    def __str__(self):
+        return f"Canvas(nrows={self.nrows}, ncols={self.ncols}, figsize={self.figsize})"
+
+    def __repr__(self):
+        return f"Canvas(nrows={self.nrows}, ncols={self.ncols}, caption={self.caption}, label={self.label})"
+
+    def __getitem__(self, key):
+        """Allows accessing subplots by tuple index."""
+        row, col = key
+        if row >= self.nrows or col >= self.ncols:
+            raise IndexError("Subplot index out of range")
+        return self._subplot_matrix[row][col]
+
+    def __setitem__(self, key, value):
+        """Allows setting a subplot by tuple index."""
+        row, col = key
+        if row >= self.nrows or col >= self.ncols:
+            raise IndexError("Subplot index out of range")
+        self._subplot_matrix[row][col] = value
+
     # def generate_matplotlib_code(self):
     #     """Generate code for plotting the data using matplotlib."""
     #     code = "import matplotlib.pyplot as plt\n\n"