@antv/layout 0.3.24 → 0.3.25

package/src/layout/types.ts

@@ -1,4 +1,4 @@
-import { Base } from './base';
+import { Base } from "./base";
 
 export interface Node {
   id: string;
@@ -73,6 +73,7 @@ export type NodeMap = {
   [key: string]: INode;
 };
 
+
 export type Matrix = number[];
 
 export type Point = {
@@ -91,7 +92,7 @@ export interface ComboTree {
   children?: ComboTree[];
   depth?: number;
   parentId?: string;
-  itemType?: 'node' | 'combo';
+  itemType?: "node" | "combo";
   [key: string]: unknown;
 }
 export interface ComboConfig {
@@ -102,7 +103,7 @@ export interface ComboConfig {
 }
 
 export interface CircularLayoutOptions {
-  type: 'circular';
+  type: "circular";
   center?: PointTuple;
   width?: number;
   height?: number;
@@ -111,7 +112,7 @@ export interface CircularLayoutOptions {
   endRadius?: number | null;
   clockwise?: boolean;
   divisions?: number;
-  ordering?: 'topology' | 'topology-directed' | 'degree' | null;
+  ordering?: "topology" | "topology-directed" | "degree" | null;
   angleRatio?: number;
   workerEnabled?: boolean;
   startAngle?: number;
@@ -120,7 +121,7 @@ export interface CircularLayoutOptions {
 }
 
 export interface ComboForceLayoutOptions {
-  type: 'comboForce';
+  type: "comboForce";
   center?: PointTuple;
   maxIteration?: number;
   linkDistance?: number | ((d?: unknown) => number);
@@ -150,7 +151,7 @@ export interface ComboForceLayoutOptions {
   workerEnabled?: boolean;
 }
 export interface ComboCombinedLayoutOptions {
-  type: 'comboConcentricForce';
+  type: "comboConcentricForce";
   center?: PointTuple;
   nodeSize?: number | number[] | ((d?: any) => number) | undefined;
   spacing?: number | number[] | ((d?: any) => number) | undefined;
@@ -161,7 +162,7 @@ export interface ComboCombinedLayoutOptions {
 }
 
 export interface ConcentricLayoutOptions {
-  type: 'concentric';
+  type: "concentric";
   center?: PointTuple;
   preventOverlap?: boolean;
   nodeSize?: number | PointTuple;
@@ -179,9 +180,9 @@ export interface ConcentricLayoutOptions {
 }
 
 export interface DagreLayoutOptions {
-  type: 'dagre';
-  rankdir?: 'TB' | 'BT' | 'LR' | 'RL';
-  align?: 'UL' | 'UR' | 'DL' | 'DR';
+  type: "dagre";
+  rankdir?: "TB" | "BT" | "LR" | "RL";
+  align?: "UL" | "UR" | "DL" | "DR";
   begin?: PointTuple;
   nodeSize?: number | number[] | undefined;
   nodesep?: number;
@@ -192,8 +193,8 @@ export interface DagreLayoutOptions {
   edgeLabelSpace?: boolean;
   nodeOrder?: string[];
   preset?: {
-    nodes: OutNode[];
-    edges: any[];
+    nodes: OutNode[],
+    edges: any[],
   };
   onLayoutEnd?: () => void;
   nodesepFunc?: ((d?: any) => number) | undefined;
@@ -201,9 +202,9 @@ export interface DagreLayoutOptions {
 }
 
 export interface DagreCompoundLayoutOptions {
-  type?: 'dagreCompound';
-  rankdir?: 'TB' | 'BT' | 'LR' | 'RL';
-  align?: 'UL' | 'UR' | 'DL' | 'DR';
+  type?: "dagreCompound";
+  rankdir?: "TB" | "BT" | "LR" | "RL";
+  align?: "UL" | "UR" | "DL" | "DR";
   begin?: PointTuple;
   nodeSize?: number | number[] | undefined;
   nodesep?: number;
@@ -215,7 +216,7 @@ export interface DagreCompoundLayoutOptions {
 }
 
 export interface FruchtermanLayoutOptions {
-  type: 'fruchterman';
+  type: "fruchterman";
   center?: PointTuple;
   maxIteration?: number;
   width?: number;
@@ -242,7 +243,7 @@ export interface CentripetalOptions {
     nodes: INode[],
     edges: Edge[],
     width: number,
-    height: number
+    height: number,
   ) => {
     x: number;
     y: number;
@@ -250,18 +251,12 @@ export interface CentripetalOptions {
   };
 }
 export interface Force2LayoutOptions {
-  type?: 'force2';
+  type?: "force2";
   center?: PointTuple;
   width?: number;
   height?: number;
-  linkDistance?:
-    | number
-    | ((edge?: any, source?: any, target?: any) => number)
-    | undefined;
-  defSpringLen:
-    | number
-    | ((edge?: any, source?: any, target?: any) => number)
-    | undefined;
+  linkDistance?: number | ((edge?: any, source?: any, target?: any) => number) | undefined;
+  defSpringLen: number | ((edge?: any, source?: any, target?: any) => number) | undefined;
   nodeStrength?: number | ((d?: any) => number) | undefined;
   edgeStrength?: number | ((d?: any) => number) | undefined;
   preventOverlap?: boolean;
@@ -287,23 +282,16 @@ export interface Force2LayoutOptions {
   onLayoutEnd?: () => void;
   getMass?: ((d?: any) => number) | undefined;
   getCenter?: ((d?: any, degree?: number) => number[]) | undefined;
-  monitor?: (params: {
-    energy: number;
-    nodes: INode[];
-    edge: Edge[];
-    iterations: number;
-  }) => void;
+  monitor?: (params: { energy: number, nodes: INode[], edge: Edge[], iterations: number }) => void;
+
 }
 
 export interface GForceLayoutOptions {
-  type?: 'gForce';
+  type?: "gForce";
   center?: PointTuple;
   width?: number;
   height?: number;
-  linkDistance?:
-    | number
-    | ((edge?: any, source?: any, target?: any) => number)
-    | undefined;
+  linkDistance?: number | ((edge?: any, source?: any, target?: any) => number) | undefined;
   nodeStrength?: number | ((d?: any) => number) | undefined;
   edgeStrength?: number | ((d?: any) => number) | undefined;
   preventOverlap?: boolean;
@@ -330,7 +318,7 @@ type INode = OutNode & {
 };
 
 export interface GridLayoutOptions {
-  type: 'grid';
+  type: "grid";
   width?: number;
   height?: number;
   begin?: PointTuple;
@@ -347,7 +335,7 @@ export interface GridLayoutOptions {
 }
 
 export interface MDSLayoutOptions {
-  type: 'mds';
+  type: "mds";
   center?: PointTuple;
   linkDistance?: number;
   workerEnabled?: boolean;
@@ -355,7 +343,7 @@ export interface MDSLayoutOptions {
 }
 
 export interface RandomLayoutOptions {
-  type: 'random';
+  type: "random";
   center?: PointTuple;
   width?: number;
   height?: number;
@@ -364,7 +352,7 @@ export interface RandomLayoutOptions {
 }
 
 export interface ForceLayoutOptions {
-  type: 'force';
+  type: "force";
   center?: PointTuple;
   linkDistance?: number | ((d?: any) => number) | undefined;
   edgeStrength?: number | ((d?: any) => number) | undefined;
@@ -389,7 +377,7 @@ export interface ForceLayoutOptions {
 }
 
 export interface RadialLayoutOptions {
-  type: 'radial';
+  type: "radial";
   center?: PointTuple;
   width?: number;
   height?: number;
@@ -405,12 +393,11 @@ export interface RadialLayoutOptions {
   sortBy?: string | undefined;
   sortStrength?: number;
   workerEnabled?: boolean;
-  initWithMDS?: boolean;
   onLayoutEnd?: () => void;
 }
 
 export interface FruchtermanGPULayoutOptions {
-  type: 'fruchterman-gpu';
+  type: "fruchterman-gpu";
   center?: PointTuple;
   width?: number;
   height?: number;
@@ -425,7 +412,7 @@ export interface FruchtermanGPULayoutOptions {
 }
 
 export interface GForceGPULayoutOptions {
-  type: 'gForce-gpu';
+  type: "gForce-gpu";
   center?: PointTuple;
   linkDistance?: number | ((d?: any) => number) | undefined;
   nodeStrength?: number | ((d?: any) => number) | undefined;
@@ -443,8 +430,9 @@ export interface GForceGPULayoutOptions {
   gpuEnabled?: boolean;
 }
 
+
 export interface ForceAtlas2LayoutOptions {
-  type: 'forceAtlas2';
+  type: "forceAtlas2";
   center?: PointTuple;
   width?: number;
   height?: number;
@@ -465,28 +453,28 @@ export interface ForceAtlas2LayoutOptions {
 }
 
 export interface ERLayoutOptions {
-  type: 'er';
+  type: "er";
   width?: number;
   height?: number;
   nodeMinGap?: number;
 }
 export namespace ILayout {
   export type LayoutTypes =
-    | 'grid'
-    | 'random'
-    | 'force'
-    | 'circular'
-    | 'dagre'
-    | 'radial'
-    | 'concentric'
-    | 'mds'
-    | 'fruchterman'
-    | 'fruchterman-gpu'
-    | 'gForce'
-    | 'gForce-gpu'
-    | 'comboForce'
-    | 'forceAtlas2'
-    | 'er';
+    | "grid"
+    | "random"
+    | "force"
+    | "circular"
+    | "dagre"
+    | "radial"
+    | "concentric"
+    | "mds"
+    | "fruchterman"
+    | "fruchterman-gpu"
+    | "gForce"
+    | "gForce-gpu"
+    | "comboForce"
+    | "forceAtlas2"
+    | "er";
 
   export type LayoutOptions =
     | GridLayoutOptions