@antv/layout 0.3.12 → 1.0.0-alpha.0

package/src/layout/dagre/src/layout.ts

@@ -1,579 +0,0 @@
-import acyclic from "./acyclic";
-import normalize from "./normalize";
-import rank from "./rank";
-import {
-  normalizeRanks,
-  removeEmptyRanks,
-  time as usetime,
-  notime,
-  asNonCompoundGraph,
-  addDummyNode,
-  intersectRect,
-  buildLayerMatrix,
-} from "./util";
-import parentDummyChains from "./parent-dummy-chains";
-import nestingGraph from "./nesting-graph";
-import addBorderSegments from "./add-border-segments";
-import coordinateSystem from "./coordinate-system";
-import order from "./order";
-import position from "./position";
-import initDataOrder from "./order/init-data-order";
-import { Graph, Node } from "../graph";
-
-const layout = (g: Graph, opts?: any) => {
-  const time = opts && opts.debugTiming ? usetime : notime;
-  time("layout", () => {
-    // 如果在原图基础上修改，继承原图的order结果
-    if (opts && !opts.keepNodeOrder && opts.prevGraph) {
-      time("  inheritOrder", () => {
-        inheritOrder(g, opts.prevGraph);
-      });
-    }
-    const layoutGraph: any = time("  buildLayoutGraph", () => {
-      return buildLayoutGraph(g);
-    });
-    // 控制是否为边的label留位置（这会影响是否在边中间添加dummy node）
-    if (!(opts && opts.edgeLabelSpace === false)) {
-      time("  makeSpaceForEdgeLabels", () => {
-        makeSpaceForEdgeLabels(layoutGraph);
-      });
-    }
-    // TODO: 暂时处理层级设置不正确时的异常报错，提示设置正确的层级
-    try {
-      time("  runLayout", () => {
-        runLayout(layoutGraph, time, opts);
-      });
-    } catch (e) {
-      if (
-        e.message ===
-        "Not possible to find intersection inside of the rectangle"
-      ) {
-        console.error(
-          "The following error may be caused by improper layer setting, please make sure your manual layer setting does not violate the graph's structure:\n",
-          e
-        );
-        return;
-      }
-      throw e;
-    }
-    time("  updateInputGraph", () => {
-      updateInputGraph(g, layoutGraph);
-    });
-  });
-};
-
-const runLayout = (g: Graph, time: any, opts: any) => {
-  time("    removeSelfEdges", () => {
-    removeSelfEdges(g);
-  });
-  time("    acyclic", () => {
-    acyclic.run(g);
-  });
-  time("    nestingGraph.run", () => {
-    nestingGraph.run(g);
-  });
-  time("    rank", () => {
-    rank(asNonCompoundGraph(g));
-  });
-  time("    injectEdgeLabelProxies", () => {
-    injectEdgeLabelProxies(g);
-  });
-  time("    removeEmptyRanks", () => {
-    removeEmptyRanks(g);
-  });
-  time("    nestingGraph.cleanup", () => {
-    nestingGraph.cleanup(g);
-  });
-  time("    normalizeRanks", () => {
-    normalizeRanks(g);
-  });
-  time("    assignRankMinMax", () => {
-    assignRankMinMax(g);
-  });
-  time("    removeEdgeLabelProxies", () => {
-    removeEdgeLabelProxies(g);
-  });
-  time("    normalize.run", () => {
-    normalize.run(g);
-  });
-  time("    parentDummyChains", () => {
-    parentDummyChains(g);
-  });
-  time("    addBorderSegments", () => {
-    addBorderSegments(g);
-  });
-  if (opts && opts.keepNodeOrder) {
-    time("    initDataOrder", () => {
-      initDataOrder(g, opts.nodeOrder);
-    });
-  }
-  time("    order", () => {
-    order(g);
-  });
-  time("    insertSelfEdges", () => {
-    insertSelfEdges(g);
-  });
-  time("    adjustCoordinateSystem", () => {
-    coordinateSystem.adjust(g);
-  });
-  time("    position", () => {
-    position(g);
-  });
-  time("    positionSelfEdges", () => {
-    positionSelfEdges(g);
-  });
-  time("    removeBorderNodes", () => {
-    removeBorderNodes(g);
-  });
-  time("    normalize.undo", () => {
-    normalize.undo(g);
-  });
-  time("    fixupEdgeLabelCoords", () => {
-    fixupEdgeLabelCoords(g);
-  });
-  time("    undoCoordinateSystem", () => {
-    coordinateSystem.undo(g);
-  });
-  time("    translateGraph", () => {
-    translateGraph(g);
-  });
-  time("    assignNodeIntersects", () => {
-    assignNodeIntersects(g);
-  });
-  time("    reversePoints", () => {
-    reversePointsForReversedEdges(g);
-  });
-  time("    acyclic.undo", () => {
-    acyclic.undo(g);
-  });
-};
-
-/**
- * 继承上一个布局中的order，防止翻转
- * TODO: 暂时没有考虑涉及层级变动的布局，只保证原来布局层级和相对顺序不变
- */
-const inheritOrder = (currG: Graph, prevG: Graph) => {
-  currG.nodes().forEach((n: string) => {
-    const node = currG.node(n)!;
-    const prevNode = prevG.node(n)!;
-    if (prevNode !== undefined) {
-      node.fixorder = prevNode._order;
-      delete prevNode._order;
-    } else {
-      delete node.fixorder;
-    }
-  });
-};
-
-/*
- * Copies final layout information from the layout graph back to the input
- * graph. This process only copies whitelisted attributes from the layout graph
- * to the input graph, so it serves as a good place to determine what
- * attributes can influence layout.
- */
-const updateInputGraph = (inputGraph: Graph, layoutGraph: Graph) => {
-  inputGraph.nodes().forEach((v) => {
-    const inputLabel = inputGraph.node(v);
-
-    if (inputLabel) {
-      const layoutLabel = layoutGraph.node(v)!;
-      inputLabel.x = layoutLabel.x;
-      inputLabel.y = layoutLabel.y;
-      inputLabel._order = layoutLabel.order;
-      inputLabel._rank = layoutLabel.rank;
-
-      if (layoutGraph.children(v)?.length) {
-        inputLabel.width = layoutLabel.width;
-        inputLabel.height = layoutLabel.height;
-      }
-    }
-  });
-
-  inputGraph.edges().forEach((e) => {
-    const inputLabel = inputGraph.edge(e)!;
-    const layoutLabel = layoutGraph.edge(e)!;
-
-    inputLabel.points = layoutLabel ? layoutLabel.points : [];
-    if (layoutLabel && layoutLabel.hasOwnProperty("x")) {
-      inputLabel.x = layoutLabel.x;
-      inputLabel.y = layoutLabel.y;
-    }
-  });
-
-  inputGraph.graph().width = layoutGraph.graph().width;
-  inputGraph.graph().height = layoutGraph.graph().height;
-};
-
-const graphNumAttrs = ["nodesep", "edgesep", "ranksep", "marginx", "marginy"];
-const graphDefaults = { ranksep: 50, edgesep: 20, nodesep: 50, rankdir: "tb" };
-const graphAttrs = ["acyclicer", "ranker", "rankdir", "align"];
-const nodeNumAttrs = ["width", "height", "layer", "fixorder"]; // 需要传入layer, fixOrder作为参数参考
-const nodeDefaults = { width: 0, height: 0 };
-const edgeNumAttrs = ["minlen", "weight", "width", "height", "labeloffset"];
-const edgeDefaults = {
-  minlen: 1,
-  weight: 1,
-  width: 0,
-  height: 0,
-  labeloffset: 10,
-  labelpos: "r",
-};
-const edgeAttrs = ["labelpos"];
-
-/*
- * Constructs a new graph from the input graph, which can be used for layout.
- * This process copies only whitelisted attributes from the input graph to the
- * layout graph. Thus this function serves as a good place to determine what
- * attributes can influence layout.
- */
-const buildLayoutGraph = (inputGraph: Graph) => {
-  const g = new Graph({ multigraph: true, compound: true });
-  const graph = canonicalize(inputGraph.graph());
-
-  const pickedProperties: any = {};
-  graphAttrs?.forEach((key) => {
-    if (graph[key] !== undefined) pickedProperties[key] = graph[key];
-  });
-
-  g.setGraph(
-    Object.assign(
-      {},
-      graphDefaults,
-      selectNumberAttrs(graph, graphNumAttrs),
-      pickedProperties
-    )
-  );
-
-  inputGraph.nodes().forEach((v) => {
-    const node = canonicalize(inputGraph.node(v));
-    const defaultNode = {
-      ...nodeDefaults,
-      ...node,
-    } as Node;
-    const defaultAttrs = selectNumberAttrs(defaultNode, nodeNumAttrs) as Node;
-
-    g.setNode(v, defaultAttrs);
-    g.setParent(v, inputGraph.parent(v));
-  });
-
-  inputGraph.edges().forEach((e) => {
-    const edge = canonicalize(inputGraph.edge(e));
-
-    const pickedProperties: any = {};
-    edgeAttrs?.forEach((key) => {
-      if (edge[key] !== undefined) pickedProperties[key] = edge[key];
-    });
-
-    g.setEdgeObj(
-      e,
-      Object.assign(
-        {},
-        edgeDefaults,
-        selectNumberAttrs(edge, edgeNumAttrs),
-        pickedProperties
-      )
-    );
-  });
-
-  return g;
-};
-
-/*
- * This idea comes from the Gansner paper: to account for edge labels in our
- * layout we split each rank in half by doubling minlen and halving ranksep.
- * Then we can place labels at these mid-points between nodes.
- *
- * We also add some minimal padding to the width to push the label for the edge
- * away from the edge itself a bit.
- */
-const makeSpaceForEdgeLabels = (g: Graph) => {
-  const graph = g.graph();
-  if (!graph.ranksep) graph.ranksep = 0;
-  graph.ranksep /= 2;
-  g.nodes().forEach((n) => {
-    const node = g.node(n)!;
-    if (!isNaN(node.layer as any)) {
-      if (!node.layer) node.layer = 0;
-    }
-  });
-  g.edges().forEach((e) => {
-    const edge = g.edge(e)!;
-    edge.minlen! *= 2;
-    if (edge.labelpos?.toLowerCase() !== "c") {
-      if (graph.rankdir === "TB" || graph.rankdir === "BT") {
-        edge.width += edge.labeloffset;
-      } else {
-        edge.height += edge.labeloffset;
-      }
-    }
-  });
-};
-
-/*
- * Creates temporary dummy nodes that capture the rank in which each edge's
- * label is going to, if it has one of non-zero width and height. We do this
- * so that we can safely remove empty ranks while preserving balance for the
- * label's position.
- */
-const injectEdgeLabelProxies = (g: Graph) => {
-  g.edges().forEach((e) => {
-    const edge = g.edge(e)!;
-    if (edge.width && edge.height) {
-      const v = g.node(e.v)!;
-      const w = g.node(e.w)!;
-      const label = {
-        e,
-        rank:
-          ((w.rank as number) - (v.rank as number)) / 2 + (v.rank as number),
-      };
-      addDummyNode(g, "edge-proxy", label, "_ep");
-    }
-  });
-};
-
-const assignRankMinMax = (g: Graph) => {
-  let maxRank = 0;
-  g.nodes().forEach((v) => {
-    const node = g.node(v)!;
-    if (node.borderTop) {
-      node.minRank = g.node(node.borderTop)?.rank;
-      node.maxRank = g.node(node.borderBottom)?.rank;
-      maxRank = Math.max(maxRank, node.maxRank || -Infinity);
-    }
-  });
-  g.graph().maxRank = maxRank;
-};
-
-const removeEdgeLabelProxies = (g: Graph) => {
-  g.nodes().forEach((v) => {
-    const node = g.node(v)!;
-    if (node.dummy === "edge-proxy") {
-      g.edge((node as any).e)!.labelRank = node.rank;
-      g.removeNode(v);
-    }
-  });
-};
-
-const translateGraph = (g: Graph) => {
-  let minX: number;
-  let maxX = 0;
-  let minY: number;
-  let maxY = 0;
-  const graphLabel = g.graph();
-  const marginX = graphLabel.marginx || 0;
-  const marginY = graphLabel.marginy || 0;
-
-  const getExtremes = (attrs: any) => {
-    if (!attrs) return;
-    const x = attrs.x;
-    const y = attrs.y;
-    const w = attrs.width;
-    const h = attrs.height;
-    if (!isNaN(x) && !isNaN(w)) {
-      if (minX === undefined) {
-        minX = x - w / 2;
-      }
-      minX = Math.min(minX, x - w / 2);
-      maxX = Math.max(maxX, x + w / 2);
-    }
-    if (!isNaN(y) && !isNaN(h)) {
-      if (minY === undefined) {
-        minY = y - h / 2;
-      }
-      minY = Math.min(minY, y - h / 2);
-      maxY = Math.max(maxY, y + h / 2);
-    }
-  };
-
-  g.nodes().forEach((v) => {
-    getExtremes(g.node(v));
-  });
-  g.edges().forEach((e) => {
-    const edge = g.edge(e)!;
-    if (edge?.hasOwnProperty("x")) {
-      getExtremes(edge);
-    }
-  });
-
-  minX! -= marginX;
-  minY! -= marginY;
-
-  g.nodes().forEach((v) => {
-    const node = g.node(v);
-    if (node) {
-      node.x! -= minX;
-      node.y! -= minY;
-    }
-  });
-
-  g.edges().forEach((e) => {
-    const edge = g.edge(e)!;
-    edge.points?.forEach((p) => {
-      p.x -= minX;
-      p.y -= minY;
-    });
-    if (edge.hasOwnProperty("x")) {
-      edge.x -= minX;
-    }
-    if (edge.hasOwnProperty("y")) {
-      edge.y -= minY;
-    }
-  });
-
-  graphLabel.width = maxX - minX! + marginX;
-  graphLabel.height = maxY - minY! + marginY;
-};
-
-const assignNodeIntersects = (g: Graph) => {
-  g.edges().forEach((e) => {
-    const edge = g.edge(e)!;
-    const nodeV = g.node(e.v)!;
-    const nodeW = g.node(e.w)!;
-    let p1;
-    let p2;
-    if (!edge.points) {
-      edge.points = [];
-      p1 = nodeW;
-      p2 = nodeV;
-    } else {
-      p1 = edge.points[0];
-      p2 = edge.points[edge.points.length - 1];
-    }
-    edge.points.unshift(intersectRect(nodeV, p1));
-    edge.points.push(intersectRect(nodeW, p2));
-  });
-};
-
-const fixupEdgeLabelCoords = (g: Graph) => {
-  g.edges().forEach((e) => {
-    const edge = g.edge(e)!;
-    if (edge?.hasOwnProperty("x")) {
-      if (edge.labelpos === "l" || edge.labelpos === "r") {
-        edge.width! -= edge.labeloffset;
-      }
-      switch (edge.labelpos) {
-        case "l":
-          edge.x -= edge.width! / 2 + edge.labeloffset;
-          break;
-        case "r":
-          edge.x += edge.width! / 2 + edge.labeloffset;
-          break;
-      }
-    }
-  });
-};
-
-const reversePointsForReversedEdges = (g: Graph) => {
-  g.edges().forEach((e) => {
-    const edge = g.edge(e)!;
-    if (edge.reversed) {
-      edge.points?.reverse();
-    }
-  });
-};
-
-const removeBorderNodes = (g: Graph) => {
-  g.nodes().forEach((v) => {
-    if (g.children(v)?.length) {
-      const node = g.node(v)!;
-      const t = g.node(node.borderTop);
-      const b = g.node(node.borderBottom);
-      const l = g.node(node.borderLeft[node.borderLeft?.length - 1]);
-      const r = g.node(node.borderRight[node.borderRight?.length - 1]);
-
-      node.width = Math.abs(r?.x! - l?.x!) || 10;
-      node.height = Math.abs(b?.y! - t?.y!) || 10;
-      node.x = (l?.x || 0) + node.width / 2;
-      node.y = (t?.y || 0) + node.height / 2;
-    }
-  });
-
-  g.nodes().forEach((v) => {
-    if (g.node(v)?.dummy === "border") {
-      g.removeNode(v);
-    }
-  });
-};
-
-const removeSelfEdges = (g: Graph) => {
-  g.edges().forEach((e) => {
-    if (e.v === e.w) {
-      const node = g.node(e.v)!;
-      if (!node.selfEdges) {
-        node.selfEdges = [];
-      }
-      node.selfEdges.push({ e, label: g.edge(e) });
-      g.removeEdgeObj(e);
-    }
-  });
-};
-
-const insertSelfEdges = (g: Graph) => {
-  const layers = buildLayerMatrix(g);
-  layers?.forEach((layer: string[]) => {
-    let orderShift = 0;
-    layer?.forEach((v: string, i: number) => {
-      const node = g.node(v)!;
-      node.order = i + orderShift;
-      node.selfEdges?.forEach((selfEdge: any) => {
-        addDummyNode(
-          g,
-          "selfedge",
-          {
-            width: selfEdge.label.width,
-            height: selfEdge.label.height,
-            rank: node.rank,
-            order: i + ++orderShift,
-            e: selfEdge.e,
-            label: selfEdge.label,
-          },
-          "_se"
-        );
-      });
-      delete node.selfEdges;
-    });
-  });
-};
-
-const positionSelfEdges = (g: Graph) => {
-  g.nodes().forEach((v) => {
-    const node = g.node(v)!;
-    if (node.dummy === "selfedge") {
-      const selfNode = g.node(node.e.v)!;
-      const x = selfNode.x! + selfNode.width! / 2;
-      const y = selfNode.y!;
-      const dx = node.x! - x;
-      const dy = selfNode.height! / 2;
-      g.setEdgeObj(node.e, node.label);
-      g.removeNode(v);
-      node.label.points = [
-        { x: x + (2 * dx) / 3, y: y - dy },
-        { x: x + (5 * dx) / 6, y: y - dy },
-        { y, x: x + dx },
-        { x: x + (5 * dx) / 6, y: y + dy },
-        { x: x + (2 * dx) / 3, y: y + dy },
-      ];
-      node.label.x = node.x;
-      node.label.y = node.y;
-    }
-  });
-};
-
-const selectNumberAttrs = (obj: Record<string, any>, attrs: string[]) => {
-  const pickedProperties: Record<string, any> = {};
-  attrs?.forEach((key: string) => {
-    if (obj[key] === undefined) return;
-    pickedProperties[key] = (+obj[key]);
-  });
-  return pickedProperties;
-};
-
-const canonicalize = (attrs: Record<string, any> = {}) => {
-  const newAttrs: Record<string, any> = {};
-  Object.keys(attrs).forEach((k: string) => {
-    newAttrs[k.toLowerCase()] = attrs[k];
-  });
-  return newAttrs;
-};
-
-export default layout;

package/src/layout/dagre/src/nesting-graph.ts

@@ -1,143 +0,0 @@
-import { Graph } from "../graph";
-import { addBorderNode, addDummyNode } from "./util";
-
-/*
- * A nesting graph creates dummy nodes for the tops and bottoms of subgraphs,
- * adds appropriate edges to ensure that all cluster nodes are placed between
- * these boundries, and ensures that the graph is connected.
- *
- * In addition we ensure, through the use of the minlen property, that nodes
- * and subgraph border nodes to not end up on the same rank.
- *
- * Preconditions:
- *
- *    1. Input graph is a DAG
- *    2. Nodes in the input graph has a minlen attribute
- *
- * Postconditions:
- *
- *    1. Input graph is connected.
- *    2. Dummy nodes are added for the tops and bottoms of subgraphs.
- *    3. The minlen attribute for nodes is adjusted to ensure nodes do not
- *       get placed on the same rank as subgraph border nodes.
- *
- * The nesting graph idea comes from Sander, "Layout of Compound Directed
- * Graphs."
- */
-const run = (g: Graph) => {
-  const root = addDummyNode(g, "root", {}, "_root");
-  const depths = treeDepths(g);
-  let maxDepth = Math.max(...Object.values(depths));
-  
-  if (Math.abs(maxDepth) === Infinity) {
-    maxDepth = 1;
-  }
-
-  const height = maxDepth - 1; // Note: depths is an Object not an array
-  const nodeSep = 2 * height + 1;
-
-  g.graph().nestingRoot = root;
-
-  // Multiply minlen by nodeSep to align nodes on non-border ranks.
-  g.edges().forEach((e) => {
-    g.edge(e)!.minlen! *= nodeSep;
-  });
-
-  // Calculate a weight that is sufficient to keep subgraphs vertically compact
-  const weight = sumWeights(g) + 1;
-
-  // Create border nodes and link them up
-  g.children()?.forEach((child) => {
-    dfs(g, root, nodeSep, weight, height, depths, child);
-  });
-
-  // Save the multiplier for node layers for later removal of empty border
-  // layers.
-  g.graph().nodeRankFactor = nodeSep;
-};
-
-const dfs = (
-  g: Graph,
-  root: string,
-  nodeSep: number,
-  weight: number,
-  height: number,
-  depths:Record<string, number>,
-  v: string
-) => {
-  const children = g.children(v);
-  if (!children?.length) {
-    if (v !== root) {
-      g.setEdge(root, v, { weight: 0, minlen: nodeSep });
-    }
-    return;
-  }
-
-  const top = addBorderNode(g, "_bt");
-  const bottom = addBorderNode(g, "_bb");
-  const label = g.node(v)!;
-
-  g.setParent(top, v);
-  label.borderTop = top;
-  g.setParent(bottom, v);
-  label.borderBottom = bottom;
-
-  children?.forEach((child) => {
-    dfs(g, root, nodeSep, weight, height, depths, child);
-
-    const childNode = g.node(child)!;
-    const childTop = childNode.borderTop ? childNode.borderTop : child;
-    const childBottom = childNode.borderBottom ? childNode.borderBottom : child;
-    const thisWeight = childNode.borderTop ? weight : 2 * weight;
-    const minlen = childTop !== childBottom ? 1 : height - depths[v] + 1;
-
-    g.setEdge(top, childTop, {
-      minlen,
-      weight: thisWeight,
-      nestingEdge: true,
-    });
-
-    g.setEdge(childBottom, bottom, {
-      minlen,
-      weight: thisWeight,
-      nestingEdge: true,
-    });
-  });
-
-  if (!g.parent(v)) {
-    g.setEdge(root, top, { weight: 0, minlen: height + depths[v] });
-  }
-};
-
-const treeDepths = (g: Graph) => {
-  const depths: Record<string, number> = {};
-  const dfs = (v: string, depth: number) => {
-    const children = g.children(v);
-    children?.forEach((child) => dfs(child, depth + 1));
-    depths[v] = depth;
-  };
-  g.children()?.forEach((v) => dfs(v, 1));
-  return depths;
-};
-
-const sumWeights = (g: Graph) => {
-  let result = 0;
-  g.edges().forEach((e) => {
-    result += g.edge(e)!.weight!;
-  });
-  return result;
-};
-
-const cleanup = (g: Graph) => {
-  const graphLabel = g.graph();
-  graphLabel.nestingRoot && g.removeNode(graphLabel.nestingRoot);
-  delete graphLabel.nestingRoot;
-  g.edges().forEach((e: any) => {
-    const edge = g.edge(e)!;
-    if (edge.nestingEdge) {
-      g.removeEdgeObj(e);
-    }
-  });
-};
-
-export default { run, cleanup };