Events

This section describes events fired by this widget.

See Also

disposing

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget instance.

element

jQuery

The widget's container.

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

Object

The widget's instance.

element

jQuery

The widget's container.

Main article: onInitialized

See Also

optionChanged

Raised after an option of the widget is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

name

String

A short name of the option whose value has been changed.

fullName

String

A full name of the option whose value has been changed; contains a full hierarchy of the option.

value any

A new value for the option.

element

jQuery

The widget's container.

model

Object

The model data. Available only if you use Knockout.

Main article: onOptionChanged

See Also

pullDown

Fires after the widget is scrolled to the top and pulled down.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget's 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 onPullDown option to handle the event.

The function handling this event should contain a call to the release() method, which releases the scroll view.

JavaScript
$("#scrollViewContainer").dxScrollView("instance").on("pullDown", function(options) {
    . . .
    options.component.release();
})
NOTE
The "pull down to refresh" gesture is not supported by desktop browsers and Windows Phone devices. You can use it only in mobile themes except the Windows Phone theme.
See Also

reachBottom

Fires after the widget is scrolled to the bottom and pulled up.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget's 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 onReachBottom option to handle the event.

The function handling this event should contain a call to the release() method, which releases the scroll view.

JavaScript
$("#scrollViewContainer").dxScrollView("instance").on("reachBottom", function(options) {
    . . .
    options.component.release();
})
See Also

scroll

Fires on each scroll gesture.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

The widget's 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.

jQueryEvent

jQuery.Event

Returns a jQuery event that caused action execution.

scrollOffset

Object

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

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

See Also

updated

Fires after the widget is updated.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

The widget's 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.

jQueryEvent

jQuery.Event

Returns a jQuery event that caused action execution.

scrollOffset

Object

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

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

See Also