g6/packages/site/docs/apis/interfaces/layout/GridLayoutOptions.en.md
pomelo 1099252812
Feat: Add API Docs (#4877)
* feat: update api-doc config

* feat: add doc input

* feat: update docs
2023-08-30 19:46:37 +08:00

2.7 KiB

title
GridLayoutOptions

Overview - v5.0.0-alpha.9 / Modules / layout / GridLayoutOptions

layout.GridLayoutOptions

Properties

begin

Optional begin: PointTuple

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:130


cols

Optional cols: number

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:136


condense

Optional condense: boolean

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:134


height

Optional height: number

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:129


nodeSize

Optional nodeSize: number | number[]

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:132


nodeSpacing

Optional nodeSpacing: number | (node?: Node) => number

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:142


position

Optional position: (node?: Node) => { col?: number ; row?: number }

Type declaration

▸ (node?): Object

Parameters
Name Type
node? Node
Returns

Object

Name Type
col? number
row? number

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:138


preventOverlap

Optional preventOverlap: boolean

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:131


preventOverlapPadding

Optional preventOverlapPadding: number

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:133


rows

Optional rows: number

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:135


sortBy

Optional sortBy: string

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:137


width

Optional width: number

Defined in

node_modules/.pnpm/@antv+layout@1.2.5_workerize-loader@2.0.2/node_modules/@antv/layout/lib/types.d.ts:128