pivotick v3.0.0

---

pivotick / LayoutOptions / EgoTreeLayoutOptions

Interface: EgoTreeLayoutOptions

Defined in: interfaces/LayoutOptions.ts:107

Extends

• Omit<TreeLayoutOptions, "rootId" | "type" | "parentKey" | "depthKey">

Properties

horizontal?

optional horizontal: boolean

Defined in: interfaces/LayoutOptions.ts:72

Should the nodes be placed horizontally rather than vertically

Default

false

Inherited from

TreeLayoutOptions.horizontal

---

levelSpacing?

optional levelSpacing: number

Defined in: interfaces/LayoutOptions.ts:98

Multiplies the distance between consecutive levels — the depth axis of the tree, or the gap between rings in radial mode. At 1 the tree is scaled to fill the canvas.

Default

1

Inherited from

TreeLayoutOptions.levelSpacing

---

radial?

optional radial: boolean

Defined in: interfaces/LayoutOptions.ts:67

Should the nodes be placed radially instead of vertically

Default

false

Inherited from

TreeLayoutOptions.radial

---

radialGap

radialGap: number

Defined in: interfaces/LayoutOptions.ts:82

The grap between each layers used in the radial mode

Default

750

Inherited from

TreeLayoutOptions.radialGap

---

rootId

rootId: string

Defined in: interfaces/LayoutOptions.ts:110

---

rootIdAlgorithmFinder

rootIdAlgorithmFinder: TreeLayoutAlgorithm

Defined in: interfaces/LayoutOptions.ts:77

The algorithm to use to find the root of the tree

Default

'MaxReachability'

Inherited from

TreeLayoutOptions.rootIdAlgorithmFinder

---

siblingSpacing?

optional siblingSpacing: number

Defined in: interfaces/LayoutOptions.ts:104

Multiplies the distance between nodes within a level — the breadth axis. Ignored in radial mode, where a level always spans the full circle.

Default

1

Inherited from

TreeLayoutOptions.siblingSpacing

---

spacing?

optional spacing: "manual" | "auto"

Defined in: interfaces/LayoutOptions.ts:92

Whether the two spacing multipliers tune themselves from the size of the nodes and the shape of the tree, or stay exactly where they are put.

'auto' is the default — except for a tree that sets levelSpacing or siblingSpacing explicitly, which is taken as having made up its mind. Turning either multiplier by hand afterwards also leaves auto, permanently.

Default

'auto'

Inherited from

TreeLayoutOptions.spacing

---

strength?

optional strength: number

Defined in: interfaces/LayoutOptions.ts:62

The strength of the force keeping the nodes placed to form a tree in place

Default

0.1

Inherited from

TreeLayoutOptions.strength

---

type

type: "egoTree"

Defined in: interfaces/LayoutOptions.ts:109