TreeListNode(options)

new TreeListNode(options)
TreeListNode.js, line 19

Create a node for the TreeList

This class is made to create each node in the TreeList. Nodes are build recursively and stored in a child nodes array. Each node contains identification information, among other useful values ; depth in tree, expand state and leaf state. They also hold any mouse interaction the user could have on the node. Finally, those nodes are expandable/collapsable if they contain child nodes.
Parameters:
Name Type Description
options object

The node options

Properties
Name Type Attributes Default Description
id number <optional>
 -1

The element ID, must be provided in model input object
name string

The node name, mandatory as it is the innerHTML content
depth number

The node depth in tree list, mandatory as it is the innerHTML content
clicked function <optional>

The callback function to provided that will be called each time the node is clicked
Since:
  • October 2020
Author:
  • Arthur Beaulieu

Members

private _children :array
TreeListNode.js, line 55

The node children

private _clicked :function
TreeListNode.js, line 44

The callback function to call when node is clicked

private _depth :number
TreeListNode.js, line 41

The node depth in graph

private _dom :object
TreeListNode.js, line 59

The node DOM elements

private _id :number
TreeListNode.js, line 35

The node ID

private _isExpanded :boolean
TreeListNode.js, line 51

The expand state of node

private _isLeaf :boolean
TreeListNode.js, line 48

The leaf state of node

private _name :string
TreeListNode.js, line 38

The node name to display

private _svgPath :object
TreeListNode.js, line 69

Expand/Collapse icon svg pathes

children :array
TreeListNode.js, line 275

The node children

container :object
TreeListNode.js, line 280

The node DOM container

Methods

private, static _buildUI()
TreeListNode.js, line 111

This method will build the node DOM element and fill their attributes.

private, static _onNodeClick()
TreeListNode.js, line 130

This method is called on click event on the node container. It will call the given callback if any was provided.

private, static _onNodeToggle()
TreeListNode.js, line 150

This method will collapse or expand node only if it has children.

static collapse(recursiveopt)
TreeListNode.js, line 226

This method will collapse the node only if it has children. The collapse can be recursiv through the node children if given flag is provided.
Parameters:
Name Type Attributes Default Description
recursive boolean <optional>
 false

Propagate the collapse call through each children of this node

static collapseAll()
TreeListNode.js, line 262

This method will collapse all nodes starting from this node.

static destroy()
TreeListNode.js, line 81

TreeListNode destructor. Will delete node and its children, their events and their properties.

static expand(recursiveopt)
TreeListNode.js, line 201

This method will expand the node only if it has children. The expand can be recursiv through the node children if given flag is provided.
Parameters:
Name Type Attributes Default Description
recursive boolean <optional>
 false

Propagate the expand call through each children of this node

static expandAll()
TreeListNode.js, line 251

This method will expand all nodes starting from this node.

static setExpander()
TreeListNode.js, line 174

This method will append an expander to the node only if it has children. It must be called we all the TreeList is created, since it is recursive. See TreeList implementation.