@antv/layout 1.2.14-beta.6 → 1.2.14-beta.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/dist/{39a5a15c96cf2db887c3.worker.js → 465467d5101088ef2320.worker.js} +1 -1
  2. package/dist/465467d5101088ef2320.worker.js.map +1 -0
  3. package/dist/index.min.js +1 -1
  4. package/dist/index.min.js.map +1 -1
  5. package/lib/antv-dagre.d.ts +2 -12
  6. package/lib/antv-dagre.js +2 -12
  7. package/lib/antv-dagre.js.map +1 -1
  8. package/lib/circular.d.ts +2 -12
  9. package/lib/circular.js +2 -12
  10. package/lib/circular.js.map +1 -1
  11. package/lib/{comboCombined.d.ts → combo-combined.d.ts} +2 -12
  12. package/lib/{comboCombined.js → combo-combined.js} +3 -13
  13. package/lib/combo-combined.js.map +1 -0
  14. package/lib/concentric.d.ts +2 -12
  15. package/lib/concentric.js +2 -12
  16. package/lib/concentric.js.map +1 -1
  17. package/lib/dagre.d.ts +3 -2
  18. package/lib/dagre.js +3 -2
  19. package/lib/dagre.js.map +1 -1
  20. package/lib/exports.d.ts +2 -2
  21. package/lib/exports.js +2 -2
  22. package/lib/exports.js.map +1 -1
  23. package/lib/force/{forceNBody.js → force-n-body.js} +1 -1
  24. package/lib/force/force-n-body.js.map +1 -0
  25. package/lib/force/index.d.ts +2 -12
  26. package/lib/force/index.js +3 -13
  27. package/lib/force/index.js.map +1 -1
  28. package/lib/force-atlas2/body.js.map +1 -0
  29. package/lib/{forceAtlas2 → force-atlas2}/index.d.ts +2 -12
  30. package/lib/{forceAtlas2 → force-atlas2}/index.js +3 -13
  31. package/lib/force-atlas2/index.js.map +1 -0
  32. package/lib/{forceAtlas2/quadTree.js → force-atlas2/quad-tree.js} +1 -1
  33. package/lib/force-atlas2/quad-tree.js.map +1 -0
  34. package/lib/force-atlas2/quad.js.map +1 -0
  35. package/lib/fruchterman.d.ts +2 -12
  36. package/lib/fruchterman.js +2 -12
  37. package/lib/fruchterman.js.map +1 -1
  38. package/lib/grid.d.ts +2 -12
  39. package/lib/grid.js +2 -12
  40. package/lib/grid.js.map +1 -1
  41. package/lib/mds.d.ts +2 -12
  42. package/lib/mds.js +2 -12
  43. package/lib/mds.js.map +1 -1
  44. package/lib/radial/index.d.ts +2 -12
  45. package/lib/radial/index.js +2 -12
  46. package/lib/radial/index.js.map +1 -1
  47. package/lib/random.d.ts +2 -12
  48. package/lib/random.js +2 -12
  49. package/lib/random.js.map +1 -1
  50. package/lib/registry.js +2 -2
  51. package/lib/registry.js.map +1 -1
  52. package/lib/types.d.ts +86 -86
  53. package/package.json +1 -1
  54. package/dist/39a5a15c96cf2db887c3.worker.js.map +0 -1
  55. package/lib/comboCombined.js.map +0 -1
  56. package/lib/force/forceNBody.js.map +0 -1
  57. package/lib/forceAtlas2/body.js.map +0 -1
  58. package/lib/forceAtlas2/index.js.map +0 -1
  59. package/lib/forceAtlas2/quad.js.map +0 -1
  60. package/lib/forceAtlas2/quadTree.js.map +0 -1
  61. /package/lib/force/{forceNBody.d.ts → force-n-body.d.ts} +0 -0
  62. /package/lib/{forceAtlas2 → force-atlas2}/body.d.ts +0 -0
  63. /package/lib/{forceAtlas2 → force-atlas2}/body.js +0 -0
  64. /package/lib/{forceAtlas2/quadTree.d.ts → force-atlas2/quad-tree.d.ts} +0 -0
  65. /package/lib/{forceAtlas2 → force-atlas2}/quad.d.ts +0 -0
  66. /package/lib/{forceAtlas2 → force-atlas2}/quad.js +0 -0
package/lib/types.d.ts CHANGED
@@ -149,28 +149,28 @@ export interface CircularLayoutOptions {
149
149
  * <zh/> 若设置了 radius,则 startRadius 与 endRadius 不生效
150
150
  *
151
151
  * <en/> If radius is set, startRadius and endRadius will not take effect
152
- * @defaultVaule null
152
+ * @defaultValue null
153
153
  */
154
154
  radius?: number | null;
155
155
  /**
156
156
  * <zh/> 螺旋状布局的起始半径
157
157
  *
158
158
  * <en/> Spiral layout start radius
159
- * @defaultVaule null
159
+ * @defaultValue null
160
160
  */
161
161
  startRadius?: number | null;
162
162
  /**
163
163
  * <zh/> 螺旋状布局的结束半径
164
164
  *
165
165
  * <en/> Spiral layout end radius
166
- * @defaultVaule null
166
+ * @defaultValue null
167
167
  */
168
168
  endRadius?: number | null;
169
169
  /**
170
170
  * <zh/> 是否顺时针排列
171
171
  *
172
172
  * <en/> Whether to arrange clockwise
173
- * @defaultVaule true
173
+ * @defaultValue true
174
174
  */
175
175
  clockwise?: boolean;
176
176
  /**
@@ -181,7 +181,7 @@ export interface CircularLayoutOptions {
181
181
  * <zh/> 在 endRadius - startRadius != 0 时生效
182
182
  *
183
183
  * <en/> It takes effect when endRadius - startRadius != 0
184
- * @defaultVaule 1
184
+ * @defaultValue 1
185
185
  */
186
186
  divisions?: number;
187
187
  /**
@@ -195,14 +195,14 @@ export interface CircularLayoutOptions {
195
195
  * - 'topology': Sort according to topological order
196
196
  * - 'topology-directed': Sort according to topological order (directed graph)
197
197
  * - 'degree': Sort according to degree size
198
- * @defaultVaule null
198
+ * @defaultValue null
199
199
  */
200
200
  ordering?: 'topology' | 'topology-directed' | 'degree' | null;
201
201
  /**
202
202
  * <zh/> 从第一个节点到最后节点之间相隔多少个 2*PI
203
203
  *
204
204
  * <en/> The distance between the first node and the last node is separated by how many 2*PI
205
- * @defaultVaule 1
205
+ * @defaultValue 1
206
206
  */
207
207
  angleRatio?: number;
208
208
  /**
@@ -239,7 +239,7 @@ export interface GridLayoutOptions {
239
239
  * <zh/> 在 G6 中使用当前容器的宽度作为 grid 布局 width 的默认值。单独使用此布局时默认值为 300
240
240
  *
241
241
  * <en/> The width of the grid layout is the default value of the current container width in G6. The default value is 300 when this layout is used alone
242
- * @defaultVaule 300
242
+ * @defaultValue 300
243
243
  */
244
244
  width?: number;
245
245
  /**
@@ -250,14 +250,14 @@ export interface GridLayoutOptions {
250
250
  * <zh/> 在 G6 中使用当前容器的高度作为 grid 布局 height 的默认值。单独使用此布局时默认值为 300
251
251
  *
252
252
  * <en/> The height of the grid layout is the default value of the current container height in G6. The default value is 300 when this layout is used alone
253
- * @defaultVaule 300
253
+ * @defaultValue 300
254
254
  */
255
255
  height?: number;
256
256
  /**
257
257
  * <zh/> 网格开始位置(左上角)
258
258
  *
259
259
  * <en/> Grid layout starting position (upper left corner)
260
- * @defaultVaule [0, 0]
260
+ * @defaultValue [0, 0]
261
261
  *
262
262
  */
263
263
  begin?: PointTuple;
@@ -269,7 +269,7 @@ export interface GridLayoutOptions {
269
269
  * <zh/> 必须配合下面属性 nodeSize 或节点数据中的 data.size 属性,只有在数据中设置了 data.size 或在该布局中配置了与当前图节点大小相同的 nodeSize 值,才能够进行节点重叠的碰撞检测
270
270
  *
271
271
  * <en/> Must be used with the following properties: nodeSize or data.size in the data. When data.size is set or nodeSize is configured with the same value as the current graph node size in the layout, the collision detection of node overlap can be performed
272
- * @defaultVaule false
272
+ * @defaultValue false
273
273
  */
274
274
  preventOverlap?: boolean;
275
275
  /**
@@ -282,42 +282,42 @@ export interface GridLayoutOptions {
282
282
  * <zh/> 避免重叠时节点的间距 padding。preventOverlap 为 true 时生效
283
283
  *
284
284
  * <en/> Padding between nodes to prevent overlap. It takes effect when preventOverlap is true
285
- * @defaultVaule 10
285
+ * @defaultValue 10
286
286
  */
287
287
  preventOverlapPadding?: number;
288
288
  /**
289
289
  * <zh/> 为 false 时表示利用所有可用画布空间,为 true 时表示利用最小的画布空间
290
290
  *
291
291
  * <en/> When false, it means to use all available canvas space. When true, it means to use the smallest canvas space
292
- * @defaultVaule false
292
+ * @defaultValue false
293
293
  */
294
294
  condense?: boolean;
295
295
  /**
296
296
  * <zh/> 网格的行数,为 undefined 时算法根据节点数量、布局空间、cols(若指定)自动计算
297
297
  *
298
298
  * <en/> Number of rows in the grid. It is calculated automatically when it is undefined and the number of nodes, layout space, and cols (if specified) are specified
299
- * @defaultVaule 10
299
+ * @defaultValue 10
300
300
  */
301
301
  rows?: number;
302
302
  /**
303
303
  * <zh/> 网格的列数,为 undefined 时算法根据节点数量、布局空间、rows(若指定)自动计算
304
304
  *
305
305
  * <en/> Number of columns in the grid. It is calculated automatically when it is undefined and the number of nodes, layout space, and rows (if specified) are specified
306
- * @defaultVaule undefined
306
+ * @defaultValue undefined
307
307
  */
308
308
  cols?: number;
309
309
  /**
310
310
  * <zh/> 指定排序的依据(节点属性名),数值越高则该节点被放置得越中心。若为 undefined,则会计算节点的度数,度数越高,节点将被放置得越中心
311
311
  *
312
312
  * <en/> Specify the basis for sorting (node attribute name). The higher the value, the more the node will be placed in the center. If it is undefined, the degree of the node will be calculated, and the higher the degree, the more the node will be placed in the center
313
- * @defaultVaule undefined
313
+ * @defaultValue undefined
314
314
  */
315
315
  sortBy?: string;
316
316
  /**
317
317
  * <zh/> 指定每个节点所在的行和列
318
318
  *
319
319
  * <en/> Specify the row and column where each node is located
320
- * @defaultVaule undefined
320
+ * @defaultValue undefined
321
321
  */
322
322
  position?: (node?: Node) => {
323
323
  row?: number;
@@ -371,7 +371,7 @@ export interface MDSLayoutOptions {
371
371
  * <zh/> 边的理想长度,可以理解为边作为弹簧在不受力下的长度
372
372
  *
373
373
  * <en/> Ideal length of the edge, which can be understood as the length of the edge as a spring under no force
374
- * @defaultVaule 200
374
+ * @defaultValue 200
375
375
  */
376
376
  linkDistance?: number;
377
377
  }
@@ -395,7 +395,7 @@ export interface ConcentricLayoutOptions {
395
395
  * <zh/> 必须配合下面属性 nodeSize 或节点数据中的 data.size 属性,只有在数据中设置了 data.size 或在该布局中配置了与当前图节点大小相同的 nodeSize 值,才能够进行节点重叠的碰撞检测
396
396
  *
397
397
  * <en/> Must be used with the following properties, and only when the data.size property is set in the data or the nodeSize value configured with the same size as the current graph node is configured in the layout, can the node overlap collision detection be performed
398
- * @defaultVaule false
398
+ * @defaultValue false
399
399
  */
400
400
  preventOverlap?: boolean;
401
401
  /**
@@ -412,28 +412,28 @@ export interface ConcentricLayoutOptions {
412
412
  * <zh/> 若为 undefined ,则将会被设置为 2 * Math.PI * (1 - 1 / |level.nodes|) ,其中 level.nodes 为该算法计算出的每一层的节点,|level.nodes| 代表该层节点数量
413
413
  *
414
414
  * <en/> If undefined, it will be set to 2 * Math.PI * (1 - 1 / |level.nodes|), where level.nodes is the number of nodes in each layer calculated by this algorithm, and |level.nodes| represents the number of nodes in this layer
415
- * @defaultVaule undefined
415
+ * @defaultValue undefined
416
416
  */
417
417
  sweep?: number;
418
418
  /**
419
419
  * <zh/> 环与环之间的距离是否相等
420
420
  *
421
421
  * <en/> Whether the distance between rings is equal
422
- * @defaultVaule false
422
+ * @defaultValue false
423
423
  */
424
424
  equidistant?: boolean;
425
425
  /**
426
426
  * <zh/> 开始布局节点的弧度
427
427
  *
428
428
  * <en/> The starting angle of the layout node
429
- * @defaultVaule 3 / 2 * Math.PI
429
+ * @defaultValue 3 / 2 * Math.PI
430
430
  */
431
431
  startAngle?: number;
432
432
  /**
433
433
  * <zh/> 是否按照顺时针排列
434
434
  *
435
435
  * <en/> Whether to arrange in clockwise order
436
- * @defaultVaule false
436
+ * @defaultValue false
437
437
  */
438
438
  clockwise?: boolean;
439
439
  /**
@@ -444,7 +444,7 @@ export interface ConcentricLayoutOptions {
444
444
  * <zh/> 若为 undefined,则将会被设置为 maxValue / 4 ,其中 maxValue 为最大的排序依据的属性值。例如,若 sortBy 为 'degree',则 maxValue 为所有节点中度数最大的节点的度数
445
445
  *
446
446
  * <en/> If undefined, it will be set to maxValue / 4, where maxValue is the largest value of the sortBy attribute. For example, if sortBy is 'degree', maxValue is the degree of the node with the largest degree in all nodes
447
- * @defaultVaule undefined
447
+ * @defaultValue undefined
448
448
  */
449
449
  maxLevelDiff?: number;
450
450
  /**
@@ -455,7 +455,7 @@ export interface ConcentricLayoutOptions {
455
455
  * <zh/> 数值越高则该节点被放置得越中心。若为 undefined,则会计算节点的度数,度数越高,节点将被放置得越中心
456
456
  *
457
457
  * <en/> The higher the value, the more the node will be placed in the center. If undefined, the degree of the node will be calculated, and the higher the degree, the more the node will be placed in the center
458
- * @defaultVaule undefined
458
+ * @defaultValue undefined
459
459
  */
460
460
  sortBy?: string;
461
461
  /**
@@ -474,7 +474,7 @@ export interface ConcentricLayoutOptions {
474
474
  * <zh/> 环与环之间最小间距,用于调整半径
475
475
  *
476
476
  * <en/> Minimum spacing between rings, used to adjust the radius
477
- * @defaultVaule 10
477
+ * @defaultValue 10
478
478
  */
479
479
  nodeSpacing?: number | number[] | ((node?: Node) => number);
480
480
  }
@@ -506,14 +506,14 @@ export interface RadialLayoutOptions {
506
506
  * <zh/> 边长度
507
507
  *
508
508
  * <en/> Edge length
509
- * @defaultVaule 50
509
+ * @defaultValue 50
510
510
  */
511
511
  linkDistance?: number;
512
512
  /**
513
513
  * <zh/> 停止迭代到最大迭代数
514
514
  *
515
515
  * <en/> Stop iterating until the maximum iteration number is reached
516
- * @defaultVaule 1000
516
+ * @defaultValue 1000
517
517
  */
518
518
  maxIteration?: number;
519
519
  /**
@@ -531,7 +531,7 @@ export interface RadialLayoutOptions {
531
531
  * <zh/> 每一圈距离上一圈的距离。默认填充整个画布,即根据图的大小决定
532
532
  *
533
533
  * <en/> The distance between each ring. Defaults to filling the entire canvas, i.e., determined by the size of the graph
534
- * @defaultVaule 100
534
+ * @defaultValue 100
535
535
  */
536
536
  unitRadius?: number | null;
537
537
  /**
@@ -542,7 +542,7 @@ export interface RadialLayoutOptions {
542
542
  * <zh/> 必须配合下面属性 nodeSize 或节点数据中的 data.size 属性,只有在数据中设置了 data.size 或在该布局中配置了与当前图节点大小相同的 nodeSize 值,才能够进行节点重叠的碰撞检测
543
543
  *
544
544
  * <en/> Must be used with the following properties: nodeSize or data.size in the node data. Only when data.size or nodeSize with the same value as the current graph node size is set in the layout configuration, can the collision detection of node overlap be performed
545
- * @defaultVaule false
545
+ * @defaultValue false
546
546
  */
547
547
  preventOverlap?: boolean;
548
548
  /**
@@ -555,14 +555,14 @@ export interface RadialLayoutOptions {
555
555
  * <zh/> preventOverlap 为 true 时生效, 防止重叠时节点边缘间距的最小值。可以是回调函数, 为不同节点设置不同的最小间距
556
556
  *
557
557
  * <en/> Effective when preventOverlap is true. The minimum edge spacing when preventing node overlap. It can be a callback function, and set different minimum spacing for different nodes
558
- * @defaultVaule 10
558
+ * @defaultValue 10
559
559
  */
560
560
  nodeSpacing?: number | Function;
561
561
  /**
562
562
  * <zh/> 防止重叠步骤的最大迭代次数
563
563
  *
564
564
  * <en/> Maximum iteration number of the prevent overlap step
565
- * @defaultVaule 200
565
+ * @defaultValue 200
566
566
  */
567
567
  maxPreventOverlapIteration?: number;
568
568
  /**
@@ -573,7 +573,7 @@ export interface RadialLayoutOptions {
573
573
  * <zh/> 当 preventOverlap 为 true,且 strictRadial 为 false 时,有重叠的节点严格沿着所在的环展开,但在一个环上若节点过多,可能无法完全避免节点重叠 当 preventOverlap 为 true,且 strictRadial 为 true 时,允许同环上重叠的节点不严格沿着该环布局,可以在该环的前后偏移以避免重叠
574
574
  *
575
575
  * <en/> When preventOverlap is true and strictRadial is false, overlapping nodes are strictly laid out along the ring they are in. However, if there are too many nodes on a ring, it may not be possible to completely avoid node overlap. When preventOverlap is true and strictRadial is true, overlapping nodes on the same ring are allowed to be laid out not strictly along the ring, and can be offset before and after the ring to avoid overlap
576
- * @defaultVaule true
576
+ * @defaultValue true
577
577
  */
578
578
  strictRadial?: boolean;
579
579
  /**
@@ -584,14 +584,14 @@ export interface RadialLayoutOptions {
584
584
  * <zh/> 默认 undefined ,表示根据数据的拓扑结构(节点间最短路径)排布,即关系越近/点对间最短路径越小的节点将会被尽可能排列在一起;'data' 表示按照节点在数据中的顺序排列,即在数据顺序上靠近的节点将会尽可能排列在一起;也可以指定为节点数据中的某个字段名,例如 'cluster'、'name' 等(必须在数据的 data 中存在)
585
585
  *
586
586
  * <en/> The default is undefined, which means arranging based on the topological structure of the data (the shortest path between nodes). Nodes that are closer in proximity or have a smaller shortest path between them will be arranged as close together as possible. 'data' indicates arranging based on the order of nodes in the data, so nodes that are closer in the data order will be arranged as close together as possible. You can also specify a field name in the node data, such as 'cluster' or 'name' (it must exist in the data of the graph)
587
- * @defaultVaule undefined
587
+ * @defaultValue undefined
588
588
  */
589
589
  sortBy?: string;
590
590
  /**
591
591
  * <zh/> 同层节点根据 sortBy 排列的强度,数值越大,sortBy 指定的方式计算出距离越小的越靠近。sortBy 不为 undefined 时生效
592
592
  *
593
593
  * <en/> The strength of arranging nodes according to sortBy. The larger the value, the closer the nodes that sortBy specifies are arranged. It takes effect when sortBy is not undefined
594
- * @defaultVaule 10
594
+ * @defaultValue 10
595
595
  */
596
596
  sortStrength?: number;
597
597
  }
@@ -614,7 +614,7 @@ export interface D3ForceLayoutOptions {
614
614
  * <en/> Edge length
615
615
  * - number: fixed edge length
616
616
  * - (edge: Edge) => number: edge length callback function, set different edge lengths according to different edges
617
- * @defaultVaule 50
617
+ * @defaultValue 50
618
618
  */
619
619
  linkDistance?: number | ((edge?: Edge) => number);
620
620
  /**
@@ -633,7 +633,7 @@ export interface D3ForceLayoutOptions {
633
633
  * <en/> Cluster node strength. Negative numbers represent repulsion
634
634
  * - number: fixed cluster node strength
635
635
  * - (node: Node) => number: cluster node strength callback function, set different cluster node strengths according to different nodes
636
- * @defaultVaule -1
636
+ * @defaultValue -1
637
637
  */
638
638
  nodeStrength?: number | ((node?: Node) => number);
639
639
  /**
@@ -644,14 +644,14 @@ export interface D3ForceLayoutOptions {
644
644
  * <zh/> 必须配合下面属性 nodeSize 或节点数据中的 data.size 属性,只有在数据中设置了 data.size 或在该布局中配置了与当前图节点大小相同的 nodeSize 值,才能够进行节点重叠的碰撞检测
645
645
  *
646
646
  * <en/> Must be used with the following properties: nodeSize or data.size in the node data. Only when data.size or nodeSize with the same value as the current graph node size is set in the layout configuration, can the collision detection of node overlapping be performed
647
- * @defaultVaule false
647
+ * @defaultValue false
648
648
  */
649
649
  preventOverlap?: boolean;
650
650
  /**
651
651
  * <zh/> 防止重叠的力强度,范围 [0, 1]
652
652
  *
653
653
  * <en/> The force strength of preventing overlap, the range is [0, 1]
654
- * @defaultVaule 1
654
+ * @defaultValue 1
655
655
  */
656
656
  collideStrength?: number;
657
657
  /**
@@ -670,63 +670,63 @@ export interface D3ForceLayoutOptions {
670
670
  * <zh/> 当前的迭代收敛阈值
671
671
  *
672
672
  * <en/> The convergence threshold of the current iteration
673
- * @defaultVaule 0.3
673
+ * @defaultValue 0.3
674
674
  */
675
675
  alpha?: number;
676
676
  /**
677
677
  * <zh/> 迭代阈值的衰减率。范围 [0, 1]。0.028 对应迭代数为 300
678
678
  *
679
679
  * <en/> The decay rate of the iteration threshold. The range is [0, 1]. 0.028 corresponds to iteration number 300
680
- * @defaultVaule 0.028
680
+ * @defaultValue 0.028
681
681
  */
682
682
  alphaDecay?: number;
683
683
  /**
684
684
  * <zh/> 停止迭代的阈值
685
685
  *
686
686
  * <en/> The threshold to stop iteration
687
- * @defaultVaule 0.001
687
+ * @defaultValue 0.001
688
688
  */
689
689
  alphaMin?: number;
690
690
  /**
691
691
  * <zh/> 是否按照聚类信息布局
692
692
  *
693
693
  * <en/> Whether to layout according to the clustering information
694
- * @defaultVaule false
694
+ * @defaultValue false
695
695
  */
696
696
  clustering?: boolean;
697
697
  /**
698
698
  * <zh/> 聚类节点作用力。负数代表斥力
699
699
  *
700
700
  * <en/> Clustering node force. Negative numbers represent repulsion
701
- * @defaultVaule -1
701
+ * @defaultValue -1
702
702
  */
703
703
  clusterNodeStrength?: number;
704
704
  /**
705
705
  * <zh/> 聚类边作用力
706
706
  *
707
707
  * <en/> Clustering edge force
708
- * @defaultVaule 0.1
708
+ * @defaultValue 0.1
709
709
  */
710
710
  clusterEdgeStrength?: number;
711
711
  /**
712
712
  * <zh/> 聚类边长度
713
713
  *
714
714
  * <en/> Clustering edge length
715
- * @defaultVaule 100
715
+ * @defaultValue 100
716
716
  */
717
717
  clusterEdgeDistance?: number;
718
718
  /**
719
719
  * <zh/> 聚类节点大小 / 直径,直径越大,越分散
720
720
  *
721
721
  * <en/> Clustering node size / diameter. Diameter larger means more scattered
722
- * @defaultVaule 10
722
+ * @defaultValue 10
723
723
  */
724
724
  clusterNodeSize?: number;
725
725
  /**
726
726
  * <zh/> 用于 foci 的力
727
727
  *
728
728
  * <en/> Force for foci
729
- * @defaultVaule 0.8
729
+ * @defaultValue 0.8
730
730
  */
731
731
  clusterFociStrength?: number;
732
732
  /**
@@ -756,7 +756,7 @@ export interface CentripetalOptions {
756
756
  * <en/> The centripetal force of the leaf node (i.e., the node with degree 1)
757
757
  * - number: fixed centripetal force size
758
758
  * - ((node: Node, nodes: Node[], edges: Edge[]) => number): return different values according to the node, edge, and situation
759
- * @defaultVaule 2
759
+ * @defaultValue 2
760
760
  */
761
761
  leaf?: number | ((node: Node, nodes: Node[], edges: Edge[]) => number);
762
762
  /**
@@ -766,7 +766,7 @@ export interface CentripetalOptions {
766
766
  * <en/> The centripetal force of the scattered node (i.e., the node with degree 0)
767
767
  * - number: fixed centripetal force size
768
768
  * - ((node: Node) => number): return different values according to the node situation
769
- * @defaultVaule 2
769
+ * @defaultValue 2
770
770
  */
771
771
  single?: number | ((node: Node) => number);
772
772
  /**
@@ -776,7 +776,7 @@ export interface CentripetalOptions {
776
776
  * <en/> The centripetal force of the other nodes (i.e., the node with degree > 1)
777
777
  * - number: fixed centripetal force size
778
778
  * - ((node: Node) => number): return different values according to the node situation
779
- * @defaultVaule 1
779
+ * @defaultValue 1
780
780
  */
781
781
  others?: number | ((node: Node) => number);
782
782
  /**
@@ -811,7 +811,7 @@ export interface ComboCombinedLayoutOptions {
811
811
  * <zh/> 若不指定,则根据传入的节点的 size 属性计算。若即不指定,节点中也没有 size,则默认大小为 10
812
812
  *
813
813
  * <en/> If not specified, it will be calculated based on the size attribute of the incoming node. If neither is specified, the default size is 10
814
- * @defaultVaule 10
814
+ * @defaultValue 10
815
815
  */
816
816
  nodeSize?: number | number[] | ((d?: Node) => number);
817
817
  /**
@@ -837,7 +837,7 @@ export interface ComboCombinedLayoutOptions {
837
837
  * }
838
838
  * });
839
839
  * ```
840
- * @defaultVaule ForceLayout
840
+ * @defaultValue ForceLayout
841
841
  */
842
842
  outerLayout?: Layout<any>;
843
843
  /**
@@ -852,14 +852,14 @@ export interface ComboCombinedLayoutOptions {
852
852
  * sortBy: 'id'
853
853
  * });
854
854
  * ```
855
- * @defaultVaule ConcentricLayout
855
+ * @defaultValue ConcentricLayout
856
856
  */
857
857
  innerLayout?: Layout<any>;
858
858
  /**
859
859
  * <zh/> Combo 内部的 padding 值,不用于渲染,仅用于计算力。推荐设置为与视图上 combo 内部 padding 值相同的值
860
860
  *
861
861
  * <en/> The padding value inside the combo, which is not used for rendering, but only for calculating force. It is recommended to set it to the same value as the combo internal padding value on the view
862
- * @defaultVaule 10
862
+ * @defaultValue 10
863
863
  */
864
864
  comboPadding?: ((d?: unknown) => number) | number | number[] | undefined;
865
865
  /**
@@ -879,7 +879,7 @@ interface CommonForceLayoutOptions {
879
879
  * <zh/> 布局的维度,2D 渲染时指定为 2;若为 3D 渲染可指定为 3,则将多计算 z 轴的布局
880
880
  *
881
881
  * <en/> The dimensions of the layout, specify 2 for 2D rendering; if it is 3D rendering, specify 3 to calculate the layout of the z axis
882
- * @defaultVaule 2
882
+ * @defaultValue 2
883
883
  */
884
884
  dimensions?: number;
885
885
  /**
@@ -892,14 +892,14 @@ interface CommonForceLayoutOptions {
892
892
  * <zh/> 当一次迭代的平均/最大/最小(根据distanceThresholdMode决定)移动长度小于该值时停止迭代。数字越小,布局越收敛,所用时间将越长
893
893
  *
894
894
  * <en/> When the average/max/min (depending on distanceThresholdMode) movement length of one iteration is less than this value, the iteration will stop. The smaller the number, the more converged the layout, and the longer the time it takes to use
895
- * @defaultVaule 0.4
895
+ * @defaultValue 0.4
896
896
  */
897
897
  minMovement?: number;
898
898
  /**
899
899
  * <zh/> 最大迭代次数,若为 0 则将自动调整
900
900
  *
901
901
  * <en/> Maximum number of iterations, if it is 0, it will be automatically adjusted
902
- * @defaultVaule 0
902
+ * @defaultValue 0
903
903
  */
904
904
  maxIteration?: number;
905
905
  /**
@@ -911,7 +911,7 @@ interface CommonForceLayoutOptions {
911
911
  * - 'mean': The average movement distance is less than minMovement when stopped iterating
912
912
  * - 'max': The maximum movement distance is less than minMovement when stopped iterating
913
913
  * - 'min': The minimum movement distance is less than minMovement when stopped iterating
914
- * @defaultVaule 'mean'
914
+ * @defaultValue 'mean'
915
915
  */
916
916
  distanceThresholdMode?: 'mean' | 'max' | 'min';
917
917
  /**
@@ -941,28 +941,28 @@ export interface ForceLayoutOptions extends CommonForceLayoutOptions {
941
941
  * <en/> The length of the edge
942
942
  * - number: fixed length
943
943
  * - ((edge?: Edge, source?: any, target?: any) => number): return length according to the edge information
944
- * @defaultVaule 200
944
+ * @defaultValue 200
945
945
  */
946
946
  linkDistance?: number | ((edge?: Edge, source?: any, target?: any) => number);
947
947
  /**
948
948
  * <zh/> 节点作用力,正数代表节点之间的引力作用,负数代表节点之间的斥力作用
949
949
  *
950
950
  * <en/> The force of the node, positive numbers represent the attraction force between nodes, and negative numbers represent the repulsion force between nodes
951
- * @defaultVaule 1000
951
+ * @defaultValue 1000
952
952
  */
953
953
  nodeStrength?: number | ((d?: Node) => number);
954
954
  /**
955
955
  * <zh/> 边的作用力(引力)大小
956
956
  *
957
957
  * <en/> The size of the force of the edge (attraction)
958
- * @defaultVaule 50
958
+ * @defaultValue 50
959
959
  */
960
960
  edgeStrength?: number | ((d?: Edge) => number);
961
961
  /**
962
962
  * <zh/> 是否防止重叠,必须配合下面属性 nodeSize 或节点数据中的 data.size 属性,只有在数据中设置了 data.size 或在该布局中配置了与当前图节点大小相同的 nodeSize 值,才能够进行节点重叠的碰撞检测
963
963
  *
964
964
  * <en/> Whether to prevent overlap, must be used with the following properties nodeSize or data.size in the node data, and only when the data.size is set in the data or the nodeSize value is configured with the same value as the current graph node size in the layout configuration, can the node overlap collision detection be performed
965
- * @defaultVaule true
965
+ * @defaultValue true
966
966
  */
967
967
  preventOverlap?: boolean;
968
968
  /**
@@ -981,42 +981,42 @@ export interface ForceLayoutOptions extends CommonForceLayoutOptions {
981
981
  * <zh/> 阻尼系数,取值范围 [0, 1]。数字越大,速度降低得越慢
982
982
  *
983
983
  * <en/> Damping coefficient, the range of the value is [0, 1]. The larger the number, the slower the speed will decrease
984
- * @defaultVaule 0.9
984
+ * @defaultValue 0.9
985
985
  */
986
986
  damping?: number;
987
987
  /**
988
988
  * <zh/> 一次迭代的最大移动长度
989
989
  *
990
990
  * <en/> The maximum movement length of one iteration
991
- * @defaultVaule 200
991
+ * @defaultValue 200
992
992
  */
993
993
  maxSpeed?: number;
994
994
  /**
995
995
  * <zh/> 库伦系数,斥力的一个系数,数字越大,节点之间的斥力越大
996
996
  *
997
997
  * <en/> Coulomb's coefficient, a coefficient of repulsion, the larger the number, the larger the repulsion between nodes
998
- * @defaultVaule 0.005
998
+ * @defaultValue 0.005
999
999
  */
1000
1000
  coulombDisScale?: number;
1001
1001
  /**
1002
1002
  * <zh/> 中心力大小,指所有节点被吸引到 center 的力。数字越大,布局越紧凑
1003
1003
  *
1004
1004
  * <en/> The size of the center force, which attracts all nodes to the center. The larger the number, the more compact the layout
1005
- * @defaultVaule 10
1005
+ * @defaultValue 10
1006
1006
  */
1007
1007
  gravity?: number;
1008
1008
  /**
1009
1009
  * <zh/> 斥力系数,数值越大,斥力越大
1010
1010
  *
1011
1011
  * <en/> The repulsion coefficient, the larger the number, the larger the repulsion
1012
- * @defaultVaule 1
1012
+ * @defaultValue 1
1013
1013
  */
1014
1014
  factor?: number;
1015
1015
  /**
1016
1016
  * <zh/> 控制每个迭代节点的移动速度
1017
1017
  *
1018
1018
  * <en/> Control the movement speed of each iteration node
1019
- * @defaultVaule 0.02
1019
+ * @defaultValue 0.02
1020
1020
  */
1021
1021
  interval?: number;
1022
1022
  /**
@@ -1033,7 +1033,7 @@ export interface ForceLayoutOptions extends CommonForceLayoutOptions {
1033
1033
  * <zh/> 若为 true,则 centripetalOptions.single 将为 100;centripetalOptions.leaf 将使用 getClusterNodeStrength 返回值;getClusterNodeStrength.center 将为叶子节点返回当前所有叶子节点的平均中心
1034
1034
  *
1035
1035
  * <en/> If it is true, centripetalOptions.single will be 100; centripetalOptions.leaf will use the return value of getClusterNodeStrength; getClusterNodeStrength.center will be the average center of all leaf nodes
1036
- * @defaultVaule false
1036
+ * @defaultValue false
1037
1037
  */
1038
1038
  leafCluster?: boolean;
1039
1039
  /**
@@ -1044,7 +1044,7 @@ export interface ForceLayoutOptions extends CommonForceLayoutOptions {
1044
1044
  * <zh/> 若为 true,将使用 nodeClusterBy 配置的节点数据中的字段作为聚类依据。 centripetalOptions.single、centripetalOptions.leaf、centripetalOptions.others 将使用 getClusterNodeStrength 返回值;leaf、centripetalOptions.center 将使用当前节点所属聚类中所有节点的平均中心
1045
1045
  *
1046
1046
  * <en/> If it is true, the node data configured by nodeClusterBy will be used as the clustering basis. centripetalOptions.single, centripetalOptions.leaf, centripetalOptions.others will use the return value of getClusterNodeStrength; leaf、centripetalOptions.center will use the average center of all nodes in the current cluster
1047
- * @defaultVaule false
1047
+ * @defaultValue false
1048
1048
  */
1049
1049
  clustering?: boolean;
1050
1050
  /**
@@ -1057,14 +1057,14 @@ export interface ForceLayoutOptions extends CommonForceLayoutOptions {
1057
1057
  * <zh/> 配合 clustering 和 nodeClusterBy 使用,指定聚类向心力的大小
1058
1058
  *
1059
1059
  * <en/> Use it with clustering and nodeClusterBy to specify the size of the centripetal force of the cluster
1060
- * @defaultVaule 20
1060
+ * @defaultValue 20
1061
1061
  */
1062
1062
  clusterNodeStrength?: number | ((node: Node) => number);
1063
1063
  /**
1064
1064
  * <zh/> 防止重叠的力强度,范围 [0, 1]
1065
1065
  *
1066
1066
  * <en/> The strength of the force that prevents overlap, range [0, 1]
1067
- * @defaultVaule 1
1067
+ * @defaultValue 1
1068
1068
  */
1069
1069
  collideStrength?: number;
1070
1070
  /**
@@ -1126,35 +1126,35 @@ export interface ForceAtlas2LayoutOptions extends CommonForceLayoutOptions {
1126
1126
  * <zh/> 斥力系数,可用于调整布局的紧凑程度。kr 越大,布局越松散
1127
1127
  *
1128
1128
  * <en/> The repulsive coefficient, which can be used to adjust the compactness of the layout. The larger kr is, the more relaxed the layout is
1129
- * @defaultVaule 5
1129
+ * @defaultValue 5
1130
1130
  */
1131
1131
  kr?: number;
1132
1132
  /**
1133
1133
  * <zh/> 重力系数。kg 越大,布局越聚集在中心
1134
1134
  *
1135
1135
  * <en/> The gravitational coefficient. The larger kg is, the more clustered the layout is in the center
1136
- * @defaultVaule 1
1136
+ * @defaultValue 1
1137
1137
  */
1138
1138
  kg?: number;
1139
1139
  /**
1140
1140
  * <zh/> 控制迭代过程中,节点移动的速度
1141
1141
  *
1142
1142
  * <en/> Control the speed of node movement during iteration
1143
- * @defaultVaule 0.1
1143
+ * @defaultValue 0.1
1144
1144
  */
1145
1145
  ks?: number;
1146
1146
  /**
1147
1147
  * <zh/> 迭代过程中,最大的节点移动的速度上限
1148
1148
  *
1149
1149
  * <en/> The upper limit of the maximum node movement speed during iteration
1150
- * @defaultVaule 10
1150
+ * @defaultValue 10
1151
1151
  */
1152
1152
  ksmax?: number;
1153
1153
  /**
1154
1154
  * <zh/> 迭代接近收敛时停止震荡的容忍度
1155
1155
  *
1156
1156
  * <en/> The tolerance for stopping oscillation when iteration is close to convergence
1157
- * @defaultVaule 0.1
1157
+ * @defaultValue 0.1
1158
1158
  */
1159
1159
  tao?: number;
1160
1160
  /**
@@ -1164,7 +1164,7 @@ export interface ForceAtlas2LayoutOptions extends CommonForceLayoutOptions {
1164
1164
  * <en/> Clustering mode, the clustering will be more compact in the 'linlog' mode
1165
1165
  * - 'normal':normal mode
1166
1166
  * - 'linlog':linlog mode
1167
- * @defaultVaule 'normal'
1167
+ * @defaultValue 'normal'
1168
1168
  */
1169
1169
  mode?: 'normal' | 'linlog';
1170
1170
  /**
@@ -1175,14 +1175,14 @@ export interface ForceAtlas2LayoutOptions extends CommonForceLayoutOptions {
1175
1175
  * <zh/> 必须配合下面属性 nodeSize 或节点数据中的 data.size 属性,只有在数据中设置了 data.size 或在该布局中配置了与当前图节点大小相同的 nodeSize 值,才能够进行节点重叠的碰撞检测
1176
1176
  *
1177
1177
  * <en/> Must be used with the following properties: nodeSize or data.size in the node data. Only when data.size or nodeSize with the same value as the current graph node size is set in the layout configuration, can the collision detection of node overlap be performed
1178
- * @defaultVaule false
1178
+ * @defaultValue false
1179
1179
  */
1180
1180
  preventOverlap?: boolean;
1181
1181
  /**
1182
1182
  * <zh/> 是否打开 hub 模式。若为 true,相比与出度大的节点,入度大的节点将会有更高的优先级被放置在中心位置
1183
1183
  *
1184
1184
  * <en/> Whether to open the hub mode. If true, nodes with high out-degree will have higher priority than nodes with high in-degree to be placed in the center
1185
- * @defaultVaule false
1185
+ * @defaultValue false
1186
1186
  */
1187
1187
  dissuadeHubs?: boolean;
1188
1188
  /**
@@ -1241,35 +1241,35 @@ export interface FruchtermanLayoutOptions extends CommonForceLayoutOptions {
1241
1241
  * <zh/> 中心力大小,指所有节点被吸引到 center 的力。数字越大,布局越紧凑
1242
1242
  *
1243
1243
  * <en/> The size of the center force, which means the force that all nodes are attracted to the center. The larger the number, the more compact the layout
1244
- * @defaultVaule 10
1244
+ * @defaultValue 10
1245
1245
  */
1246
1246
  gravity?: number;
1247
1247
  /**
1248
1248
  * <zh/> 每次迭代节点移动的速度。速度太快可能会导致强烈震荡
1249
1249
  *
1250
1250
  * <en/> The speed at which the node moves in each iteration. A speed that is too fast may cause strong oscillations
1251
- * @defaultVaule 5
1251
+ * @defaultValue 5
1252
1252
  */
1253
1253
  speed?: number;
1254
1254
  /**
1255
1255
  * <zh/> 是否按照聚类布局
1256
1256
  *
1257
1257
  * <en/> Whether to layout according to clustering
1258
- * @defaultVaule false
1258
+ * @defaultValue false
1259
1259
  */
1260
1260
  clustering?: boolean;
1261
1261
  /**
1262
1262
  * <zh/> 聚类内部的重力大小,影响聚类的紧凑程度,在 clustering 为 true 时生效
1263
1263
  *
1264
1264
  * <en/> The size of the gravity inside the cluster, which affects the compactness of the cluster, and it takes effect when clustering is true
1265
- * @defaultVaule 10
1265
+ * @defaultValue 10
1266
1266
  */
1267
1267
  clusterGravity?: number;
1268
1268
  /**
1269
1269
  * <zh/> 聚类布局依据的节点数据 data 中的字段名,cluster: true 时使用
1270
1270
  *
1271
1271
  * <en/> The field name of the node data data in the data, which is used when cluster is true
1272
- * @defaultVaule 'cluster'
1272
+ * @defaultValue 'cluster'
1273
1273
  */
1274
1274
  nodeClusterBy?: string;
1275
1275
  /**