@knowvah/dot-engine 1.4.0 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowvah/dot-engine",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "Faithful TypeScript port of Graphviz (dot, neato, fdp, sfdp, circo, twopi, osage, patchwork) — no C: no native binary, no WASM. Oracle-verified against the C implementation, runs in the browser.",
   "keywords": [
     "graphviz",

package/src/api/geometry.ts

@@ -106,6 +106,12 @@ export interface NodeGeometry {
  * type) still holds calloc-zero coordinates, so it is reported as absent
  * rather than as a label at the origin.
  *
+ * `xlabel` is the `xlabel` external label, positioned by the force-placement
+ * search rather than by spline midpoint arithmetic, so it is not derivable
+ * from `label` or `points`. It carries the same `lp->set` gate: a declared
+ * xlabel the search could not fit is reported as absent, exactly as
+ * `render()` declines to draw it.
+ *
  * `sp`/`ep` are the arrow attachment points. When an end carries an arrow the
  * spline is shortened to leave room for it, and the arrow spans from the
  * terminal control point out to this point — so a consumer drawing its own
@@ -119,7 +125,8 @@ export interface NodeGeometry {
  * (measured: ~1.5pt at `penwidth=1`, ~6.2pt at `penwidth=5`), so `ep` is the
  * point to draw an arrow *to*, not a copy of the rendered polygon's tip.
  *
- * @see lib/common/types.h:ED_spl, ED_label, ED_tail_label, ED_head_label
+ * @see lib/common/types.h:ED_spl, ED_label, ED_tail_label, ED_head_label,
+ *   ED_xlabel
  * @see lib/common/types.h:bezier (sflag/eflag, sp/ep)
  */
 export interface EdgeGeometry {
@@ -149,6 +156,11 @@ export interface EdgeGeometry {
    * @see lib/common/types.h:ED_head_label
    */
   headLabel?: { x: number; y: number };
+  /**
+   * `xlabel` (external label) position, if placed.
+   * @see lib/common/types.h:ED_xlabel
+   */
+  xlabel?: { x: number; y: number };
 }
 
 /**
@@ -164,7 +176,15 @@ export interface EdgeGeometry {
  * `class="cluster"` polygon, so a consumer quantizing to SVG precision gets
  * byte-conformant geometry.
  *
+ * `label` is the cluster title's placed position and measured size, present
+ * only when the cluster declares a label. Unlike the edge port labels, it is
+ * *not* gated on the label's `set` flag: C draws a cluster label on existence
+ * alone (emit.c:3920 has no `->set` test, unlike emit_edge_label:2891), so an
+ * unplaced one still renders at whatever pos it holds. Gating here would hide
+ * geometry `render()` acts on.
+ *
  * @see lib/common/types.h:GD_bb (of a cluster subgraph)
+ * @see lib/common/types.h:GD_label (textlabel_t.pos / .dimen)
  */
 export interface ClusterGeometry {
   /** Cluster subgraph name (e.g. `cluster6`); encodes nesting. */
@@ -173,6 +193,13 @@ export interface ClusterGeometry {
   y: number;
   width: number;
   height: number;
+  /**
+   * Cluster label placement, if the cluster has one. `x`/`y` are the **centre**
+   * of the label space (matching `EdgeGeometry.label`, not the box corner
+   * `x`/`y` above); `width`/`height` are its measured size.
+   * @see lib/common/postproc.c:place_graph_label
+   */
+  label?: { x: number; y: number; width: number; height: number };
 }
 
 /**
@@ -286,8 +313,8 @@ function arrowAttachPoints(
 
 /**
  * Snapshot one edge's geometry.
- * @see lib/common/types.h:ED_spl, ED_label, ED_tail_label, ED_head_label
- *   (textlabel_t.pos), bezier.sp/ep
+ * @see lib/common/types.h:ED_spl, ED_label, ED_tail_label, ED_head_label,
+ *   ED_xlabel (textlabel_t.pos), bezier.sp/ep
  */
 function snapshotEdge(edge: Edge, flipY: (y: number) => number): EdgeGeometry {
   const geom: EdgeGeometry = {
@@ -303,6 +330,8 @@ function snapshotEdge(edge: Edge, flipY: (y: number) => number): EdgeGeometry {
   if (tailLabel !== undefined) geom.tailLabel = tailLabel;
   const headLabel = placedLabelPos(edge.info.head_label, flipY);
   if (headLabel !== undefined) geom.headLabel = headLabel;
+  const xlabel = placedLabelPos(edge.info.xlabel, flipY);
+  if (xlabel !== undefined) geom.xlabel = xlabel;
   const { sp, ep } = arrowAttachPoints(edge, flipY);
   if (sp !== undefined) geom.sp = sp;
   if (ep !== undefined) geom.ep = ep;
@@ -316,13 +345,18 @@ function snapshotEdge(edge: Edge, flipY: (y: number) => number): EdgeGeometry {
  * native lower-left corner (ll); `yAxis:'down'` returns the top-left corner
  * (ll.x, flipped ur.y). `width`/`height` are frame-independent (ur - ll).
  *
+ * The label rides in the same call because place_graph_label runs on the same
+ * layout pass that fills GD_bb; `pos` is the centre of the label space, so it
+ * flips like any other coordinate rather than like the box corner.
+ *
  * @see lib/common/types.h:GD_bb (cluster subgraph)
+ * @see lib/common/postproc.c:place_graph_label
  */
 function snapshotCluster(
   sg: Graph, yAxis: YAxis, flipY: (y: number) => number,
 ): ClusterGeometry {
   const bb = sg.info.bb;
-  return {
+  const geom: ClusterGeometry = {
     name: sg.name,
     x: bb.ll.x,
     // 'up' keeps the lower-left y; 'down' flips the upper-right y to the
@@ -331,6 +365,16 @@ function snapshotCluster(
     width: bb.ur.x - bb.ll.x,
     height: bb.ur.y - bb.ll.y,
   };
+  const lab = sg.info.label as TextlabelT | undefined;
+  if (lab !== undefined) {
+    geom.label = {
+      x: lab.pos.x,
+      y: flipY(lab.pos.y),
+      width: lab.dimen.x,
+      height: lab.dimen.y,
+    };
+  }
+  return geom;
 }
 
 /**