JavaScript/jQuery TreeView Events

This section describes events fired by this widget.

See Also

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

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 when using Knockout.

Main article: onContentReady.

See Also

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:
e:

Object

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.

Main article: onDisposing

See Also

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

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.

Main article: onInitialized

See Also

itemClick

Raised when a collection item is clicked or tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
node

TreeView Node

The clicked item's node.
event

Event (jQuery or EventObject)

The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery.
jQueryEvent

jQuery.Event

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.
model

Object

The model data. Available only if Knockout is used.
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.

Main article: onItemClick.

See Also

itemCollapsed

Raised when a tree view item is collapsed.

Type:

Event

Function parameters:
e:

Object

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.
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.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
node

TreeView Node

The item's node.

Main article: onItemCollapsed

See Also

itemContextMenu

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

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
node

TreeView Node

The target item's node.
event

Event (jQuery or EventObject)

The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery.
jQueryEvent

jQuery.Event

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.
model

Object

The model data. Available only if Knockout is used.
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.

Main article: onItemContextMenu

See Also

itemExpanded

Raised when a tree view item is expanded.

Type:

Event

Function parameters:
e:

Object

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.
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.
event

Event (jQuery or EventObject)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
node

TreeView Node

The item's node.

Main article: onItemExpanded

See Also

itemHold

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

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
event

Event (jQuery or EventObject)

The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery.
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 container of the item being held. It is an HTML Element or a jQuery Element when you use jQuery.
itemData

Object

The data object of the item being held.
model

Object

The model data. Available only if Knockout is used.
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

See Also

itemRendered

Raised after a collection item is rendered.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
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.
model

Object

The model data. Available only if Knockout is used.
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

See Also

itemSelectionChanged

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

Type:

Event

Function parameters:
e:

Object

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.
node

TreeView Node

The item's node.
itemElement

HTMLElement | jQuery

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

Main article: onItemSelectionChanged

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
name

String

The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
model

Object

The model data. Available only if you use Knockout.
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.
fullName

String

The path to the modified option that includes all parent options.
value any

The modified option's new value.

Main article: onOptionChanged

See Also

selectAllValueChanged

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

Type:

Event

Function parameters:
e:

Object

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

See Also

selectionChanged

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

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
model

Object

The model data. Available only if Knockout is used.
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.

Main article: onSelectionChanged

See Also