@antv/layout 0.3.11 → 1.0.0-alpha.0

package/src/layout/forceAtlas2/body.ts

@@ -1,115 +0,0 @@
-import Quad from './quad';
-
-/**
- * @fileOverview body
- * @author shiwu.wyy@antfin.com
- */
-
-type BodyProps = {
-  id?: Number;
-  rx: number;
-  ry: number;
-  fx?: number;
-  fy?: number;
-  mass: number;
-  degree: number;
-  g?: number;
-};
-
-// represents a body(a point mass) and its position
-export default class Body {
-  public id: Number;
-  public rx: number;
-  public ry: number;
-  public fx: number;
-  public fy: number;
-  public mass: number;
-  public degree: number;
-  public g: number;
-  
-  constructor(params: BodyProps) {
-    /**
-     * the id of this body, the same with the node id
-     * @type  {number}
-     */
-    this.id = params.id || 0;
-    /**
-     * the position of this body
-     * @type  {number}
-     */
-    this.rx = params.rx;
-    /**
-     * the position of this body
-     * @type  {number}
-     */
-    this.ry = params.ry;
-    /**
-     * the force acting on this body
-     * @type  {number}
-     */
-    this.fx = 0;
-    /**
-     * the force acting on this body
-     * @type  {number}
-     */
-    this.fy = 0;
-    /**
-     * the mass of this body, =1 for a node
-     * @type  {number}
-     */
-    this.mass = params.mass;
-    /**
-     * the degree of the node represented by this body
-     * @type  {number}
-     */
-    this.degree = params.degree;
-    /**
-     * the parameter for repulsive force, = kr
-     * @type  {number}
-     */
-    this.g = params.g || 0;
-  }
-  // returns the euclidean distance
-  distanceTo(bo: Body) {
-    const dx = this.rx - bo.rx;
-    const dy = this.ry - bo.ry;
-    return Math.hypot(dx, dy);
-  }
-  setPos(x: number, y: number) {
-    this.rx = x;
-    this.ry = y;
-  }
-  // resets the forces
-  resetForce() {
-    this.fx = 0;
-    this.fy = 0;
-  }
-  addForce(b: Body) {
-    const dx = b.rx - this.rx;
-    const dy = b.ry - this.ry;
-    let dist = Math.hypot(dx, dy);
-    dist = dist < 0.0001 ? 0.0001 : dist;
-    // the repulsive defined by force atlas 2
-    const F = (this.g * (this.degree + 1) * (b.degree + 1)) / dist;
-    this.fx += F * dx / dist;
-    this.fy += F * dy / dist;
-  }
-  // if quad contains this body
-  in(quad: Quad) {
-    return quad.contains(this.rx, this.ry);
-  }
-  // returns a new body
-  add(bo: Body) {
-    const nenwMass = this.mass + bo.mass;
-    const x = (this.rx * this.mass + bo.rx * bo.mass) / nenwMass;
-    const y = (this.ry * this.mass + bo.ry * bo.mass) / nenwMass;
-    const dg = this.degree + bo.degree;
-    const params: BodyProps = {
-      rx: x,
-      ry: y,
-      mass: nenwMass,
-      degree: dg
-    };
-    return new Body(params);
-  }
-}

package/src/layout/forceAtlas2/index.ts

@@ -1,556 +0,0 @@
-/**
- * @fileOverview force atlas 2
- * @author shiwu.wyy@antfin.com
- */
-import { PointTuple, OutNode, Edge, ForceAtlas2LayoutOptions } from "../types";
-import { Base } from "../base";
-import { getEdgeTerminal, isArray, isNumber, isObject } from "../../util";
-import Body from './body';
-import Quad from './quad';
-import QuadTree from './quadTree';
-
-export class ForceAtlas2Layout extends Base {
-  /** 布局中心 */
-  public center: PointTuple = [0, 0];
-
-  /** 宽度 */
-  public width: number = 300;
-
-  /** 高度 */
-  public height: number = 300;
-
-  public nodes: OutNode[] = [];
-
-  public edges: Edge[] = [];
-
-  /**
-   * the parameter for repulsive forces,
-   * it will scale the layout but won't change the layout
-   * larger the kr, looser the layout
-   * @type  {number}
-   */
-  public kr: number = 5;
-
-  /**
-   * the parameter for gravity forces
-   * @type  {number}
-   */
-  public kg: number = 1;
-
-  /**
-   * modes:
-   * 'normal' for normal using
-   * 'linlog' for compact clusters.
-   * @type  {string}
-   */
-  public mode: 'normal' | 'linlog' = 'normal';
-
-  /**
-   * whether preventing the node overlapping
-   * @type  {boolean}
-   */
-  public preventOverlap: boolean = false;
-
-  /**
-   * whether active the dissuade hub mode
-   * true: grant authorities (nodes with a high indegree)
-   * a more central position than hubs (nodes with a high outdegree)
-   * @type  {boolean}
-   */
-  public dissuadeHubs: boolean = false;
-
-  /**
-   * whether active the barnes hut optimization on computing repulsive forces
-   * @type  {boolean}
-   */
-  public barnesHut: boolean | undefined = undefined;
-
-  /**
-   * the max iteration number
-   * @type  {number}
-   */
-  public maxIteration: number = 0;
-
-  /**
-   * control the global velocity
-   * defualt: 0.1(gephi)
-   * @type  {number}
-   */
-  public ks: number = 0.1;
-
-  /**
-   * the max global velocity
-   * @type  {number}
-   */
-  public ksmax: number = 10;
-
-  /**
-   * the tolerance for the global swinging
-   * @type  {number}
-   */
-  public tao: number = 0.1;
-
-  /**
-   * the function of layout complete listener, display the legend and minimap after layout
-   * @type  {function}
-   */
-  public onLayoutEnd: () => void = () => {};
-
-  public tick: () => void;
-
-  /**
-   * activate prune or not.
-   * prune the leaves during most iterations, layout the leaves in the last 50 iteraitons.
-   * if prune === '', it will be activated when the nodes number > 100
-   * note that it will reduce the quality of the layout
-   * @type  {boolean}
-   */
-  public prune: boolean | undefined = undefined;
-
-  public getWidth: (node: any) => number;
-  public getHeight: (node: any) => number;
-
-  constructor(options?: ForceAtlas2LayoutOptions) {
-    super();
-    this.updateCfg(options);
-  }
-
-  public getDefaultCfg() {
-    return {};
-  }
-
-  // execute the layout
-  public execute() {
-    const self = this;
-    const {
-      nodes,
-      onLayoutEnd,
-      prune,
-    } = self;
-    let maxIteration = self.maxIteration;
-
-    if (!self.width && typeof window !== "undefined") {
-      self.width = window.innerWidth;
-    }
-    if (!self.height && typeof window !== "undefined") {
-      self.height = window.innerHeight;
-    }
-
-    // the whidth of each nodes
-    const sizes = [];
-    const nodeNum = nodes.length;
-    for (let i = 0; i < nodeNum; i += 1) {
-      const node = nodes[i] as any;
-      let nodeWidth = 10;
-      let nodeHeight = 10;
-      if (isNumber(node.size)) {
-        nodeWidth = node.size;
-        nodeHeight = node.size;
-      }
-      if (isArray(node.size))  {
-        if (!isNaN(node.size[0])) nodeWidth = node.size[0];
-        if (!isNaN(node.size[1])) nodeHeight = node.size[1];
-      } else if (isObject(node.size)) {
-        nodeWidth = node.size.width;
-        nodeHeight = node.size.height;
-      }
-      if (self.getWidth && !isNaN(self.getWidth(node))) nodeHeight = self.getWidth(node);
-      if (self.getHeight && !isNaN(self.getHeight(node))) nodeWidth = self.getHeight(node);
-
-      const maxSize = Math.max(nodeWidth, nodeHeight);
-      sizes.push(maxSize);
-    }
-
-    if (self.barnesHut === undefined && nodeNum > 250) self.barnesHut = true;
-    if (self.prune === undefined && nodeNum > 100) self.prune = true;
-    if (this.maxIteration === 0 && !self.prune) {
-      maxIteration = 250;
-      if (nodeNum <= 200 && nodeNum > 100) maxIteration = 1000;
-      else if (nodeNum > 200) maxIteration = 1200;
-      this.maxIteration = maxIteration;
-    } else if (this.maxIteration === 0 && prune) {
-      maxIteration = 100;
-      if (nodeNum <= 200 && nodeNum > 100) maxIteration = 500;
-      else if (nodeNum > 200) maxIteration = 950;
-      this.maxIteration = maxIteration;
-    }
-
-    if (!self.kr) {
-      self.kr = 50;
-      if (nodeNum > 100 && nodeNum <= 500) self.kr = 20;
-      else if (nodeNum > 500) self.kr = 1;
-    }
-    if (!self.kg) {
-      self.kg = 20;
-      if (nodeNum > 100 && nodeNum <= 500) self.kg = 10;
-      else if (nodeNum > 500) self.kg = 1;
-    }
-    this.nodes = self.updateNodesByForces(sizes);
-    onLayoutEnd();
-  }
-
-
-  updateNodesByForces(sizes: number[]) {
-    const self = this;
-    const { edges, maxIteration } = self;
-    let nodes = self.nodes;
-
-    const nonLoopEdges = edges.filter((edge: any) => {
-      const source = getEdgeTerminal(edge, 'source');
-      const target = getEdgeTerminal(edge, 'target');
-      return source !== target;
-    });
-    const size = nodes.length;
-    const esize = nonLoopEdges.length;
-
-    const degrees = [];
-    const idMap: {[key: string]: number} = {};
-    const edgeEndsIdMap: {[key: number]: {sourceIdx: number, targetIdx: number}} = {};
-
-    // tslint:disable-next-line
-    const Es = []
-    for (let i = 0; i < size; i += 1) {
-      idMap[nodes[i].id] = i;
-      degrees[i] = 0;
-      if (nodes[i].x === undefined || isNaN(nodes[i].x)) { nodes[i].x = Math.random() * 1000; }
-      if (nodes[i].y === undefined || isNaN(nodes[i].y)) { nodes[i].y = Math.random() * 1000; }
-      Es.push({ x: nodes[i].x, y: nodes[i].y });
-    }
-    for (let i = 0; i < esize; i += 1) {
-      let node1;
-      let node2;
-      let sIdx = 0;
-      let tIdx = 0;
-
-      for (let j = 0; j < size; j += 1) {
-        const source = getEdgeTerminal(nonLoopEdges[i], 'source');
-        const target = getEdgeTerminal(nonLoopEdges[i], 'target');
-        if (nodes[j].id === source) {
-          node1 = nodes[j];
-          sIdx = j;
-        } else if (nodes[j].id === target) {
-          node2 = nodes[j];
-          tIdx = j;
-        }
-        edgeEndsIdMap[i] = { sourceIdx: sIdx, targetIdx: tIdx };
-      }
-      if (node1) degrees[idMap[node1.id]] += 1;
-      if (node2) degrees[idMap[node2.id]] += 1;
-    }
-
-    let iteration = maxIteration;
-    nodes = this.iterate(iteration, idMap, edgeEndsIdMap, esize, degrees, sizes);
-
-    // if prune, place the leaves around their parents, and then re-layout for several iterations.
-    if (self.prune) {
-      for (let j = 0; j < esize; j += 1) {
-        if (degrees[edgeEndsIdMap[j].sourceIdx] <= 1) {
-          nodes[edgeEndsIdMap[j].sourceIdx].x = nodes[edgeEndsIdMap[j].targetIdx].x;
-          nodes[edgeEndsIdMap[j].sourceIdx].y = nodes[edgeEndsIdMap[j].targetIdx].y;
-
-        } else if (degrees[edgeEndsIdMap[j].targetIdx] <= 1) {
-          nodes[edgeEndsIdMap[j].targetIdx].x = nodes[edgeEndsIdMap[j].sourceIdx].x;
-          nodes[edgeEndsIdMap[j].targetIdx].y = nodes[edgeEndsIdMap[j].sourceIdx].y;
-        }
-      }
-      self.prune = false;
-      self.barnesHut = false;
-      iteration = 100;
-      nodes = this.iterate(
-        iteration,
-        idMap,
-        edgeEndsIdMap,
-        esize,
-        degrees,
-        sizes
-        );
-    }
-    return nodes;
-  }
-  iterate(
-    iteration: number,
-    idMap: {[key: string]: number},
-    edgeEndsIdMap: {[key: number]: {sourceIdx: number, targetIdx: number}},
-    esize: number,
-    degrees: number[],
-    sizes: number[],
-  ) {
-
-    const self = this;
-    let { nodes } = self;
-    const { kr, preventOverlap } = self;
-    const { barnesHut } = self;
-
-    const nodeNum = nodes.length;
-    let sg = 0;
-    const krPrime = 100;
-    let iter = iteration;
-    const prevoIter = 50;
-    let forces = [];
-    const preForces = [];
-    const bodies = [];
-
-    for (let i = 0; i < nodeNum; i += 1) {
-      forces[2 * i] = 0;
-      forces[2 * i + 1] = 0;
-
-      if (barnesHut) {
-        const params = {
-          id: i,
-          rx: nodes[i].x,
-          ry: nodes[i].y,
-          mass: 1,
-          g: kr,
-          degree: degrees[i]
-        };
-        bodies[i] = new Body(params);
-      }
-    }
-
-    while (iter > 0) {
-      for (let i = 0; i < nodeNum; i += 1) {
-        preForces[2 * i] = forces[2 * i];
-        preForces[2 * i + 1] = forces[2 * i + 1];
-        forces[2 * i] = 0;
-        forces[2 * i + 1] = 0;
-      }
-        // attractive forces, existing on every actual edge
-      forces = this.getAttrForces(
-        iter,
-        prevoIter,
-        esize, 
-        idMap,
-        edgeEndsIdMap,
-        degrees,
-        sizes,
-        forces
-      );
-
-      // repulsive forces and Gravity, existing on every node pair
-      // if preventOverlap, using the no-optimized method in the last prevoIter instead.
-      if (barnesHut && ((preventOverlap && iter > prevoIter) || !preventOverlap)) {
-        forces = this.getOptRepGraForces(forces, bodies, degrees);
-      } else {
-        forces = this.getRepGraForces(iter, prevoIter, forces, krPrime, sizes, degrees);
-      }
-      // update the positions
-      const res = this.updatePos(forces, preForces, sg, degrees);
-      nodes = res.nodes;
-      sg = res.sg;
-      iter --;
-      if (self.tick) self.tick();
-    }
-
-    return nodes;
-  }
-  getAttrForces(
-    iter: number,
-    prevoIter: number,
-    esize: number, 
-    idMap: {[key: string]: number},
-    edgeEndsIdMap: {[key: number]: {sourceIdx: number, targetIdx: number}},
-    degrees: number[],
-    sizes: number[],
-    forces: number[],
-  ): number[] {
-    const self = this;
-    const { nodes, preventOverlap, dissuadeHubs, mode, prune } = self;
-    for (let i = 0; i < esize; i += 1) {
-      const sourceNode = nodes[edgeEndsIdMap[i].sourceIdx];
-      const sourceIdx = edgeEndsIdMap[i].sourceIdx;
-      const targetNode = nodes[edgeEndsIdMap[i].targetIdx];
-      const targetIdx = edgeEndsIdMap[i].targetIdx;
-
-      if (prune && (degrees[sourceIdx] <= 1 || degrees[targetIdx] <= 1)) continue;
-
-      const dir = [ targetNode.x - sourceNode.x, targetNode.y - sourceNode.y ];
-      let eucliDis = Math.hypot(dir[0], dir[1]);
-      eucliDis = eucliDis < 0.0001 ? 0.0001 : eucliDis;
-      dir[0] = dir[0] / eucliDis;
-      dir[1] = dir[1] / eucliDis;
-
-      if (preventOverlap && iter < prevoIter) eucliDis = eucliDis - sizes[sourceIdx] - sizes[targetIdx];
-      let Fa1 = eucliDis // tslint:disable-line
-      let Fa2 = Fa1 // tslint:disable-line
-      if (mode === 'linlog') {
-        Fa1 = Math.log(1 + eucliDis);
-        Fa2 = Fa1;
-      }
-      if (dissuadeHubs) {
-        Fa1 = eucliDis / degrees[sourceIdx];
-        Fa2 = eucliDis / degrees[targetIdx];
-      }
-      if (preventOverlap && iter < prevoIter && eucliDis <= 0) {
-        Fa1 = 0;
-        Fa2 = 0;
-      } else if (preventOverlap && iter < prevoIter && eucliDis > 0) {
-        Fa1 = eucliDis;
-        Fa2 = eucliDis;
-      }
-      forces[2 * idMap[sourceNode.id]] += Fa1 * dir[0];
-      forces[2 * idMap[targetNode.id]] -= Fa2 * dir[0];
-      forces[2 * idMap[sourceNode.id] + 1] += Fa1 * dir[1];
-      forces[2 * idMap[targetNode.id] + 1] -= Fa2 * dir[1];
-    }
-    return forces;
-  }
-  getRepGraForces(iter: number, prevoIter: number, forces: number[], krPrime: number, sizes: number[], degrees: number[]) {
-    const self = this;
-    const { nodes, preventOverlap, kr, kg, center, prune } = self;
-    const nodeNum = nodes.length;
-    for (let i = 0; i < nodeNum; i += 1) {
-      for (let j = i + 1; j < nodeNum; j += 1) {
-
-        if (prune && (degrees[i] <= 1 || degrees[j] <= 1)) continue;
-
-        const dir = [ nodes[j].x - nodes[i].x, nodes[j].y - nodes[i].y ];
-        let eucliDis = Math.hypot(dir[0], dir[1]);
-        eucliDis = eucliDis < 0.0001 ? 0.0001 : eucliDis;
-        dir[0] = dir[0] / eucliDis;
-        dir[1] = dir[1] / eucliDis;
-
-        if (preventOverlap && iter < prevoIter) eucliDis = eucliDis - sizes[i] - sizes[j];
-
-        let Fr = kr * (degrees[i] + 1) * (degrees[j] + 1) / eucliDis // tslint:disable-line
-
-        if (preventOverlap && iter < prevoIter && eucliDis < 0) {
-          Fr = krPrime * (degrees[i] + 1) * (degrees[j] + 1);
-        } else if (preventOverlap && iter < prevoIter && eucliDis === 0) {
-          Fr = 0;
-        } else if (preventOverlap && iter < prevoIter && eucliDis > 0) {
-          Fr = kr * (degrees[i] + 1) * (degrees[j] + 1) / eucliDis;
-        }
-        forces[2 * i] -= Fr * dir[0];
-        forces[2 * j] += Fr * dir[0];
-        forces[2 * i + 1] -= Fr * dir[1];
-        forces[2 * j + 1] += Fr * dir[1];
-      }
-
-    // gravity
-      const dir = [ nodes[i].x - center[0], nodes[i].y - center[1] ];
-      const eucliDis = Math.hypot(dir[0], dir[1]);
-      dir[0] = dir[0] / eucliDis;
-      dir[1] = dir[1] / eucliDis;
-      const Fg = kg * (degrees[i] + 1) // tslint:disable-line
-      forces[2 * i] -= Fg * dir[0];
-      forces[2 * i + 1] -= Fg * dir[1];
-    }
-    return forces;
-  }
-
-  getOptRepGraForces(forces: number[], bodies: any, degrees: number[]) {
-    const self = this;
-    const { nodes, kg, center, prune } = self;
-    const nodeNum = nodes.length;
-    let minx = 9e10;
-    let maxx = -9e10;
-    let miny = 9e10;
-    let maxy = -9e10;
-    for (let i = 0; i < nodeNum; i += 1) {
-      if (prune && (degrees[i] <= 1)) continue;
-      bodies[i].setPos(nodes[i].x, nodes[i].y);
-      if (nodes[i].x >= maxx) maxx = nodes[i].x;
-      if (nodes[i].x <= minx) minx = nodes[i].x;
-      if (nodes[i].y >= maxy) maxy = nodes[i].y;
-      if (nodes[i].y <= miny) miny = nodes[i].y;
-    }
-
-    const width = Math.max(maxx - minx, maxy - miny);
-
-    const quadParams = {
-      xmid: (maxx + minx) / 2,
-      ymid: (maxy + miny) / 2,
-      length: width,
-      massCenter: center,
-      mass: nodeNum
-    };
-    const quad = new Quad(quadParams);
-    const quadTree = new QuadTree(quad);
-
-  // build the tree, insert the nodes(quads) into the tree
-    for (let i = 0; i < nodeNum; i += 1) {
-
-      if (prune && (degrees[i] <= 1)) continue;
-
-      if (bodies[i].in(quad)) quadTree.insert(bodies[i]);
-    }
-  // update the repulsive forces and the gravity.
-    for (let i = 0; i < nodeNum; i += 1) {
-
-      if (prune && (degrees[i] <= 1)) continue;
-
-      bodies[i].resetForce();
-      quadTree.updateForce(bodies[i]);
-      forces[2 * i] -= bodies[i].fx;
-      forces[2 * i + 1] -= bodies[i].fy;
-
-    // gravity
-      const dir = [ nodes[i].x - center[0], nodes[i].y - center[1] ];
-      let eucliDis = Math.hypot(dir[0], dir[1]);
-      eucliDis = eucliDis < 0.0001 ? 0.0001 : eucliDis;
-      dir[0] = dir[0] / eucliDis;
-      dir[1] = dir[1] / eucliDis;
-      const Fg = kg * (degrees[i] + 1) // tslint:disable-line
-      forces[2 * i] -= Fg * dir[0];
-      forces[2 * i + 1] -= Fg * dir[1];
-    }
-    return forces;
-  }
-
-  updatePos(
-    forces: number[],
-    preForces: number[],
-    sg: number,
-    degrees: number[]
-  ): { nodes: any, sg: number } {
-    const self = this;
-    const { nodes, ks, tao, prune, ksmax } = self;
-    const nodeNum = nodes.length;
-    const swgns = [];
-    const trans = [];
-  // swg(G) and tra(G)
-    let swgG = 0;
-    let traG = 0;
-    for (let i = 0; i < nodeNum; i += 1) {
-
-      if (prune && (degrees[i] <= 1)) continue;
-
-      const minus = [ forces[2 * i] - preForces[2 * i],
-        forces[2 * i + 1] - preForces[2 * i + 1]
-      ];
-      const minusNorm = Math.hypot(minus[0], minus[1]);
-      const add = [ forces[2 * i] + preForces[2 * i],
-        forces[2 * i + 1] + preForces[2 * i + 1]
-      ];
-      const addNorm = Math.hypot(add[0], add[1]);
-
-      swgns[i] = minusNorm;
-      trans[i] = addNorm / 2;
-
-      swgG += (degrees[i] + 1) * swgns[i];
-      traG += (degrees[i] + 1) * trans[i];
-    }
-
-    const preSG = sg;
-    sg = tao * traG / swgG // tslint:disable-line
-    if (preSG !== 0) {
-      sg = sg > (1.5 * preSG) ? (1.5 * preSG) : sg // tslint:disable-line
-    }
-    // update the node positions
-    for (let i = 0; i < nodeNum; i += 1) {
-      if (prune && (degrees[i] <= 1)) continue;
-      if (isNumber(nodes[i].fx) && isNumber(nodes[i].fy)) continue;
-
-      let sn = ks * sg / (1 + sg * Math.sqrt(swgns[i]));
-      let absForce = Math.hypot(forces[2 * i], forces[2 * i + 1]);
-      absForce = absForce < 0.0001 ? 0.0001 : absForce;
-      const max = ksmax / absForce;
-      sn = sn > max ? max : sn;
-      const dnx = sn * forces[2 * i];
-      const dny = sn * forces[2 * i + 1];
-      nodes[i].x += dnx;
-      nodes[i].y += dny;
-    }
-    return { nodes, sg };
-  }
-}