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:

List

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:

List

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

groupRendered

Raised when a group element is rendered.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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.

groupData:

Object

The current group's data.

groupElement:

Element (jQuery or HTML)

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

groupIndex:

Number

The group's index.

Main article: onGroupRendered

See Also

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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 list item is clicked or tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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.

itemData:

Object

The data that is bound to the clicked item.

itemElement:

Element (jQuery or HTML)

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

itemIndex:

Number

|

Object

The clicked item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }.

Main article: onItemClick

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:

List

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.

itemData:

Object

The 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

|

Object

The index of the item for which the context menu is displayed. In a grouped list, the index is specified as an object defining group and item indexes: { group: 0, item: 0 }.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

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

Main article: onItemContextMenu

See Also

itemDeleted

Raised after a list item is deleted from the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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.

itemData:

Object

The removed 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

|

Object

The removed item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

itemDeleting

Raised before a collection item is deleted from the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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 you use Knockout.

itemData:

Object

The data of the item to be removed.

itemElement:

Element (jQuery or HTML)

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

itemIndex:

Number

|

Object

The item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }.

cancel:

Boolean

|

Promise<void> (jQuery or native)

Allows you to cancel the item deletion.

Main article: onItemDeleting

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:

List

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.

itemData:

Object

The data 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

|

Object

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

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:

List

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 you use Knockout.

itemData:

Object

The current 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 current item's index.

Main article: onItemRendered

See Also

itemReordered

Raised after a list item is moved to another position.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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.

itemData:

Object

The reordered 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

|

Object

The item's index after reordering. This field holds the same value as toIndex.
In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

fromIndex:

Number

The item's previous index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

toIndex:

Number

The item's current index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

itemSwipe

Raised when a list item is swiped.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

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

itemData:

Object

The swiped 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

|

Object

The item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

direction:

String

The direction in which the item is swiped.

Main article: onItemSwipe

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The 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

pageLoading

Raised before the next page is loaded.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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.

Main article: onPageLoading

See Also

pullRefresh

Raised when the "pull to refresh" gesture is performed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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.

Main article: onPullRefresh

See Also

scroll

Raised on each scroll gesture.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

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

scrollOffset:

Object

The current scroll offset in the following format { top: topOffset, left: leftOffset }.

reachedLeft:

Boolean

Indicates whether the container's left boundary is reached.

reachedRight:

Boolean

Indicates whether the container's right boundary is reached.

reachedTop:

Boolean

Indicates whether the container's top boundary is reached.

reachedBottom:

Boolean

Indicates whether the container's bottom boundary is reached.

selectAllValueChanged

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

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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

selectionChanged

Raised when a collection item is selected or the selection is canceled.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

List

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 you use Knockout.

addedItems:

Array<any>

The data of the items that have been selected.

removedItems:

Array<any>

The data of the items whose selection has been canceled.

Main article: onSelectionChanged

See Also