forEach

iterates over all items of a tree collection

void forEach(function callback,string parentID,number level);

Parameters

callbackfunctiona function that will iterate over items of a tree collection
parentIDstringoptional, the parent id. If not specified, the function will start iterating over from the root item.
levelnumberoptional, the number of levels to be iterated over. If not specified, each nested level will be visited.

Example

treecollection.forEach(function(element, index, array) {
    console.log("This is an item of treeCollection: ", element);
    console.log("This is an index of the element: ", index);
    console.log("This is an array of the elements: ", array);
});

Details

The callback function takes three parameters:

  • element - (object) the object of an item of a tree collection
  • index - (number) the index of an item
  • array - (array) an array with items
Change log

added in v6.4

Back to top