Class TreeUtils

Class to transform and manipulate tree like structures

Constructors

constructor

Methods

add addUnshift computePaths delete deleteBy edit filter find forEach get getAncestors getBreath getDegree getDepth getDescendants getDistance getHeight getChildren getLeafs getLevel getNeighbours getNodesAtLevel getParent getPathNodes getSiblings getSize getSubTree getTreeDegree getWidth list2Tree tree2List

Constructors

constructor

Methods

add

  • add(
        tree: any[],
        parentId: any,
        childData: any,
        ...anotherChildData: any[],
    ): void

  • Method to add new node to tree, node will be added as last child (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

    • ...anotherChildData: any[]

      data of new additional nodes

    Returns void

addUnshift

  • addUnshift(
        tree: any[],
        parentId: any,
        childData: any,
        ...anotherChildData: any[],
    ): void

  • Method to add new node to tree, node will be added as first child (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

    • ...anotherChildData: any[]

      data of new additional nodes

    Returns void

computePaths

  • computePaths(
        tree: any[],
        pathComputationProperty: string,
        delimiter?: string,
        pathProperty?: string,
        originPath?: string,
    ): void

  • Method to compute paths for nodes (mutable operation) path property will be added into each node e.g. {path: "parent/child"...}

    Parameters

    • tree: any[]

      tree structure

    • pathComputationProperty: string

      property to use for path computation

    • delimiter: string = '/'

      to delimit path

    • pathProperty: string = 'path'

      property where path will be stored

    • originPath: string = '/'

      path of top level nodes

    Returns void

delete

  • delete(tree: any[], id: any): 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

    deleted node, if nothing deleted then returns null

deleteBy

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

  • Method to delete node in tree by given callback function (mutable operation!)

    Parameters

    • tree: any[]

      tree structure for node deleting

    • fn: (item: any) => boolean

      callback function to remove all nodes

    Returns any[]

    deleted nodes

    Example

    utils.deleteBy(tree, item => item.id === myId);

edit

  • edit(tree: any[], id: any, data: any): 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

filter

  • filter(tree: any[], fn: (item: any) => boolean): 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

    Returns any

    all found nodes

    Example

    utils.filter(tree, item => item.id === myId);

find

  • find(tree: any[], fn: (item: any) => boolean): 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

    Returns any

    found node

    Example

    utils.find(tree, item => item.id === myId);

forEach

  • forEach(tree: any[], fn: (item: any) => any): void

  • Method to iterate over all nodes

    Parameters

    • tree: any[]

      tree structure to iterate over

    • fn: (item: any) => any

      callback function to perform

    Returns void

get

  • get(tree: any[], id: any): 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

getAncestors

  • getAncestors(tree: any[], id: any): 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

getBreath

  • getBreath(tree: any[], id: any): 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

getDegree

  • getDegree(tree: any[], id: any): 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

getDepth

  • getDepth(tree: any[], id: any): 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

getDescendants

  • getDescendants(tree: any[], id: any): 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

getDistance

  • getDistance(tree: any[], id1: any, id2: any): 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

getHeight

  • getHeight(tree: any[], id: any): 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

getChildren

  • getChildren(tree: any[], id: any): 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

getLeafs

  • getLeafs(tree: any[], id: any): 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

getLevel

  • getLevel(tree: any[], id: any): 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

getNeighbours

  • getNeighbours(tree: any[], id: any): 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

getNodesAtLevel

  • getNodesAtLevel(tree: any[], level: number): 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

getParent

  • getParent(tree: any[], id: any): 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

getPathNodes

  • getPathNodes(tree: any[], id: any): 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)

getSiblings

  • getSiblings(tree: any[], id: any): 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

getSize

  • getSize(tree: any[], id: any): 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

getSubTree

  • getSubTree(tree: any[], id: any): 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

getTreeDegree

  • getTreeDegree(tree: any[]): 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

getWidth

  • getWidth(tree: any[], level: number): 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

list2Tree

  • list2Tree(list: any[], rootParentId?: any): 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

tree2List

  • tree2List(tree: any[]): 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

Settings

Member Visibility

On This Page

Constructors
Methods
MMNEPVFCICPMFPCPTTAAATR