TreeNodeHandle Class
A handle to a TreeNode that exists within a specific TreeView. This type provides a convenient API for traversing trees of nodes in a TreeView and is not designed to provide maximum runtime performance; if performance is a concern, consider using the TreeView and TreeViewNode APIs directly.
Signature
export declare class TreeNodeHandle implements TreeNode<TreeNodeHandle, NodeId>
Implements: TreeNode<TreeNodeHandle, NodeId
Constructors
| Constructor | Description |
|---|---|
| (constructor)(view, nodeId) | Construct a handle which references the node with the given id in the given TreeView |
Properties
| Property | Type | Description |
|---|---|---|
| definition | Definition | |
| identifier | NodeId | |
| node | TreeViewNode | Get a TreeViewNode for the tree view node that this handle references |
| payload | Payload | undefined | |
| traits | TraitMap<TreeNodeHandle> |
Constructor Details
(constructor)
Construct a handle which references the node with the given id in the given TreeView
Signature
constructor(view: TreeView, nodeId: NodeId);
Parameters
| Parameter | Type | Description |
|---|---|---|
| view | TreeView | |
| nodeId | NodeId |
Property Details
definition
Signature
get definition(): Definition;
Type: Definition
identifier
Signature
get identifier(): NodeId;
Type: NodeId
node
Get a TreeViewNode for the tree view node that this handle references
Signature
get node(): TreeViewNode;
Type: TreeViewNode
payload
Signature
get payload(): Payload | undefined;
Type: Payload | undefined
traits
Signature
get traits(): TraitMap<TreeNodeHandle>;
Type: TraitMap<TreeNodeHandle>