Tree

class ui.tree.Tree()

Provides a tree view component for displaying hierarchical data structures.

Constructors

ui.tree.Tree.constructor()
Tree(): Tree

Returns: Tree

Properties

ui.tree.Tree.entries
entries: Record

Holds all tree node data needed for rendering the hierarchy. Maps node keys to TreeEntryData. Reassign to trigger updates.

ui.tree.Tree.selected
selected: number[]

Array of selected node keys. Reassign to trigger updates.

ui.tree.Tree.tree

Context wrapper providing tree data access methods. Reassign to trigger updates.

Methods

ui.tree.Tree.expandPath()
expandPath(nodePath: number[]): void

Expands all nodes along the specified path.

Parameters

nodePath: number[]

Array of node keys representing the path to expand

Returns: void

void
ui.tree.Tree.loadChildrenData()
loadChildrenData(parent: TreeEntryData): void

Loads and registers child nodes for a parent node.

Parameters

parent: TreeEntryData

The parent node entry

Returns: void

void
ui.tree.Tree.refreshNodeData()
refreshNodeData(nodeKey: number): void

Refreshes node data from context. No-op if node is not loaded.

Parameters

nodeKey: number

The key of the node to refresh

Returns: void

void
ui.tree.Tree.removeNode()
removeNode(nodeKey: number): void

Removes a node and all its children from the tree. No-op if node is not loaded.

Parameters

nodeKey: number

The key of the node to remove

Returns: void

void
ui.tree.Tree.resetTree()
resetTree(): void

Resets the tree to its initial state, clearing all entries and selections.

Returns: void

void
ui.tree.Tree.updateContext()
updateContext(): void

Triggers a re-render by reassigning tree context.

Returns: void

void
ui.tree.Tree.updateEntries()
updateEntries(): void

Triggers a re-render by reassigning entries.

Returns: void

void
ui.tree.Tree.updateSelected()
updateSelected(): void

Triggers a re-render by reassigning selected entries.

Returns: void

void