wijtree jQuery Widget

Present items in a hierarchical tree structure with expand and collapse animations, stylish themes, and drag-and-drop functionality.

Syntax

Javascript (Usage)
Javascript (Specification)

$(function () {
    var options; // Type:  wijmo.tree.wijtree.options
     
    $(".selector").wijtree(options);
});

function wijtree() : any;

Options

	Name	Description
	allowDrag	Default value: false When the allowDrag option is set to true, the tree nodes can be dragged.
	allowDrop	Default value: false When allowDrop is set to true, one tree node can be dropped within another tree node.
	allowEdit	Default value: false The allowEdit option allows a user to edit the tree nodes at run time.
	allowSorting	Default value: true The allowSorting option allows the tree nodes to be sorted at run time when the user presses the "s" key.
	allowTriState	Default value: true The allowTriState option allows the tree nodes to exhibit triState behavior. This lets the node checkboxes be checked, unchecked, or indeterminate. This option must be used with the showCheckBoxes option.
	autoCheckNodes	Default value: true The autoCheckNodes option allows the sub-nodes to be checked when the parent nodes are checked. To use this option, showCheckboxes must be set to "true."
	autoCollapse	Default value: false If this option is set to true, the expanded node will be collapsed if another node is expanded.
	collapseAnimation	The collapseAnimation option determines the animation effect, easing, and duration for hiding child nodes when the parent node is collapsed. Type: Object Default: null
	collapseDelay	Default value: 0 This option controls the length of time in milliseconds to delay before the node collapses.
	disabled	Default value: false If set to true, the select, click, and check operations are disabled too.
	draggable	Default value: null Customize the jquery-ui-draggable plugin of wijtree.
	droppable	Default value: null Customize the jquery-ui-droppable plugin of wijtree.
	dropVisual	Default value: null Customizes the helper element to be used to display the position that the node will be inserted to. If a function is specified, it must return a DOMElement.
	expandAnimation	Type: wijmo.tree.wijtree_animation The expandAnimation option determines the animation effect, easing, and duration for showing child nodes when the parent node is expanded.
	expandCollapseHoverUsed	Default value: false The expandCollapseHoverUsed option allows the tree to expand or collapse when the mouse hovers over the expand/collapse button.
	expandDelay	Default value: 0 The expandDelay option controls the length of time in milliseconds to delay before the node is expanded.
	nodes	Default value: null Set the child nodes object array as the datasource of wijtree.
	showCheckBoxes	Default value: false The showCheckBoxes option allows the node Check Box to be shown on the tree nodes.
	showExpandCollapse	Default value: true The showExpandCollapse option determines if the tree is displayed in an expanded or collapsed state. If set to "false," then the wijtree widget will be displayed in the expanded state.

Top

Methods

	Name	Description
	add	The add method adds a node to the tree widget.
	destroy	The destroy method will remove the rating functionality completely and will return the element to its pre-init state.
	findNodeByText	The findNodeByText method finds a node by the specified node text.
	getCheckedNodes	The getCheckedNodes method gets the nodes which are checked.
	getNodes	The getNodes method gets an array that contains the root nodes of the current tree.
	getSelectedNodes	The getSelectedNodes method gets the selected nodes.
	remove	The remove method removes the indicated node from the wijtree element.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	nodeBeforeDropped	The nodeBeforeDropped event handler is called before a draggable node is dropped in another position. If the event handler returns false, the drop action will be prevented.
	nodeBlur	The nodeBlur event fired when the node loses focus.
	nodeCheckChanged	The nodeCheckChanged event fires when a node is checked.
	nodeCheckChanging	The nodeCheckChanging event fires before a node is checked. You can cancel this event by returning false.
	nodeClick	The nodeClick event fires when a tree node is clicked.
	nodeCollapsed	The nodeCollapsed event fires when a tree node is collapsed.
	nodeCollapsing	The nodeCollapsing event fires before a node collapses. This event can be canceled, if return false
	nodeDragging	The nodeDragging event handler.A function called when the node is moved during a drag-and-drop operation.
	nodeDragStarted	The nodeDragStarted event fires when a user starts to drag a node.
	nodeDropped	The nodeDropped event is called when an acceptable draggable node is dropped over to another position.
	nodeExpanded	The nodeExpanded event handler. A function called when a node is expanded.
	nodeExpanding	The nodeExpanding event fires before a tree node is expanded. This event can be canceled, if return false
	nodeFocus	The nodeFocus event fired when the node is focused.
	nodeMouseOut	The nodeMouseOut event fires when the user moves the mouse pointer off of a node.
	nodeMouseOver	The nodeMouseOver event fires when a user places the mouse pointer over a node.
	nodeTextChanged	The nodeTextChanged event fires when the text of a node changes.
	selectedNodeChanged	The selectedNodeChanged event fires when the selected node changes.

Top

Widgets

Tree

Reference

wijtree jQuery Widget