JavaScript/jQuery TreeView Events

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only when using Knockout.

Main article: onContentReady.

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TreeView	The widget instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.

Name

Type

Description

component

The widget instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if you use Knockout.

Main article: onDisposing

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Main article: onInitialized

itemClick

Raised when a collection item is clicked or tapped.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	Object	The model data. Available only if Knockout is used.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the function's execution. Deprecated in favor of the event field.
itemIndex	Number \| Object	The clicked item's index.
itemElement	HTMLElement \| jQuery	The clicked item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The clicked item's data object.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	TreeView	The widget's instance.
node	TreeView Node	The clicked item's node.

Main article: onItemClick.

itemCollapsed

Raised when a tree view item is collapsed.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TreeView	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
itemData	Object	The collapsed item's data.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number	The item's index.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
model	Object	The model data. Available only if Knockout is used.
node	TreeView Node	The item's node.

Main article: onItemCollapsed

itemContextMenu

Raised when a collection item is right-clicked or pressed.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	Object	The model data. Available only if Knockout is used.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the function's execution. Deprecated in favor of the event field.
itemIndex	Number \| Object	The target item's index.
itemElement	HTMLElement \| jQuery	The target item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The target item's data object.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	TreeView	The widget's instance.
node	TreeView Node	The target item's node.

Main article: onItemContextMenu

itemExpanded

Raised when a tree view item is expanded.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TreeView	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
itemData	Object	The expanded item's data.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemIndex	Number	The item's index.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
model	Object	The model data. Available only if Knockout is used.
node	TreeView Node	The item's node.

Main article: onItemExpanded

itemHold

Raised when a collection item has been held for a specified period.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	Object	The model data. Available only if Knockout is used.
itemIndex	Number	The index of the item being held. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The data object of the item being held.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	TreeView	The widget's instance.
node	TreeView Node	The node of the item being held.

Main article: onItemHold

itemRendered

Raised after a collection item is rendered.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	Object	The model data. Available only if Knockout is used.
itemIndex	Number	The rendered item's index.
itemElement	HTMLElement \| jQuery	The rendered item's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemData	Object	The rendered item's data object.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	TreeView	The widget's instance.
node	TreeView Node	The rendered item's node.

Main article: onItemRendered

itemSelectionChanged

Raised when a tree view item is selected or selection is canceled.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TreeView	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
itemElement	HTMLElement \| jQuery	The item's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
node	TreeView Node	The item's node.

Main article: onItemSelectionChanged

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	Object	The model data. Available only if you use Knockout.
fullName	String	The path to the modified option that includes all parent options.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	TreeView	The widget's instance.
name	String	The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
value	any	The modified option's new value.

Main article: onOptionChanged

selectAllValueChanged

Raised when the "Select All" check box value is changed.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	TreeView	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
value	Boolean	The "Select All" check box's new state.

Main article: onSelectAllValueChanged

selectionChanged

Raised when a tree view item is selected or selection is canceled.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

model

The model data. Available only if Knockout is used.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

component