Events
This section describes events fired by this widget.
contentReady
Raised when the widget's content is ready.
Information about the event.
The widget's instance.
The widget's container.
The model data. Available only when using Knockout.
disposing
Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
initialized
Raised only once, after the widget is initialized.
itemClick
Fires when a widget item is clicked.
Provides function parameters.
Provides access to the widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
The data that is bound to the clicked item.
An HTML element of the item.
Specifies the index of the clicked item.
Specifies the jQuery event that caused action execution.
Instead, you can use the onItemClick 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.
Provides function parameters.
Provides access to the widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
The data that is bound to the item.
An HTML element of the item.
Specifies the index of the item.
Specifies the jQuery event that caused action execution.
Instead, you can use the onItemContextMenu 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.
Provides function parameters.
Provides access to the widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
The data that is bound to the item being held.
An HTML element of the item.
Specifies the index of the item being held.
Instead, you can use the onItemHold option to handle the event.
See Also
itemRendered
Fires after a collection item is rendered.
Provides function parameters.
Provides access to the widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
The data that is bound to the item to be rendered.
An HTML element of the item.
Specifies the index of the rendered item.
Instead, you can use the onItemRendered option to handle the event.
See Also
optionChanged
Raised after an option of the widget is changed.
Information about the event.
The widget's instance.
A short name of the option whose value has been changed.
A full name of the option whose value has been changed; contains a full hierarchy of the option.
A new value for the option.
The widget's container.
The model data. Available only if you use Knockout.
selectionChanged
Fires after a collection item is selected or unselected.
Provides function parameters.
Provides access to the widget's instance.
An HTML element of the widget.
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
An array of items added to selection.
An array of items removed from selection.