@antv/layout 0.3.11 → 1.0.0-alpha.0

package/lib/Circular.d.ts

@@ -0,0 +1,40 @@
+import type { Graph } from "@antv/graphlib";
+import type { CircularLayoutOptions, SyncLayout, LayoutMapping, PointTuple, OutNode } from "./types";
+type INodeData = OutNode & {
+    degree: number;
+    size: number | PointTuple;
+    weight: number;
+    children: string[];
+    parent: string[];
+};
+type IEdgeData = {};
+/**
+ * Layout arranging the nodes in a circle.
+ *
+ * @example
+ * // Assign layout options when initialization.
+ * const layout = new CircularLayout({ radius: 10 });
+ * const positions = layout.execute(graph); // { nodes: [], edges: [] }
+ *
+ * // Or use different options later.
+ * const layout = new CircularLayout({ radius: 10 });
+ * const positions = layout.execute(graph, { radius: 20 }); // { nodes: [], edges: [] }
+ *
+ * // If you want to assign the positions directly to the nodes, use assign method.
+ * layout.assign(graph, { radius: 20 });
+ */
+export declare class CircularLayout implements SyncLayout<CircularLayoutOptions> {
+    options: CircularLayoutOptions;
+    id: string;
+    constructor(options?: CircularLayoutOptions);
+    /**
+     * Return the positions of nodes and edges(if needed).
+     */
+    execute(graph: Graph<INodeData, IEdgeData>, options?: CircularLayoutOptions): LayoutMapping;
+    /**
+     * To directly assign the positions to the nodes.
+     */
+    assign(graph: Graph<INodeData, IEdgeData>, options?: CircularLayoutOptions): void;
+    private genericCircularLayout;
+}
+export {};

package/lib/Supervisor.d.ts

@@ -0,0 +1,65 @@
+import EventEmitter from 'eventemitter3';
+import { Graph, Node, Edge } from "@antv/graphlib";
+import type { SyncLayout } from "./types";
+/**
+ * The payload transferred from main thread to the worker.
+ */
+export interface Payload {
+    layout: {
+        id: string;
+        options: any;
+    };
+    nodes: Node<any>[];
+    edges: Edge<any>[];
+}
+export declare const SupervisorEvent: {
+    /**
+     * Get triggerred when each iteration finished.
+     */
+    LAYOUT_ITERATION: string;
+    /**
+     * Get triggerred when layout calculation is done.
+     */
+    LAYOUT_END: string;
+};
+/**
+ * @example
+ * const graph = new Graph();
+ * const layout = new CircularLayout();
+ *
+ * const supervisor = new Supervisor(graph, layout, { auto: true });
+ * supervisor.start();
+ * supervisor.stop();
+ * supervisor.kill();
+ *
+ * // lifecycle
+ * supervisor.on('tick', () => {
+ * });
+ * supervisor.on('layoutend', () => {
+ * });
+ *
+ * // Re-layout when graph changed.
+ * graph.addNodes([{ id: 'node1' }, { id: 'node2' }]);
+ *
+ * // TODO: Custom layout.
+ */
+export declare class Supervisor extends EventEmitter {
+    private graph;
+    private layout;
+    /**
+     * Internal worker.
+     */
+    private worker;
+    /**
+     * Flag of running state.
+     */
+    private running;
+    constructor(graph: Graph<any, any>, layout: SyncLayout<any>, options: {
+        auto: boolean;
+    });
+    spawnWorker(): void;
+    start(): this;
+    stop(): this;
+    kill(): void;
+    isRunning(): boolean;
+}

package/lib/index.d.ts

@@ -1,3 +1,3 @@
-import { registerLayout, unRegisterLayout, getLayoutByName } from "./registy";
-export { registerLayout, unRegisterLayout, getLayoutByName };
-export * from "./layout";
+export * from "./circular";
+export * from "./supervisor";
+export * from "./registry";

package/lib/registry.d.ts

@@ -0,0 +1,3 @@
+import type { SyncLayoutConstructor } from "./types";
+export declare const registry: Record<string, SyncLayoutConstructor<any>>;
+export declare function registerLayout(id: string, layout: SyncLayoutConstructor<any>): void;

package/lib/types.d.ts

@@ -0,0 +1,128 @@
+import type { Graph, PlainObject } from "@antv/graphlib";
+export interface Node extends PlainObject {
+    id: string;
+}
+export interface OutNode extends Node {
+    x: number;
+    y: number;
+    fx?: number;
+    fy?: number;
+    comboId?: string;
+    layer?: number;
+    _order?: number;
+    layout?: boolean;
+    size?: number | number[] | undefined;
+}
+export interface Edge {
+    source: string;
+    target: string;
+}
+export interface Combo {
+    id: string;
+    parentId?: string;
+    x?: number;
+    y?: number;
+    name?: string | number;
+    cx?: number;
+    cy?: number;
+    count?: number;
+    depth?: number;
+    children?: any[];
+    empty?: boolean;
+    minX?: number;
+    maxX?: number;
+    minY?: number;
+    maxY?: number;
+    size?: number;
+    r?: number;
+    itemType?: string;
+    collapsed?: boolean;
+}
+export interface Model {
+    nodes?: Node[];
+    edges?: Edge[];
+    combos?: Combo[];
+    comboEdges?: Edge[];
+    hiddenNodes?: Node[];
+    hiddenEdges?: Edge[];
+    hiddenCombos?: Combo[];
+    vedges?: Edge[];
+}
+export interface OutModel extends Model {
+    nodes?: OutNode[];
+}
+export interface Size {
+    width: number;
+    height: number;
+}
+export type IndexMap = {
+    [key: string]: number;
+};
+export type INode = OutNode & {
+    degree: number;
+    size: number | PointTuple;
+};
+export type NodeMap = {
+    [key: string]: INode;
+};
+export type Matrix = number[];
+export type Point = {
+    x: number;
+    y: number;
+};
+export type Degree = {
+    in: number;
+    out: number;
+    all: number;
+};
+export interface ComboTree {
+    id: string;
+    children?: ComboTree[];
+    depth?: number;
+    parentId?: string;
+    itemType?: "node" | "combo";
+    [key: string]: unknown;
+}
+export interface ComboConfig {
+    id: string;
+    parentId?: string;
+    children?: ComboTree[];
+    depth?: number;
+}
+export type PointTuple = [number, number];
+export type LayoutMapping = {
+    nodes: OutNode[];
+    edges: Edge[];
+};
+export interface SyncLayout<LayoutOptions> {
+    assign(graph: Graph<any, any>, options?: LayoutOptions): void;
+    execute(graph: Graph<any, any>, options?: LayoutOptions): LayoutMapping;
+    options: LayoutOptions;
+    id: string;
+}
+export interface SyncLayoutConstructor<LayoutOptions> {
+    new (options?: LayoutOptions): SyncLayout<LayoutOptions>;
+}
+export interface LayoutSupervisor {
+    start(): void;
+    stop(): void;
+    kill(): void;
+}
+export interface CircularLayoutOptions {
+    center?: PointTuple;
+    width?: number;
+    height?: number;
+    radius?: number | null;
+    startRadius?: number | null;
+    endRadius?: number | null;
+    clockwise?: boolean;
+    divisions?: number;
+    ordering?: "topology" | "topology-directed" | "degree" | null;
+    angleRatio?: number;
+    workerEnabled?: boolean;
+    startAngle?: number;
+    endAngle?: number;
+    nodeSpacing?: ((d?: unknown) => number) | number;
+    nodeSize?: number;
+    onLayoutEnd?: () => void;
+}

package/lib/util/gpu.d.ts

@@ -1,4 +1,4 @@
-import { OutNode, Edge } from '../layout/types';
+import { OutNode, Edge } from "../types";
 /**
  * 将 number | Function 类型的参数转换为 return number 的 Function
  * @param  {number | Function}  value 需要被转换的值
@@ -17,36 +17,36 @@ export declare const buildTextureData: (nodes: OutNode[], edges: Edge[]) => {
     maxEdgePerVetex: number;
 };
 /**
-* 将节点和边数据转换为 GPU 可读的数组，每条边带有一个属性。并返回 maxEdgePerVetex，每个节点上最多的边数
-* @param  {NodeConfig[]}  nodes 节点数组
-* @param  {EdgeConfig[]}  edges 边数组
-* @param  {Function}  attrs 读取边属性的函数
-* @return {Object} 转换后的数组及 maxEdgePerVetex 组成的对象
-*/
+ * 将节点和边数据转换为 GPU 可读的数组，每条边带有一个属性。并返回 maxEdgePerVetex，每个节点上最多的边数
+ * @param  {NodeConfig[]}  nodes 节点数组
+ * @param  {EdgeConfig[]}  edges 边数组
+ * @param  {Function}  attrs 读取边属性的函数
+ * @return {Object} 转换后的数组及 maxEdgePerVetex 组成的对象
+ */
 /**
-* 将节点和边数据转换为 GPU 可读的数组，每条边带有一个以上属性。并返回 maxEdgePerVetex，每个节点上最多的边数
-* @param  {NodeConfig[]}  nodes 节点数组
-* @param  {EdgeConfig[]}  edges 边数组
-* @param  {Function}  attrs 读取边属性的函数
-* @return {Object} 转换后的数组及 maxEdgePerVetex 组成的对象
-*/
+ * 将节点和边数据转换为 GPU 可读的数组，每条边带有一个以上属性。并返回 maxEdgePerVetex，每个节点上最多的边数
+ * @param  {NodeConfig[]}  nodes 节点数组
+ * @param  {EdgeConfig[]}  edges 边数组
+ * @param  {Function}  attrs 读取边属性的函数
+ * @return {Object} 转换后的数组及 maxEdgePerVetex 组成的对象
+ */
 export declare const buildTextureDataWithTwoEdgeAttr: (nodes: OutNode[], edges: Edge[], attrs1: Function, attrs2: Function) => {
     array: Float32Array;
     maxEdgePerVetex: number;
 };
 /**
-* transform the extended attributes of nodes or edges to a texture array
-* @param  {string[]}  attributeNames attributes' name to be read from items and put into output array
-* @param  {ModelConfig[]}  items the items to be read
-* @return {Float32Array} the attributes' value array to be read by GPU
-*/
+ * transform the extended attributes of nodes or edges to a texture array
+ * @param  {string[]}  attributeNames attributes' name to be read from items and put into output array
+ * @param  {ModelConfig[]}  items the items to be read
+ * @return {Float32Array} the attributes' value array to be read by GPU
+ */
 export declare const attributesToTextureData: (attributeNames: string[], items: any[]) => {
     array: Float32Array;
     count: number;
 };
 /**
-* transform the number array format of extended attributes of nodes or edges to a texture array
-* @param  {string[]}  attributeNames attributes' name to be read from items and put into output array
-* @return {Float32Array} the attributes' value array to be read by GPU
-*/
+ * transform the number array format of extended attributes of nodes or edges to a texture array
+ * @param  {string[]}  attributeNames attributes' name to be read from items and put into output array
+ * @return {Float32Array} the attributes' value array to be read by GPU
+ */
 export declare const arrayToTextureData: (valueArrays: number[][]) => Float32Array;

package/lib/util/index.d.ts

@@ -1,6 +1,6 @@
-export * from './string';
-export * from './array';
-export * from './number';
-export * from './math';
-export * from './object';
-export * from './function';
+export * from "./string";
+export * from "./array";
+export * from "./number";
+export * from "./math";
+export * from "./object";
+export * from "./function";

package/lib/util/math.d.ts

@@ -1,5 +1,5 @@
-import { Matrix, Model, IndexMap, Edge, Node, OutNode, Degree, NodeMap } from '../layout/types';
-export declare const getEdgeTerminal: (edge: Edge, type: 'source' | 'target') => any;
+import { Matrix, Model, IndexMap, Edge, Node, OutNode, Degree, NodeMap } from "../types";
+export declare const getEdgeTerminal: (edge: Edge, type: "source" | "target") => any;
 export declare const getDegree: (n: number, nodeIdxMap: IndexMap, edges: Edge[] | null) => Degree[];
 export declare const getDegreeMap: (nodes: Node[], edges: Edge[] | null) => {
     [id: string]: Degree;
@@ -19,7 +19,12 @@ export declare const scaleMatrix: (matrix: Matrix[], ratio: number) => Matrix[];
 export declare const traverseTreeUp: <T extends {
     children?: T[] | undefined;
 }>(data: T, fn: (param: T) => boolean) => void;
-export declare const findMinMaxNodeXY: (nodes: OutNode[]) => {
+/**
+ * calculate the bounding box for the nodes according to their x, y, and size
+ * @param nodes nodes in the layout
+ * @returns
+ */
+export declare const getLayoutBBox: (nodes: OutNode[]) => {
     minX: number;
     minY: number;
     maxX: number;
@@ -34,7 +39,7 @@ export declare const getAvgNodePosition: (nodes: OutNode[]) => {
     x: number;
     y: number;
 };
-export declare const getCoreNodeAndRelativeLeafNodes: (type: 'leaf' | 'all', node: Node, edges: Edge[], nodeClusterBy: string, degreesMap: {
+export declare const getCoreNodeAndRelativeLeafNodes: (type: "leaf" | "all", node: Node, edges: Edge[], nodeClusterBy: string, degreesMap: {
     [id: string]: Degree;
 }, nodeMap: NodeMap) => {
     coreNode: Node;

package/lib/worker.d.ts

@@ -0,0 +1,3 @@
+import type { Payload } from "./supervisor";
+import type { LayoutMapping } from "./types";
+export declare function calculateLayout(payload: Payload, transferables: Float32Array[]): (Float32Array[] | LayoutMapping)[];

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@antv/layout",
-  "version": "0.3.11",
+  "version": "1.0.0-alpha.0",
   "description": "graph layout algorithm",
-  "main": "lib/index.js",
-  "module": "es/index.js",
+  "main": "dist/index.min.js",
+  "module": "dist/index.min.js",
   "types": "lib/index.d.ts",
-  "unpkg": "dist/layout.min.js",
+  "unpkg": "dist/index.min.js",
   "files": [
-    "src",
-    "es",
+    "package.json",
+    "dist",
     "lib",
-    "dist"
+    "LICENSE",
+    "README.md"
   ],
   "keywords": [
     "graph",
@@ -18,98 +19,23 @@
     "algorithm",
     "antv"
   ],
-  "scripts": {
-    "clean": "rimraf es lib dist",
-    "lint:es": "eslint --ext .js --fix",
-    "lint:ts": "tslint -c tslint.json -p tsconfig.json --fix",
-    "lint": "npm run lint:ts && npm run lint:es",
-    "build:esm": "tsc --module esnext --target es2015 --outDir ./es",
-    "build:cjs": "tsc --module commonjs --target es5 --outDir ./lib",
-    "build:umd": "webpack --config webpack.config.js --mode production",
-    "build": "npm run clean && npm run build:cjs && npm run build:esm && npm run build:umd",
-    "build:watch": "npm build:esm --w",
-    "precommit": "lint-staged",
-    "release": "release-it",
-    "test": "jest",
-    "coverage": "jest --coverage",
-    "test-live": "DEBUG_MODE=1 jest --watch __tests__/g6/dagre-g6-test.ts"
-  },
-  "lint-staged": {
-    "*.js": [
-      "eslint --fix"
-    ],
-    "src/**/*.ts": [
-      "tslint -c tslint.json -p ./tsconfig.json --fix"
-    ]
-  },
   "dependencies": {
-    "@antv/g-webgpu": "0.7.2",
-    "@antv/graphlib": "^1.0.0",
-    "d3-force": "^2.1.1",
-    "d3-quadtree": "^2.0.0",
-    "dagre-compound": "^0.0.11",
-    "ml-matrix": "^6.5.0"
+    "@antv/graphlib": "^2.0.0-alpha.0",
+    "@naoak/workerize-transferable": "^0.1.0",
+    "eventemitter3": "^4.0.0"
   },
   "devDependencies": {
-    "@antv/g-webgpu-compiler": "0.7.2",
-    "@antv/g6": "^4.0.3",
-    "@babel/core": "*",
-    "@babel/polyfill": "^7.12.1",
-    "@babel/preset-env": "*",
-    "@babel/preset-typescript": "*",
-    "@types/d3-force": "^2.1.0",
-    "@types/graphlib": "^2.1.8",
-    "@types/jest": "^25.2.1",
-    "@types/d3-quadtree": "^2.0.0",
-    "babel-jest": "28.1.3",
-    "babel-loader": "^8.2.2",
-    "eslint": "^7.11.0",
-    "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-config-prettier": "^6.7.0",
-    "eslint-plugin-import": "^2.18.2",
-    "jest": "^26.0.1",
-    "jest-electron": "^0.1.7",
-    "jest-extended": "^0.11.2",
-    "lint-staged": "^10.2.2",
-    "release-it": "^14.0.1",
-    "rimraf": "^3.0.0",
-    "ts-jest": "^24.1.0",
-    "ts-loader": "^8.0.17",
-    "tslint": "^6.1.3",
-    "tslint-config-airbnb": "^5.11.2",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-eslint-rules": "^5.4.0",
+    "@babel/core": "^7.7.7",
+    "@babel/plugin-proposal-class-properties": "^7.1.0",
+    "@babel/preset-react": "^7.7.4",
+    "babel-loader": "^8.0.6",
+    "ts-loader": "^7.0.3",
     "typescript": "^4.0.3",
-    "webpack": "^5.23.0",
-    "webpack-bundle-analyzer": "^4.4.0",
-    "webpack-cli": "^4.5.0",
-    "webpack-dev-server": "^3.11.2"
-  },
-  "release-it": {
-    "git": {
-      "commitMessage": ":sparkles: Release ${version}"
-    },
-    "github": {
-      "release": true
-    },
-    "hooks": {
-      "before:init": [
-        "yarn run build"
-      ]
-    }
+    "webpack": "^5.38.1",
+    "webpack-cli": "^4.7.2",
+    "workerize-loader": "^2.0.2"
   },
-  "contributors": [],
-  "license": "MIT",
-  "homepage": "https://github.com/antvis/layout",
-  "bugs": {
-    "url": "https://github.com/antvis/layout/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/antvis/layout.git"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
+  "scripts": {
+    "build:umd": "webpack --config webpack.config.js --mode production"
   }
 }