JavaScript/jQuery ScrollView 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

HTMLElement | jQuery

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.

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

HTMLElement | jQuery

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

Main article: onInitialized

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
name

String

The option's short name.
model

Object

The model data. Available only if you use Knockout.
element

HTMLElement | jQuery

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

Object

The widget's instance.
fullName

String

The option's full name.
value any

The option's new value.

See Also

pullDown

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

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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.

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

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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.

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

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Use 'event' instead.

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

Event (jQuery or EventObject)

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.

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

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.
element

HTMLElement | jQuery

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

Use 'event' instead.

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

Event (jQuery or EventObject)

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.

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

See Also