Class Node

Index

Constructors

Properties

annotation branchLength children height hybridID id label parent rttDist

Methods

addChild applyPostOrder applyPreOrder copy getAncestors isHybrid isLeaf isLeftOf isRoot isSingleton removeChild toString

Constructors

constructor

new Node(id: number): Node
The constructor of the Node class.
Parameters
- id: number
  node id number
Returns Node
- Defined in tree/node.ts:27

Properties

annotation

annotation: { [key: string]: any }

Node annotation(s)

branchLength

branchLength: undefined | number

Length of descending branch

children

children: Node[]

descending nodes

height

height: undefined | number

Heigh above the root

hybridID

hybridID: undefined | number

ID of node if hybrid

id

id: number

Node id

label

label: undefined | string

Node label

parent

parent: undefined | Node

Node parent

rttDist

rttDist: undefined | number

Root to tip distance for each tip

Methods

addChild

addChild(child: Node): void
Appends child node to children
Parameters
- child: Node
Returns void
- Defined in tree/node.ts:51

applyPostOrder

applyPostOrder<T>(f: (node: Node) => T): T[]
Apply a function f() to each node in a subtree descending from node in post-order
Type Parameters
- T
Parameters
- f: (node: Node) => T
Returns T[]
- Defined in tree/node.ts:176

applyPreOrder

applyPreOrder<T>(f: (node: Node) => T): T[]
Apply a function f() to each node in a subtree descending from node in pre-order
Type Parameters
- T
Parameters
- f: (node: Node) => T
Returns T[]
- Defined in tree/node.ts:152

copy

copy(): Node
Produce a deep copy of the clade below this node

Returns Node
- Defined in tree/node.ts:132

getAncestors

getAncestors(): Node[]
Gets ancestral nodes. Wraps _getAncestors to handle concat types.

Returns Node[]
- Defined in tree/node.ts:100

isHybrid

isHybrid(): boolean
Checks if a node is a hybrid node

Returns boolean
- Defined in tree/node.ts:82

isLeaf

isLeaf(): boolean
Check if a node is a Leaf

Returns boolean
- Defined in tree/node.ts:72

isLeftOf

isLeftOf(other: Node): undefined | boolean
Returns true if this node is left of the argument on the tree. If one node is the direct ancestor of the other, the result is undefined.
Parameters
- other: Node
Returns undefined | boolean
- Defined in tree/node.ts:112

isRoot

isRoot(): boolean
Checks if a node is root

Returns boolean
- Defined in tree/node.ts:67

isSingleton

isSingleton(): boolean
Checks if node only has one child

Returns boolean
- Defined in tree/node.ts:77

removeChild

removeChild(child: Node): void
Removes a node from children
Parameters
- child: Node
Returns void
- Defined in tree/node.ts:60

toString

toString(): string
Ensure nodes with unique IDs have unique hashes.

Returns string
- Defined in tree/node.ts:43