TreeNode

Retrieve all children, excluding filtered out nodes (by traversing sub nodes)

Retrieve all children, including filtered out nodes (by traversing sub nodes)

Depth in the tree at which this node exists. First visual level of nodes are at level 0, their direct children at level 1 and so on.

This static configuration option allows you to control whether an empty parent task should be converted into a leaf. Enable/disable it for a whole class:

Model.convertEmptyParentToLeaf = false;

By specifying true, all empty parents will be considered leafs. Can also be assigned a configuration object with the following Boolean properties to customize the behaviour:

Model.convertEmptyParentToLeaf = {
    onLoad   : false,
    onRemove : true
}

Count all children (including sub-children) for a node (in its `firstStore´)

Get the first child of this node

Is a leaf node in a tree structure?

Returns true for parent nodes with children loaded (there might still be no children)

Is a parent node in a tree structure?

Returns true if this node is the root of the tree

Get the last child of this node

Get the next sibling of this node

This is a read-only property providing access to the parent node.

Reading this property returns the id of the parent node, if this record is a child of a node.

Setting this property appends this record to the record with the passed id in the same store that this record is already in.

Note that setting this property is only valid if this record is already part of a tree store.

This is not intended for general use. This is for when a server responds to a record mutation and the server decides to move a record to a new parent. If a parentId property is passed in the response data for a record, that record will be moved.

Get the previous sibling of this node

Returns count of all preceding sibling nodes (including their children).

Count visible (expanded) children (including sub-children) for a node (in its firstStore)

Child nodes. To allow loading children on demand, specify children : true in your data. Omit the field for leaf tasks.

Note, if the tree store loads data from a remote origin, make sure readUrl is specified, and optionally parentIdParamName is set, otherwise loadChildren has to be implemented.

This field is added to the class at runtime when the Store is configured with lazyLoad. If set on a parent record at load time, that parent will not cause any more child load requests. If omitted, it will be automatically set to true when a load request receives fewer child records than requested.

To specifically set this field for a parent at its children load request, provide it as a property in the data response object:

return {
   data : [ ... ],
   isFullyLoaded : true
   total : 123
}

Or to include grandchildren for a parent, it can be provided as a property on the record data object:

return {
   data : [{
      id : 1,
      name : 'My Parent',
      isFullyLoaded : true,
      expanded : true,
      children : [{
         id : 2,
         name : 'My Child'
     }]
   }],
   total : 123
}

This is a read-only field provided in server synchronization packets to specify which position the node takes in the parent's ordered children array. This index is set on load and gets updated on reordering nodes in tree. Sorting and filtering have no effect on it.

This is a read-only field provided in server synchronization packets to specify which record id is the parent of the record.

This is a read-only field provided in server synchronization packets to specify which position the node takes in the parent's children array. This index is set on load and gets updated automatically after row reordering, sorting, etc. To save the order, need to persist the field on the server and when data is fetched to be loaded, need to sort by this field.

This field is added to the class at runtime when the Store is configured with lazyLoad. The number specified should reflect the total amount of children of a parent node, including nested descendants.