Added 'title' to lineplot

Author: max-models

src/maxplotlib/canvas/canvas.py

@@ -144,8 +144,6 @@ def savefig(
                 )
                 fig.savefig(full_filepath)
 
-    # def add_line(self, label, x_data, y_data, **kwargs):
-
     def plot(self, backend="matplotlib", show=True, savefig=False, layers=None):
         if backend == "matplotlib":
             return self.plot_matplotlib(show=show, savefig=savefig, layers=layers)

src/maxplotlib/objects/__init__.py

@@ -0,0 +1,18 @@
+from abc import ABCMeta, abstractmethod
+
+class Layer(metaclass=ABCMeta):
+    def __init__(self, label):
+        self.label = label
+        self.items = []
+
+class Tikzlayer(Layer):
+    def __init__(self, label):
+        super().__init__(label)
+
+    def generate_tikz(self):
+        tikz_script = f"\n% Layer {self.label}\n"
+        tikz_script += f"\\begin{{pgfonlayer}}{{{self.label}}}\n"
+        for item in self.items:
+            tikz_script += item.to_tikz()
+        tikz_script += f"\\end{{pgfonlayer}}{{{self.label}}}\n"
+        return tikz_script

src/maxplotlib/objects/layer.py

@@ -3,6 +3,26 @@
 
 import maxplotlib.subfigure.tikz_figure as tf
 
+class Node:
+    def __init__(self, x, y, label="", content="", layer=0, **kwargs):
+        self.x = x
+        self.y = y
+        self.label = label
+        self.content = content
+        self.layer = layer
+        self.options = kwargs
+
+class Path:
+    def __init__(
+        self, nodes, path_actions=[], cycle=False, label="", layer=0, **kwargs
+    ):
+        self.nodes = nodes
+        self.path_actions = path_actions
+        self.cycle = cycle
+        self.layer = layer
+        self.label = label
+        self.options = kwargs
+
 class LinePlot:
     def __init__(self, **kwargs):
         """
@@ -19,6 +39,7 @@ def __init__(self, **kwargs):
         """
         # Set default values
         self._figsize = kwargs.get("figsize", (10, 6))
+        self._title = kwargs.get("title", None)
         self._caption = kwargs.get("caption", None)
         self._description = kwargs.get("description", None)
         self._label = kwargs.get("label", None)
@@ -31,6 +52,14 @@ def __init__(self, **kwargs):
         self.line_data = []
         self.layered_line_data = {}
 
+        # Initialize lists to hold Node and Path objects
+        self.nodes = []
+        self.paths = []
+        #self.layers = {}
+
+        # Counter for unnamed nodes
+        self._node_counter = 0
+
         # Scaling
         self._xscale = kwargs.get("xscale", 1.0)
         self._yscale = kwargs.get("yscale", 1.0)
@@ -40,7 +69,7 @@ def __init__(self, **kwargs):
     def add_caption(self, caption):
         self._caption = caption
 
-    def add_line(self, x_data, y_data, layer=0, **kwargs):
+    def add_line(self, x_data, y_data, layer=0, plot_type='plot', **kwargs):
         """
         Add a line to the plot.
 
@@ -54,6 +83,7 @@ def add_line(self, x_data, y_data, layer=0, **kwargs):
             "x": np.array(x_data),
             "y": np.array(y_data),
             "layer": layer,
+            "plot_type": plot_type,
             "kwargs": kwargs,
         }
         self.line_data.append(ld)
@@ -80,13 +110,22 @@ def plot_matplotlib(self, ax, layers=None):
             if layers and layer_name not in layers:
                 continue
             for line in layer_lines:
-                ax.plot(
-                    (line["x"] + self._xshift) * self._xscale,
-                    (line["y"] + self._yshift) * self._yscale,
-                    **line["kwargs"],
-                )
-            if self._caption:
-                ax.set_title(self._caption)
+                if line["plot_type"] == "plot":
+                    ax.plot(
+                        (line["x"] + self._xshift) * self._xscale,
+                        (line["y"] + self._yshift) * self._yscale,
+                        **line["kwargs"],
+                    )
+                elif line["plot_type"] == "scatter":
+                    ax.scatter(
+                        (line["x"] + self._xshift) * self._xscale,
+                        (line["y"] + self._yshift) * self._yscale,
+                        **line["kwargs"],
+                    )
+            # if self._caption:
+            #     ax.set_title(self._caption)
+            if self._title:
+                ax.set_title(self._title)
             if self._label:
                 ax.set_ylabel(self._label)
             if self._xlabel:
@@ -127,6 +166,67 @@ def plot_plotly(self):
             traces.append(trace)
 
         return traces
+    
+    def add_node(self, x, y, label=None, content="", layer=0, **kwargs):
+        """
+        Add a node to the TikZ figure.
+
+        Parameters:
+        - x (float): X-coordinate of the node.
+        - y (float): Y-coordinate of the node.
+        - label (str, optional): Label of the node. If None, a default label will be assigned.
+        - **kwargs: Additional TikZ node options (e.g., shape, color).
+
+        Returns:
+        - node (Node): The Node object that was added.
+        """
+        if label is None:
+            label = f"node{self._node_counter}"
+        node = Node(x=x, y=y, label=label, layer=layer, content=content, **kwargs)
+        self.nodes.append(node)
+        if layer in self.layers:
+            self.layers[layer].add(node)
+        else:
+            self.layers[layer] = Tikzlayer(layer)
+            self.layers[layer].add(node)
+        self._node_counter += 1
+        return node
+
+    def add_path(self, nodes, layer=0, **kwargs):
+        """
+        Add a line or path connecting multiple nodes.
+
+        Parameters:
+        - nodes (list of str): List of node names to connect.
+        - **kwargs: Additional TikZ path options (e.g., style, color).
+
+        Examples:
+        - add_path(['A', 'B', 'C'], color='blue')
+          Connects nodes A -> B -> C with a blue line.
+        """
+        if not isinstance(nodes, list):
+            raise ValueError("nodes parameter must be a list of node names.")
+
+        nodes = [
+            (
+                node
+                if isinstance(node, Node)
+                else (
+                    self.get_node(node)
+                    if isinstance(node, str)
+                    else ValueError(f"Invalid node type: {type(node)}")
+                )
+            )
+            for node in nodes
+        ]
+        path = Path(nodes, **kwargs)
+        self.paths.append(path)
+        if layer in self.layers:
+            self.layers[layer].add(path)
+        else:
+            self.layers[layer] = Tikzlayer(layer)
+            self.layers[layer].add(path)
+        return path
 
     # Getter and Setter for figsize
     @property

src/maxplotlib/objects/node.py

@@ -255,6 +255,7 @@ def generate_tikz(self):
         tikz_script += f"\\pgfsetlayers{{{','.join(layers)}}}\n"
 
         # Add grid if enabled
+        # TODO: Create a Grid class
         if self._grid:
             tikz_script += (
                 "    \\draw[step=1cm, gray, very thin] (-10,-10) grid (10,10);\n"

src/maxplotlib/objects/path.py

@@ -3,8 +3,18 @@
 
 c = canvas.Canvas(width=2000, ratio=0.5)
 sp = c.add_subplot(grid=True, xlabel='x', ylabel='y')
+
+node_a = sp.add_node(0, 0, 'A', content='Node A', shape='circle', draw='black', fill='blue!20')
+node_b = sp.add_node(1, 1, 'B', content='Node B', shape='circle', draw='black', fill='blue!20')
+#sp.add_node(2, 2, 'B', content="$a^2 + b^2 = c^2$", shape='rectangle', draw='red', fill='white', layer=1)
+#sp.add_node(2, 5, 'C', shape='rectangle', draw='red', fill='red')
+#last_node = sp.add_node(-1, 5, shape='rectangle', draw='red', fill='red', layer=-10)
+
+# Add a line between nodes 
+sp.add_path(['A', 'B'], color='green', style='solid', line_width='2',layer=-5)
+
 x = np.arange(0,2 * np.pi, 0.01)
 y = np.sin(x)
 sp.add_line(x, y, label=r"$\sin(x)$")
 # c.plot()
-c.savefig(filename='figures/tutorial_05_figure_01.pdf')
+c.savefig(filename='figures/tutorial_05_figure_01')