Configuration

An object defining configuration options for the dxScrollView widget.

direction

A string value specifying the available scrolling directions.

Type: String
Default Value: "vertical"
Accepted Values: 'vertical'|'horizontal'|'both'

Show Example:
jQuery

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

Show Example:
jQuery

pullDownAction

An action performed after the widget is scrolled to the top and pulled down.

Type: String|function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

Default Value: null

Assign a function to perform a custom action after the widget is scrolled to the top and pulled down.

Alternatively, you can assign a URL to which the browser will navigate after the widget is scrolled to the top and pulled down.

Show Example:
jQuery

pulledDownText

Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold.

Type: String
Default Value: "Release to refresh..."

pullingDownText

Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold.

Type: String
Default Value: "Pull down to refresh..."

reachBottomAction

An action performed after the widget is scrolled to the bottom and pulled up.

Type: String|function(e)
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

Default Value: null

Assign a function to perform a custom action after the widget is scrolled to the bottom and pulled up.

Alternatively, you can assign a URL to which the browser will navigate after the widget is scrolled to the bottom and pulled up.

Show Example:
jQuery

reachBottomText

Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom.

Type: String
Default Value: "Loading..."

refreshingText

Specifies the text shown in the pullDown panel displayed when the content is being refreshed.

Type: String
Default Value: "Refreshing..."

scrollAction

An action performed on each scroll gesture.

Type: String|function(e)
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

jQueryEvent: jQuery.Event

Returns a jQuery event that caused the action's 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.

Default Value: null

Assign a function to perform a custom action on each scroll gesture.

Alternatively, you can assign a URL to which the browser will navigate on each scroll gesture.

Show Example:
jQuery

showScrollBar

A Boolean value specifying whether or not the scrollbar is visible.

Type: Boolean
Default Value: true

Show Example:
jQuery

updateAction

An action performed after the widget is updated.

Type: String|function(e)
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

jQueryEvent: jQuery.Event

Returns a jQuery event that caused the action's 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.

Default Value: null

Assign a function to perform a custom action after the widget is updated.

Alternatively, you can assign a URL to which the browser will navigate after the widget is updated.

Show Example:
jQuery

useNative

Indicates whether to use native or simulated scrolling.

Type: Boolean
Default Value: true
Default for android below version 4: false
Default for tizen: false
Default for desktop: false