ClassTreeUtils

Class to transform and manipulate tree like structures

Constructors

constructor

new TreeUtils(config?): TreeUtils
Constructor of class
Parameters
- Optionalconfig: IConfig
  to configure class, if configuration option is omitted, default one is used
Returns TreeUtils
- Defined in simple-tree-utils.ts:56

Methods

add

add(tree, parentId, childData, ...anotherChildData): void
Method to add new node to tree (mutable operation!)
Parameters
- tree: any[]
  tree structure for node adding
- parentId: any
  identifier of parent node, null if new node should be on root level
- childData: any
  data of new node
- Rest...anotherChildData: any[]
  data of new additional nodes
Returns void
- Defined in simple-tree-utils.ts:171

delete

delete(tree, id): any
Method to delete node in tree by given id (mutable operation!)
Parameters
- tree: any[]
  tree structure for node deleting
- id: any
  identifier of node to delete
Returns any
- Defined in simple-tree-utils.ts:156

edit

edit(tree, id, data): void
Method to update node by id with given data in tree (mutable operation!)
Parameters
- tree: any[]
  tree structure for node editing
- id: any
  identifier of node to be updated
- data: any
  new data of node (you should also pass children if you want to keep it)
Returns void
- Defined in simple-tree-utils.ts:193

filter

filter(tree, fn): any
Method to find all nodes in tree structure by given callback function
Parameters
- tree: any[]
  tree structure to search in
- fn: ((item: any) => boolean)
  callback function to find all nodes
  - - (item): boolean
    - Parameters
      item: any
      Returns boolean
Returns any
all found nodes
Example
```
utils.filter(tree, item => item.id === myId);
```
- Defined in simple-tree-utils.ts:144

find

find(tree, fn): any
Method to find node in tree structure by given callback function
Parameters
- tree: any[]
  tree structure to search in
- fn: ((item: any) => boolean)
  callback function to find node
  - - (item): boolean
    - Parameters
      item: any
      Returns boolean
Returns any
found node
Example
```
utils.find(tree, item => item.id === myId);
```
- Defined in simple-tree-utils.ts:124

get

get(tree, id): any
Method to get node in tree structure by given id
Parameters
- tree: any[]
  tree structure to search in
- id: any
  identifier of node
Returns any
found node
- Defined in simple-tree-utils.ts:110

getAncestors

getAncestors(tree, id): any[]
Method to get ancestors of given node in tree structure
Parameters
- tree: any[]
  tree structure to search in
- id: any
  identifier of node
Returns any[]
all found parent nodes
- Defined in simple-tree-utils.ts:232

getBreath

getBreath(tree, id): number
Method to get breath of subtree (the number of leaves in subtree)
Parameters
- tree: any[]
  tree structure
- id: any
  identifier of node
Returns number
breath of subtree
- Defined in simple-tree-utils.ts:347

getDegree

getDegree(tree, id): number
Method to get degree of node (for a given node, its number of children. A leaf, by definition, has degree zero)
Parameters
- tree: any[]
  tree structure
- id: any
  identifier of node
Returns number
degree of node
- Defined in simple-tree-utils.ts:377

getDepth

getDepth(tree, id): number
Method to get depth of node (the depth of a node is the length of the path to its root i.e., its root path)
Parameters
- tree: any[]
  tree structure
- id: any
  identifier of node
Returns number
depth of node
- Defined in simple-tree-utils.ts:357

getDescendants

getDescendants(tree, id): any[]
Method to get descendant nodes of given node in tree structure
Parameters
- tree: any[]
  tree structure to search in
- id: any
  identifier of node
Returns any[]
all found children nodes
- Defined in simple-tree-utils.ts:208

getDistance

getDistance(tree, id1, id2): number
Method to get distance between 2 nodes
Parameters
- tree: any[]
  tree structure
- id1: any
  identifier of first node
- id2: any
  identifier of second node
Returns number
distance between 2 nodes, returns -1, if there is no connection between nodes
- Defined in simple-tree-utils.ts:454

getHeight

getHeight(tree, id): number
Method to get height of node (the height of a node is the length of the longest downward path to a leaf from that node)
Parameters
- tree: any[]
  tree structure
- id: any
  identifier of node
Returns number
height of node
- Defined in simple-tree-utils.ts:432

getChildren

getChildren(tree, id): any[]
Method to get children of given node in tree structure
Parameters
- tree: any[]
  tree structure to search in
- id: any
  identifier of node
Returns any[]
children nodes of node
- Defined in simple-tree-utils.ts:286

getLeafs

getLeafs(tree, id): any
Method to get leafs of subtree from given node
Parameters
- tree: any[]
  tree structure to search in
- id: any
  identifier of node
Returns any
leafs of nodes
- Defined in simple-tree-utils.ts:316

getLevel

getLevel(tree, id): number
Method to get level of node (the level of a node is the number of edges along the unique path between it and the root node)
Parameters
- tree: any[]
  tree structure
- id: any
  identifier of node
Returns number
level of node
- Defined in simple-tree-utils.ts:367

getNeighbours

getNeighbours(tree, id): any
Method to get neighbours (neighbour is parent or child) of given node in tree structure
Parameters
- tree: any[]
  tree structure to search in
- id: any
  identifier of node
Returns any
neighbours of node
- Defined in simple-tree-utils.ts:296

getNodesAtLevel

getNodesAtLevel(tree, level): any[]
Method to get nodes in tree at specific level
Parameters
- tree: any[]
  tree structure to search in
- level: number
  desired level
Returns any[]
all nodes, that are on specific level
- Defined in simple-tree-utils.ts:396

getParent

getParent(tree, id): any
Method to get parent of given node in tree structure
Parameters
- tree: any[]
  tree structure to search in
- id: any
  identifier of node
Returns any
found parent node, otherwise null
- Defined in simple-tree-utils.ts:259

getPathNodes

getPathNodes(tree, id): any[]
Method to get nodes that are part of path from root Alias for getAncestors method
Parameters
- tree: any[]
  tree structure to search in
- id: any
  identifier of node
Returns any[]
all nodes that are part of path (ordered from root)
- Defined in simple-tree-utils.ts:249

getSiblings

getSiblings(tree, id): any
Method to get siblings of given node in tree structure
Parameters
- tree: any[]
  tree structure to search in
- id: any
  identifier of node
Returns any
siblings of node
- Defined in simple-tree-utils.ts:306

getSize

getSize(tree, id): number
Method to get size of subtree (number of nodes in the subtree)
Parameters
- tree: any[]
  tree structure
- id: any
  identifier of node
Returns number
size of subtree
- Defined in simple-tree-utils.ts:337

getSubTree

getSubTree(tree, id): any[]
Method to get subtree from given node (children of node) Alias for getChildren method
Parameters
- tree: any[]
  tree structure to search in
- id: any
  identifier of node
Returns any[]
subtree
- Defined in simple-tree-utils.ts:327

getTreeDegree

getTreeDegree(tree): number
Method to get degree of tree (the degree of a tree is the maximum degree of a node in the tree)
Parameters
- tree: any[]
  tree structure
Returns number
degree of tree
- Defined in simple-tree-utils.ts:386

getWidth

getWidth(tree, level): number
Method to get width on level in tree (the number of nodes in a level)
Parameters
- tree: any[]
  tree structure
- level: number
  desired level
Returns number
width on desired level
- Defined in simple-tree-utils.ts:422

list2Tree

list2Tree(list, rootParentId?): any[]
Convert list to tree like structure
Parameters
- list: any[]
  list of objects, objects need to have id (as you configured, or 'id' by default) and parentId property (as you configured, or 'parentId' by default)
- rootParentId: any = null
  id of root parent nodes (if not specified, root nodes are nodes with parentId of null)
Returns any[]
tree structure
- Defined in simple-tree-utils.ts:68

tree2List

tree2List(tree): any[]
Convert tree like structure to list
Parameters
- tree: any[]
  tree of objects, objects need to have children (as you configured, or 'children' by default) and parentId property (as you configured, or 'parentId' by default)
Returns any[]
list
- Defined in simple-tree-utils.ts:82