iplotx 0.3.1__py3-none-any.whl → 0.4.0__py3-none-any.whl

iplotx/{style.py → style/__init__.py}

@@ -4,49 +4,15 @@ from typing import (
     Sequence,
 )
 from collections.abc import Hashable
-import copy
 from contextlib import contextmanager
 import numpy as np
 import pandas as pd
 
-
-style_leaves = (
-    "cmap",
-    "color",
-    "size",
-    "edgecolor",
-    "facecolor",
-    "linewidth",
-    "linestyle",
-    "alpha",
-    "zorder",
-    "tension",
-    "looptension",
-    "loopmaxangle",
-    "paralleloffset",
-    "offset",
-    "rotate",
-    "marker",
-    "waypoints",
-    "horizontalalignment",
-    "verticalalignment",
-    "boxstyle",
-    "hpadding",
-    "vpadding",
-    "hmargin",
-    "vmargin",
-    "ports",
-    "extend",
-)
-
-# These properties are not allowed to be rotated (global throughout the graph).
-# This might change in the future as the API improves.
-nonrotating_leaves = (
-    "paralleloffset",
-    "looptension",
-    "loopmaxangle",
-    "vertexpadding",
-    "extend",
+from ..utils.style import copy_with_deep_values
+from .library import style_library
+from .leaf_info import (
+    style_leaves,
+    nonrotating_leaves,
 )
 
 
@@ -68,10 +34,10 @@ default = {
         "linestyle": "-",
         "color": "black",
         "curved": False,
-        "paralleloffset": 3,
         "tension": 1,
         "looptension": 4,
         "loopmaxangle": 60,
+        "paralleloffset": 3,
         "label": {
             "horizontalalignment": "center",
             "verticalalignment": "center",
@@ -97,59 +63,14 @@ default = {
 }
 
 
-def copy_with_deep_values(style):
-    """Make a deep copy of the style dict but do not create copies of the keys."""
-    newdict = {}
-    for key, value in style.items():
-        if isinstance(value, dict):
-            newdict[key] = copy_with_deep_values(value)
-        else:
-            newdict[key] = copy.copy(value)
-    return newdict
-
-
-hollow = copy_with_deep_values(default)
-hollow["vertex"]["color"] = None
-hollow["vertex"]["facecolor"] = "none"
-hollow["vertex"]["edgecolor"] = "black"
-hollow["vertex"]["linewidth"] = 1.5
-hollow["vertex"]["marker"] = "r"
-hollow["vertex"]["size"] = "label"
-hollow["vertex"]["label"]["color"] = "black"
-
-tree = copy_with_deep_values(default)
-tree["vertex"]["size"] = 0
-tree["vertex"]["alpha"] = 0
-tree["edge"]["linewidth"] = 2.5
-tree["vertex"]["label"]["bbox"] = {
-    "boxstyle": "square,pad=0.5",
-    "facecolor": "white",
-    "edgecolor": "none",
-}
-tree["vertex"]["label"]["color"] = "black"
-tree["vertex"]["label"]["size"] = 12
-tree["vertex"]["label"]["verticalalignment"] = "center"
-tree["vertex"]["label"]["hmargin"] = 10
-
-
 styles = {
     "default": default,
-    "hollow": hollow,
-    "tree": tree,
 }
 
 
-stylename = "default"
-
-
 current = copy_with_deep_values(styles["default"])
 
 
-def get_stylename():
-    """Return the name of the current iplotx style."""
-    return str(stylename)
-
-
 def get_style(name: str = "", *args) -> dict[str, Any]:
     """Get a *deep copy* of the chosen style.
 
@@ -403,3 +324,20 @@ def rotate_style(
                 style[prop] = valtype()
 
     return style
+
+
+def add_style(name: str, style: dict[str, Any]) -> None:
+    """Add a style to the default dictionary of styles.
+
+    Parameters:
+        name: The name of the style to add.
+        style: A dictionary with the style properties to add.
+    """
+    with context(["default", style]):
+        styles[name] = get_style()
+
+
+# Populate style library
+for name, style in style_library.items():
+    add_style(name, style)
+    del name, style

iplotx/style/leaf_info.py

@@ -0,0 +1,41 @@
+# These properties are at the bottom of a style dictionary. Values corresponding
+# to these keys are rotatable.
+rotating_leaves = (
+    "cmap",
+    "color",
+    "size",
+    "edgecolor",
+    "facecolor",
+    "linewidth",
+    "linestyle",
+    "alpha",
+    "zorder",
+    "tension",
+    "offset",
+    "rotate",
+    "marker",
+    "waypoints",
+    "horizontalalignment",
+    "verticalalignment",
+    "boxstyle",
+    "hpadding",
+    "vpadding",
+    "hmargin",
+    "vmargin",
+    "ports",
+)
+
+# These properties are also terminal style properties, but they cannot be rotated.
+# This might change in the future as the API improves.
+nonrotating_leaves = (
+    "paralleloffset",
+    "looptension",
+    "loopmaxangle",
+    "vertexpadding",
+    "extend",
+    "deep",
+    "angular",
+)
+
+# Union of all style leaves (rotating and nonrotating)
+style_leaves = tuple(list(rotating_leaves) + list(nonrotating_leaves))

iplotx/style/library.py

@@ -0,0 +1,230 @@
+style_library = {
+    # Hollow style for organization charts et similar
+    "hollow": {
+        "vertex": {
+            "color": None,
+            "facecolor": "none",
+            "edgecolor": "black",
+            "linewidth": 1.5,
+            "marker": "r",
+            "size": "label",
+            "label": {
+                "color": "black",
+            },
+        }
+    },
+    # Tree style, with zero-size vertices
+    "tree": {
+        "vertex": {
+            "size": 0,
+            "label": {
+                "color": "black",
+                "size": 12,
+                "verticalalignment": "center",
+                "hmargin": 10,
+                "bbox": {
+                    "boxstyle": "square,pad=0.5",
+                    "facecolor": "none",
+                    "edgecolor": "none",
+                },
+            },
+        },
+        "edge": {
+            "linewidth": 2.5,
+        },
+    },
+    # Cogent3 tree style
+    "cogent3": {
+        "vertex": {
+            "size": 3,
+            "label": {
+                "color": "black",
+                "size": 10,
+                "verticalalignment": "center",
+                "bbox": {
+                    "facecolor": "none",
+                    "edgecolor": "none",
+                },
+            },
+        },
+        "edge": {
+            "linewidth": 1.5,
+        },
+        "leaf": {
+            "deep": False,
+        },
+    },
+    # Greyscale style
+    "greyscale": {
+        "vertex": {
+            "color": None,
+            "facecolor": "lightgrey",
+            "edgecolor": "#111",
+            "marker": ">",
+            "size": 15,
+            "linewidth": 0.75,
+            "label": {
+                "color": "black",
+            },
+        },
+        "edge": {
+            "color": "#111",
+            "linewidth": 0.75,
+            "arrow": {
+                "marker": ">",
+            },
+            "label": {
+                "rotate": True,
+                "color": "black",
+            },
+        },
+    },
+    # Edge highlight
+    "rededge": {
+        "vertex": {
+            "size": 13,
+            "color": None,
+            "facecolor": "none",
+            "edgecolor": "#111",
+            "linewidth": 2,
+            "label": {
+                "color": "#111",
+            },
+        },
+        "edge": {
+            "color": "tomato",
+            "linewidth": 2.5,
+        },
+    },
+    # Vertex highlight
+    "rednode": {
+        "vertex": {
+            "size": 22,
+            "color": None,
+            "facecolor": "tomato",
+            "edgecolor": "firebrick",
+            "linewidth": 2,
+        },
+        "edge": {
+            "color": "#333",
+            "linewidth": 1,
+        },
+    },
+    # Eerie style
+    "eerie": {
+        "vertex": {
+            "color": None,
+            "facecolor": "white",
+            "edgecolor": "#111",
+            "linestyle": "--",
+            "linewidth": 2,
+        },
+        "edge": {
+            "color": "#111",
+            "linestyle": "--",
+            "linewidth": 2,
+            "arrow": {
+                "marker": ")",
+            },
+        },
+    },
+    # Emulate a little networkx
+    "networkx": {
+        "vertex": {
+            "color": None,
+            "facecolor": "steelblue",
+            "edgecolor": "none",
+            "label": {
+                "color": "black",
+            },
+        },
+        "edge": {
+            "color": "black",
+            "linewidth": 1.5,
+            "arrow": {
+                "width": 5,
+            },
+        },
+    },
+    "igraph": {
+        "vertex": {
+            "color": None,
+            "facecolor": "lightblue",
+            "edgecolor": "black",
+            "linewidth": 2,
+            "label": {
+                "color": "black",
+            },
+        },
+        "edge": {
+            "color": "black",
+            "linewidth": 2,
+            "arrow": {
+                "marker": "|>",
+                "width": 6.5,
+            },
+        },
+    },
+    # Colorful style for general use
+    "unicorn": {
+        "vertex": {
+            "size": 23,
+            "color": None,
+            "facecolor": [
+                "darkorchid",
+                "slateblue",
+                "seagreen",
+                "lime",
+                "gold",
+                "orange",
+                "sandybrown",
+                "tomato",
+                "deeppink",
+            ],
+            "edgecolor": "black",
+            "linewidth": 1,
+            "marker": "*",
+            "label": {
+                "color": [
+                    "white",
+                    "white",
+                    "white",
+                    "black",
+                    "black",
+                    "black",
+                    "black",
+                    "white",
+                    "white",
+                ],
+            },
+        },
+        "edge": {
+            "color": [
+                "darkorchid",
+                "slateblue",
+                "seagreen",
+                "lime",
+                "gold",
+                "orange",
+                "sandybrown",
+                "tomato",
+                "deeppink",
+            ],
+            "linewidth": 1.5,
+            "label": {
+                "rotate": False,
+                "color": [
+                    "white",
+                    "white",
+                    "white",
+                    "black",
+                    "black",
+                    "black",
+                    "black",
+                    "white",
+                    "white",
+                ],
+            },
+        },
+    },
+}