Item API

Item API

Treebeard is designed to work with hierarchical data similar to a file structure. In this data type each item (whether a folder or item) is an instance of the Item class in treebeard. In many of the hooks you will be given item as an argument. For instance you have the option to run movecheck before moves.

    movecheck(to,from){
        if(to.data.receive){
            return true;
        } else {
            return false;
        }
   }

In this case both to and from are instances of the Item class.

Structure of the Item

        {
            children: []  // an array of Item objects
            data: {}     // Your data
            depth: 1
            id: 1
            kind: "folder"
            open: true
            parentID: 0
        }

Finding Related Items

Treebeard provides methods to find related Items from the item you are given.

Next sibling

    var next = item.next(); 

Previous Sibling

    var previous = item.prev();

Immediate Child by ID

    var child = item.child(42);

Parent

    var parent = item.parent(); 

Item Operations

Add item

    var myItem = new Item(myData);
    item.add(myItem)

Delete Item

    item.remove_self();

Delete Child By ID

    item.remove_child(42);

Move item underneath another item

    // called form the item to be moved
    // moves the item to underneath item id 42
    item.move(42)

Check if item is ancestor

    if(item.isAncestor(anotherItem)){
    // ...
    }

Check if item is descendant

    if(item.isDescendant(anotherItem)){
    // ...
    }