Merge pull request #39 from michox/master

implemented waypoints feature for draw.io

Author: dmulyalin

N2G/plugins/diagrams/N2G_DrawIO.py

@@ -307,6 +307,7 @@ def add_link(
         src_label_style="",
         trgt_label_style="",
         link_id=None,
+        waypoints=None, # Add waypoints parameter
         **kwargs,
     ):
         """
@@ -315,7 +316,7 @@ def add_link(
         **Parameters**
 
         * ``source`` (str) mandatory, source node id
-        * ``source`` (str) mandatory, target node id
+        * ``target`` (str) mandatory, target node id
         * ``label`` (str) link label to display at the center of the link
         * ``data`` (dict) dictionary of key value pairs to add as link data
         * ``url`` (str) url string to save as link ``url`` attribute
@@ -325,6 +326,7 @@ def add_link(
         * ``src_label_style`` (str) source label style string
         * ``trgt_label_style`` (str) target label style string
         * ``link_id`` (str or int) optional link id value, must be unique across all links
+        * ``waypoints`` (list) optional list of (x, y) tuples defining intermediate points for the link path. Example: [(100, 150), (200, 150)]
 
         Sample DrawIO style string for the link::
 
@@ -402,11 +404,29 @@ def add_link(
             )
             self.current_root.append(trgt_label_obj)
             kwargs["trgt_label"] = trgt_label
-        # add links data and url
+        # add links data and url (do NOT include waypoints in link_data)
         link_data.update(data)
         link_data.update(kwargs)
         link_data.update({"source": source, "target": target})
+        link_data.pop("waypoints", None)  # Remove waypoints from attributes if present
         link = self._add_data_or_url(link, link_data, url)
+
+        # add or update waypoints if provided
+        if waypoints and isinstance(waypoints, list):
+            mxCell = link.find("./mxCell")
+            mxGeometry = mxCell.find("./mxGeometry")
+            if mxGeometry is None:
+                mxGeometry = ET.SubElement(mxCell, "mxGeometry", {"relative": "1", "as": "geometry"})
+            # Remove any existing Array as="points"
+            for arr in mxGeometry.findall("./Array[@as='points']"):
+                mxGeometry.remove(arr)
+            array_elem = ET.SubElement(mxGeometry, "Array", {"as": "points"})
+            for x, y in waypoints:
+                try:
+                    ET.SubElement(array_elem, "mxPoint", {"x": str(float(x)), "y": str(float(y))})
+                except Exception:
+                    continue
+
         # save link to graph
         self.current_root.append(link)
 
@@ -779,6 +799,7 @@ def update_link(
         new_trgt_label=None,
         src_label_style="",
         trgt_label_style="",
+        waypoints=None, # Add waypoints parameter
     ):
         """
         Method to update edge/link details.
@@ -800,6 +821,8 @@ def update_link(
         * ``new_trgt_label`` (str) - new edge target label
         * ``src_label_style`` (str) - string with style to apply to source label
         * ``trgt_label_style`` (str) - strung with style to apply to target label
+        * ``waypoints`` (list or None) - optional list of (x, y) tuples defining new intermediate points.
+          If provided, replaces any existing waypoints. If None, existing waypoints are unchanged.
 
         Either of these must be provided to find link element to update:
 
@@ -922,6 +945,20 @@ def update_link(
                     style = style_file.read()
             mxCell_elem = edge.find("./mxCell")
             mxCell_elem.attrib["style"] = style
+        # Add or update waypoints if provided
+        if waypoints is not None:
+            mxGeometry = edge.find("./mxCell/mxGeometry")
+            # Remove existing Array as="points" if present
+            array_elem = mxGeometry.find("./Array[@as='points']")
+            if array_elem is not None:
+                mxGeometry.remove(array_elem)
+            if waypoints:
+                array_elem = ET.SubElement(mxGeometry, "Array", {"as": "points"})
+                for x, y in waypoints:
+                    try:
+                        ET.SubElement(array_elem, "mxPoint", {"x": str(float(x)), "y": str(float(y))})
+                    except Exception:
+                        continue
 
     def compare(
         self, data, diagram_name=None, missing_colour="#C0C0C0", new_colour="#00FF00"

tests/test_drawio_module.py

@@ -34,7 +34,7 @@ def test_1_add_elements_one_by_one():
         with open("./Output/should_be_test_1_add_elements_one_by_one.drawio") as should_be:
             assert normalize_xml(produced.read()) == normalize_xml(should_be.read())
 
-test_1_add_elements_one_by_one()
+# test_1_add_elements_one_by_one()
 
 def test_2_from_dict():
     ###########################################
@@ -483,4 +483,41 @@ def test_19_node_delete_mxcell_tag():
         with open("./Output/should_be_test_19_node_delete_mxcell_tag.drawio") as should_be:
             assert normalize_xml(produced.read()) == normalize_xml(should_be.read())    
 
-# test_19_node_delete_mxcell_tag()
+# test_19_node_delete_mxcell_tag()
+
+def test_20_link_waypoints():
+    """
+    Test creating and updating links with waypoints (mxPoint geometry).
+    """
+    print("test_20_link_waypoints")
+    drawio_drawing = create_drawio_diagram()
+    drawio_drawing.add_diagram("Page-1")
+    drawio_drawing.add_node(id="A", label="Node A", x_pos=100, y_pos=100)
+    drawio_drawing.add_node(id="B", label="Node B", x_pos=400, y_pos=300)
+    # Add link with waypoints
+    waypoints1 = [(200, 120), (300, 280), (350, 200)]
+    drawio_drawing.add_link(source="A", target="B", label="A to B", waypoints=waypoints1)
+    drawio_drawing.dump_file(filename="test_20_link_waypoints_1.drawio", folder="./Output/")
+    # Check waypoints in output
+    with open("./Output/test_20_link_waypoints_1.drawio") as f:
+        xml = f.read()
+        assert '<Array as="points">' in xml
+        assert '<mxPoint x="200.0" y="120.0" />' in xml
+        assert '<mxPoint x="300.0" y="280.0" />' in xml
+        assert '<mxPoint x="350.0" y="200.0" />' in xml
+    # Update link with new waypoints
+    waypoints2 = [(150, 150), (250, 250)]
+    # Find the link id (should be only one link)
+    link_id = drawio_drawing.edges_ids[drawio_drawing.current_diagram_id][0]
+    drawio_drawing.update_link(edge_id=link_id, waypoints=waypoints2)
+    drawio_drawing.dump_file(filename="test_20_link_waypoints_2.drawio", folder="./Output/")
+    # Check updated waypoints in output
+    with open("./Output/test_20_link_waypoints_2.drawio") as f:
+        xml = f.read()
+        assert '<Array as="points">' in xml
+        assert '<mxPoint x="150.0" y="150.0" />' in xml
+        assert '<mxPoint x="250.0" y="250.0" />' in xml
+        assert '<mxPoint x="200.0" y="120.0" />' not in xml  # old point should be gone
+        assert '<mxPoint x="350.0" y="200.0" />' not in xml
+        
+test_20_link_waypoints()