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:
component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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:
component:

TreeView

The widget instance.

element:

Element (jQuery or HTML)

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:
component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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:
component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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

event:

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

itemData:

Object

The clicked item's data object.

itemElement:

Element (jQuery or HTML)

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

itemIndex:

Number

|

Object

The clicked item's index.

jQueryEvent:

jQuery.Event

Use 'event' instead.

The jQuery event that caused the function's execution. Deprecated in favor of the event field.

model:

Object

The model data. Available only if Knockout is used.

The clicked item's node.

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:
component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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

event:

Event (jQuery or dxEvent)

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:

Element (jQuery or HTML)

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.

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:
component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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

event:

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

itemData:

Object

The target item's data object.

itemElement:

Element (jQuery or HTML)

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

itemIndex:

Number

|

Object

The target item's index.

jQueryEvent:

jQuery.Event

Use 'event' instead.

The jQuery event that caused the function's execution. Deprecated in favor of the event field.

model:

Object

The model data. Available only if Knockout is used.

The target item's node.

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:
component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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

event:

Event (jQuery or dxEvent)

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:

Element (jQuery or HTML)

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.

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:
component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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

event:

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

itemData:

Object

The data object of the item being held.

itemElement:

Element (jQuery or HTML)

The item's container. It is an HTML Element or a jQuery Element 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 }.

model:

Object

The model data. Available only if Knockout is used.

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:
component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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

itemData:

Object

The rendered item's data object.

itemElement:

Element (jQuery or HTML)

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

itemIndex:

Number

The rendered item's index.

model:

Object

The model data. Available only if Knockout is used.

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:
component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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

itemElement:

Element (jQuery or HTML)

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.

The item's node.

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:
component:

TreeView

The widget's instance.

fullName:

String

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

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.

element:

Element (jQuery or HTML)

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: 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:
component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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:
addedItems:

Array<any>

The data of the items that have been selected.

component:

TreeView

The widget's instance.

element:

Element (jQuery or HTML)

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.

removedItems:

Array<any>

The data of the items whose selection has been canceled.

Main article: onSelectionChanged

See Also