g6/examples/net/circular/API.en.md
2020-02-14 11:30:12 +08:00

1.6 KiB

title
API

center

Type: Array
Example: [ 0, 0 ]
Default: The center of the graph
Required: false
Description: The center of the layout

radius

Type: Number
Default: null
Required: false
Description: The radius of the circle. If the raidus exists, startRadius and endRadius do not take effect.

startRadius

Type: Number
Default: null
Required: false
Description: The start radius of spiral layout

endRadius

Type: Number
Default: null
Required: false
Description: The end radius of spiral layout

clockwise

Type: Boolean
Default: true
Required: false
Description: Whether to layout clockwisely

divisions

Type: Number
Default: 1
Required: false
Description: The division number of the nodes on the circle. Takes effect when endRadius - startRadius !== 0

ordering

Type: String
Default: false
Options: null | 'topology' | 'degree'
Required: false
Description: The ordering method for nodes. null by default, which means the nodes are arranged in data order. 'topology' means in topology order; 'degree' means in degree order.

angleRatio

Type: Number
Default: 1
Required: false
Description: How many 2*PIs Between the first node and the last node

workerEnabled

Type: Boolean
Default: false
Required: false
Description: Whether to enable the web-worker in case layout calculation takes too long to block page interaction