Skip to content

Commit bfb15db

Browse files
authored
docs: fix comments of combo-combined layout (#225)
1 parent 3a70d63 commit bfb15db

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

packages/layout/src/types.ts

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -844,12 +844,14 @@ export interface ComboCombinedLayoutOptions {
844844
*/
845845
spacing?: number | ((d?: Node) => number);
846846
/**
847-
* <zh/> 最外层的布局算法,默认为 gForce
847+
* <zh/> 最外层的布局算法,默认为 force
848848
*
849-
* <en/> The outermost layout algorithm, default to gForce
849+
* <en/> The outermost layout algorithm, default to force
850850
* @example
851851
* ```ts
852-
* outerLayout: new G6.Layout['gForce']({
852+
* import { ForceLayout } from '@antv/layout';
853+
*
854+
* outerLayout: new ForceLayout({
853855
* gravity: 1,
854856
* factor: 2,
855857
* linkDistance: (edge: any, source: any, target: any) => {
@@ -858,7 +860,7 @@ export interface ComboCombinedLayoutOptions {
858860
* }
859861
* });
860862
* ```
861-
* @defaultVaule GForce 实例
863+
* @defaultVaule ForceLayout
862864
*/
863865
outerLayout?: Layout<any>;
864866
/**
@@ -867,11 +869,13 @@ export interface ComboCombinedLayoutOptions {
867869
* <en/> The layout algorithm inside the combo, which needs to use a synchronized layout algorithm, default to concentric
868870
* @example
869871
* ```ts
870-
* innerLayout: new G6.Layout['concentric']({
872+
* import { ConcentricLayout } from '@antv/layout';
873+
*
874+
* innerLayout: new ConcentricLayout({
871875
* sortBy: 'id'
872876
* });
873877
* ```
874-
* @defaultVaule Concentric 实例
878+
* @defaultVaule ConcentricLayout
875879
*/
876880
innerLayout?: Layout<any>;
877881
/**

0 commit comments

Comments
 (0)