Emitted when the node checkbox is clicked
A set of configurations for the tree
A set of configurable data properties, accessible from the template of each node
Emitted when the tree is being updated (after nodes are added or removed or children are expanded)
Default display field
initial drag index/position
Emitted when the number of expanded nodes changes
Whether to focus the first node or not
Override function for the 'getChildren' method, if set through the 'treeProperties' of TreeConfigBase
Emitted when the tree is initialized
flag to drag end
Whether to show the tree loading
Custom item template for each node
Indicating if the node has been just added to the tree (sets yellow background on the just added node)
Css modifiers, set to the tree wrapper
Emitted when a node is moved
The height of the node, used for virtualization
Array of nodes of the tree
Emitted when an external link is clicked from the template of the node
The top padding of the virtualization wrapper
Emitted on node removed
Emitted when nodes are reordered
The type of text to be matched (contains or starts with)
What text to highlight in the node content (usually very useful to highlight searched text)
Gets the instance of the tree element
css class set to the tree element
Emitted on node clicked
Emitted on tree node press enter
The height of the virtualization wrapper
Emits the number of expanded nodes when that number changess
A reference to the virtualization wrapper
The height of tree wrapper (used for virtualization)
Custom callback for the 'getChildren' method of the tree
The value of the node's field that is used for displaying its content. By default 'name', unless stated otherwise in the options
Binds dataProperties
Binds treeProperties to the tree options
Emits visibleNodesCountChanged and the number of visible nodes
Clears all nodes
Clears the focused node
Expands all nodes
Expands and selects children
Expands and selects children
Focuses the next node
Focuses out the tree
Focuses the previous node
Focuses the tree
Generated css wrapper class
Gets active node ids
Gets the active node
Gets expanded nodes
Gets the focused node
Returns whether a node is active or not
Returns whether a node is expanded or not
Returns whether a node is selected or not
Gets node by predicate and startNode
Gets node by id
Returns the number of nodes recursively
Gets all selected nodes
Updates wrapper css class Updates useCheckbox option when TreeConfigBase is changed
On data updated handler
On dragEnd handler Reorders the nodes Add the justAdded property
Focuses first node if focusFirstNode is set to true
Initializes the tree
Emits modeNode event
Emits treeNodePressEnter event
Handles tree wrapper resize with virtualization
On state changed handler
Toggles expanded and emits expandedNodesChanged event
Emits removeNode event
Can be used ot open external link inside node
Handles virtualization scrolling
Filters nodes by search term
Selects all nodes
Set selected and active node by id
Emits treeNodeClicked event with the currently focused node
Set nodes as selected by id
Set active node by id
Set expanded node by id
Sets expanded nodes by id
Set hidden node by id
Set selected leaf node by id
Shows all hidden nodes
On node clicked handler Emits treeNodeClicked event Selects and activates mode if multi selection is enabled
Selects a node checkbox Activates node Emits checkBoxClicked and treeNodeClicked events
Updates tree model
Updates tree wrapper height for virtualization
This configured options of the tree
Generated using TypeDoc
API reference for SfTreeComponent
import {SfTreeComponent} from "@progress/sitefinity-component-framework";selector:
sf-tree