Events

This section describes events fired by this widget.

contentReady

Fires when widget content is ready.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onContentReady option to handle the event.

See Also

disposing

Fires when the widget is being removed.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onDisposing option to handle the event.

See Also
NOTE
This event fires only if the widget is removed using the remove(), empty(), or html() jQuery methods.

initialized

Fires when the widget is initialized.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.

Instead, you can use the onInitialized option to handle the event.

See Also

itemClick

Fires when a widget item is clicked.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
itemData: Object
The data that is bound to the clicked item.
itemElement: jQuery
An HTML element of the item.
itemIndex: Number
Specifies the index of the clicked item.
node: Object
The item node.

Instead, you can use the onItemClick option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

itemCollapsed

Fires when a tree view item is collapsed.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
itemData: Object
The data that is bound to the collapsed item.
itemElement: jQuery
An HTML element of the item.
itemIndex: Number
Specifies the index of the collapsed item.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
node: Object
The collapsed item node.

Instead, you can use the onItemCollapsed option to handle the event.

See Also

itemContextMenu

Fires when the right mouse button is clicked when the pointer is over a widget item, or when the "sustained" (also known as a long press) touch action is performed.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
itemData: Object
The data that is bound to the item.
itemElement: jQuery
An HTML element of the item.
itemIndex: Number
Specifies the index of the item.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
node: Object
The item node.

Instead, you can use the onItemContextMenu option to handle the event.

See Also

itemExpanded

Fires when a tree view item is expanded.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
itemData: Object
The data that is bound to the expanded item.
itemElement: jQuery
An HTML element of the item.
itemIndex: Number
Specifies the index of the expanded item.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
node: Object
The expanded item node.

Instead, you can use the onItemExpanded option to handle the event.

See Also

itemHold

Fires when the widget's collection item is being held for the time period specified by the itemHoldTimeout option.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
itemData: Object
The data that is bound to the item being held.
itemElement: jQuery
An HTML element of the item.
itemIndex: Number
Specifies the index of the item being held.
node: Object
The item node.

Instead, you can use the onItemHold option to handle the event.

See Also

itemRendered

Fires after a collection item is rendered.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
itemData: Object
The data that is bound to the item to be rendered.
itemElement: jQuery
An HTML element of the item.
itemIndex: Number
Specifies the index of the rendered item.
node: Object
The item node.

Instead, you can use the onItemRendered option to handle the event.

See Also

itemSelected

Deprecated

Use the onItemSelectionChanged instead.

Fires when a tree view item is selected.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
node: Object
A node of the selected item.

itemSelectionChanged

Fires when a tree view item is selected.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
node: Object
A node of the selected item.

Instead, you can use the onItemSelectionChanged option to handle the event.

This event fires in one of the following cases.

  1. The selectByClick option is set to true.
  2. The showCheckBoxesMode option is not set to 'none'.
  3. You use one of the methods: selectAll, unselectAll, selectItem, unselectItem.
See Also
Show Example:
AngularJS
Knockout
jQuery

optionChanged

Fires after an option of the component is changed.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onOptionChanged option to handle the event.

See Also

selectionChanged

Fires after a collection item is selected or unselected.

Event Handler Argument:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onSelectionChanged option to handle the event.

This event fires in one of the following cases.

  1. The selectByClick option is set to true.
  2. The showCheckBoxesMode option is not set to 'none'.
  3. You use one of the methods: selectAll, unselectAll, selectItem, unselectItem.
See Also
Show Example:
AngularJS
Knockout
jQuery