HierarchyPointNode

type HierarchyPointNode<T> = object;

Defined in: packages/components/src/components/PhyloTree/types.ts:12

A node of the laid-out tree: the source Tree data, parent/children links, a stable id (as used by TreeSelection) and the pixel position the layout gave it.

Type Parameters

Type Parameter
T

Properties

id

id: string;

Defined in: packages/components/src/components/PhyloTree/types.ts:14

data.id when present, else a positional path (stable across renders, not across re-sorts).

---

data

data: T;

Defined in: packages/components/src/components/PhyloTree/types.ts:15

---

parent

parent: HierarchyPointNode<T> | null;

Defined in: packages/components/src/components/PhyloTree/types.ts:16

---

children?

optional children?: HierarchyPointNode<T>[];

Defined in: packages/components/src/components/PhyloTree/types.ts:17

---

depth

depth: number;

Defined in: packages/components/src/components/PhyloTree/types.ts:18

---

x

x: number;

Defined in: packages/components/src/components/PhyloTree/types.ts:20

Spread-axis position (rendered as the vertical position).

---

y

y: number;

Defined in: packages/components/src/components/PhyloTree/types.ts:22

Depth-axis position (rendered as the horizontal position).

---

radius?

optional radius?: number;

Defined in: packages/components/src/components/PhyloTree/types.ts:24

Distance from the centre, in pixels. Populated by "radial" only.

---

angle?

optional angle?: number;

Defined in: packages/components/src/components/PhyloTree/types.ts:26

Angle in radians, 0 pointing right. Populated by "radial" only.

---

collapsedLeafCount?

optional collapsedLeafCount?: number;

Defined in: packages/components/src/components/PhyloTree/types.ts:28

For a collapsed clade drawn as a single tip: how many leaves it hides.