Blazor JqxTree API Reference

Name	Type
Properties
animationShowDuration	double
Sets or gets the duration of the show animation.
animationHideDuration	double
Sets or gets the duration of the hide animation.
allowDrag	bool
Enables the dragging of Tree Items.
allowDrop	bool
Enables the dropping of Tree Items.
checkboxes	bool
Sets or gets whether the tree should display a checkbox next to each item. In order to use this feature, you need to include the jqxcheckbox.js.
dragStart	object
Callback function which is called when a drag operation starts.
dragEnd	object
Callback function which is called when a drag operation ends.
disabled	bool
Gets or sets whether the tree is disabled.
easing	string
Sets or gets the animation's easing to one of the JQuery's supported easings.
enableHover	bool
Enables or disables the hover state.
height	object
Sets or gets the tree's height.
hasThreeStates	bool
Sets or gets whether the tree checkboxes have three states - checked, unchecked and indeterminate.
incrementalSearch	bool
Determines whether the incremental search is enabled. The feature allows you to quickly find and select items by typing when the widget is on focus.
keyboardNavigation	bool
Enables or disables the key navigation.
rtl	bool
Sets or gets a value indicating whether widget's elements are aligned to support locales using right-to-left fonts.
source	object
Specifies the jqxTree's data source. Use this property to populate the jqxTree. label - sets the item's label. value - sets the item's value. html - item's html. The html to be displayed in the item. id - sets the item's id. disabled - sets whether the item is enabled/disabled. checked - sets whether the item is checked/unchecked(when checkboxes are enabled). expanded - sets whether the item is expanded or collapsed. selected - sets whether the item is selected. items - sets an array of sub items. icon - sets the item's icon(url is expected). iconsize - sets the size of the item's icon.
toggleIndicatorSize	double
Sets or gets the size of the expand/collapse arrows.
toggleMode	object
Sets or gets user interaction used for expanding or collapsing any item. Possible Values: `'click'` `'dblclick'`
theme	string
Sets the widget's theme. Include the theme's CSS file after jqx.base.css. The following code example adds the 'material' theme. `<link rel="stylesheet" href="../../jqwidgets/styles/jqx.base.css" type="text/css" /> <link rel="stylesheet" href="../../jqwidgets/styles/jqx.material.css" type="text/css" />` Set the widget's theme property to 'material' when you initialize it.
width	object
Sets or gets the tree's width.
Events
onAdded	Event
This event is triggered when the user adds a new tree item.
onCheckChange	Event
This event is triggered when the user checks, unchecks or the checkbox is in indeterminate state.
onCollapse	Event
This event is triggered when the user collapses a tree item.
onDragStart	Event
This event is triggered when the user starts a drag operation.
onDragEnd	Event
This event is triggered when the user drops an item.
onExpand	Event
This event is triggered when the user expands a tree item.
onItemClick	Event
This event is triggered when the user clicks a tree item.
onRemoved	Event
This event is triggered when the user removes a tree item.
onSelect	Event
This event is triggered when the user selects a tree item.
Methods
Name	Arguments	Return Type
addBefore	(object item, string id)	void
Adds an item as a sibling of another item.
addAfter	(object item, string id)	void
Adds an item as a sibling of another item.
addTo	(object item, object id)	void
Adds an item.
clear	()	void
Removes all elements.
checkAll	()	void
Checks all tree items.
checkItem	(object item, bool isChecked)	void
Checks a tree item.
collapseAll	()	void
Collapses all items.
collapseItem	(object item)	void
Collapses a tree item by passing an element as parameter.
destroy	()	void
Destroy the jqxTree widget. The destroy method removes the jqxTree widget from the web page.
disableItem	(object item)	void
Disables a tree item.
ensureVisible	(object item)	void
Ensures the visibility of an element.
enableItem	(object item)	void
Enables a tree item.
enableAll	()	void
Enables all items.
expandAll	()	void
Expandes all items.
expandItem	(object item)	void
Expands a tree item by passing an element as parameter.
focus	()	void
Sets the focus to the widget.
getCheckedItems	()	object
Gets an array with all checked tree items. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. element - gets the item's LI tag. parentElement - gets the item's parent LI tag. isExpanded - gets whether the item is expanded or collapsed. selected - gets whether the item is selected or not.
getUncheckedItems	()	object
Gets an array with all unchecked tree items. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. element - gets the item's LI tag. parentElement - gets the item's parent LI tag. isExpanded - gets whether the item is expanded or collapsed. selected - gets whether the item is selected or not.
getItems	()	object
Gets an array with all tree items. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. element - gets the item's LI tag. parentElement - gets the item's parent LI tag. isExpanded - gets whether the item is expanded or collapsed. selected - gets whether the item is selected or not.
getItem	(object element)	object
Gets the tree item associated to a LI tag passed as parameter. The returned value is an object. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. element - gets the item's LI tag. parentElement - gets the item's parent LI tag. isExpanded - gets whether the item is expanded or collapsed. selected - gets whether the item is selected or not.
getSelectedItem	()	object
Gets the selected tree item. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. element - gets the item's LI tag. parentElement - gets the item's parent LI tag. isExpanded - gets whether the item is expanded or collapsed. selected - gets whether the item is selected or not.
getPrevItem	(object item)	object
Gets the item above another item. The returned value is an object. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. element - gets the item's LI tag. parentElement - gets the item's parent LI tag. isExpanded - gets whether the item is expanded or collapsed. selected - gets whether the item is selected or not.
getNextItem	(object item)	object
Gets the item below another item. The returned value is an object. label - gets item's label. value - gets the item's value. disabled - gets whether the item is enabled/disabled. checked - gets whether the item is checked/unchecked. element - gets the item's LI tag. parentElement - gets the item's parent LI tag. isExpanded - gets whether the item is expanded or collapsed. selected - gets whether the item is selected or not.
hitTest	(double left, double top)	object
Gets an item at specific position. The method expects 2 parameters - left and top. The coordinates are relative to the document.
removeItem	(object item)	void
Removes an item.
render	()	void
Renders the jqxTree widget.
refresh	()	void
Refreshes the jqxTree widget. The refresh method will update the jqxTree's layout and size.
selectItem	(object item)	void
Selects an item.
uncheckAll	()	void
Unchecks all tree items.
uncheckItem	(object item)	void
Unchecks a tree item.
updateItem	(object item, object newItem)	void
Updates an item.
val	[SET] (string value) [GET] ()	[SET] void [GET] string
Sets or gets the selected item.

Properties

Events

Methods