Class TreeUtils

Class to transform and manipulate tree like structures

Hierarchy

TreeUtils

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TreeUtils(config?: IConfig): TreeUtils

- Defined in main.ts:56
Constructor of class

Parameters
- Optional config: IConfig
  
  to configure class, if configuration option is omitted, default one is used
Returns TreeUtils

Properties

Private Readonly childrenProp

childrenProp: string

Name of property where child nodes are stored (default value is children)

Private Readonly idProp

idProp: string

Name of unique identifier property in nodes (default value is id)

Private Readonly parentIdProp

parentIdProp: string

Name of parent identifier property in nodes (default value is parentId)

Methods

addNode

addNode(tree: any[], parentId: any, childData: any): void

- Defined in main.ts:158
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
Returns void

deleteNode

deleteNode(tree: any[], id: any): any

- Defined in main.ts:144
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

editNode

editNode(tree: any[], id: any, data: any): void

- Defined in main.ts:177
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

findAllChildrenNodes

findAllChildrenNodes(tree: any[], id: any): any[]

- Defined in main.ts:192
Method to find all children 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

findAllParentNodes

findAllParentNodes(tree: any[], id: any): any[]

- Defined in main.ts:219
Method to find all parents 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

findAllTreeNodes

findAllTreeNodes(tree: any[], fn: ((item: any) => boolean)): any

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

findNodeParent

findNodeParent(tree: any[], id: any, parent?: any): any

- Defined in main.ts:236
Method to find parent of given node in tree structure

Parameters
- tree: any[]
  
  tree structure to search in
- id: any
  
  identifier of node
- parent: any = null
  
  parent node, if we found something (for recursion only)
Returns any
found parent node

findTreeNode

findTreeNode(tree: any[], fn: ((item: any) => boolean)): any

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

findTreeNodeById

findTreeNodeById(tree: any[], id: any): any

- Defined in main.ts:98
Method to find node in tree structure by given id

Parameters
- tree: any[]
  
  tree structure to search in
- id: any
  
  identifier of node
Returns any
found node

Private getChildrenNodes

getChildrenNodes(node: any): any[]

- Defined in main.ts:206
Helper method to recursively get all children nodes of given node in tree structure

Parameters
- node: any
  
  we want to get all of its children
Returns any[]
all found children nodes

list2Tree

list2Tree(list: any[], parentId?: any): any[]

- Defined in main.ts:67
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)
- parentId: any = null
  
  id of parent node
Returns any[]

tree2List

tree2List(tree: any[], parentId?: any): any[]

- Defined in main.ts:81
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)
- parentId: any = null
Returns any[]

Static Private deepCopy

deepCopy(obj: any): any

- Defined in main.ts:252
Helper method to deep clone object

Parameters
- obj: any
  
  object to be cloned
Returns any
deep cloned object

Generated using TypeDoc