Configuration

An object defining configuration options for the ScrollView widget.

bounceEnabled

A Boolean value specifying whether to enable or disable the bounce-back effect.

Type:

Boolean

Default Value: true, false (desktop)

If the option is set to true, you can scroll the widget content up (down) even if you have reached the bottom (top) boundary. But when you release the content, it returns to the bound position. If the option value is false, you can scroll the widget content until you reach the boundary.

direction

A string value specifying the available scrolling directions.

Type:

String

Default Value: 'vertical'
Accepted Values: 'both' | 'horizontal' | 'vertical'

Use the ScrollDirection enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Vertical, Horizontal and Both.

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.

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}
jQuery
$(function(){
    $("#scrollViewContainer").dxScrollView({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-scroll-view ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-scroll-view>
import { DxScrollViewModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxScrollViewModule
    ],
    // ...
})
ASP.NET MVC Control
Razor C#
Razor VB
@(Html.DevExtreme().ScrollView()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().ScrollView() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

height

Specifies the widget's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's height.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ScrollView

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.

Default Value: null

onInitialized

A function that is executed only once, after the widget is initialized.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ScrollView

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.

Default Value: null

You cannot access widget elements in this function because it is executed before they are ready.

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ScrollView

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.

Default Value: null

onPullDown

A function that is executed when the "pull to refresh" gesture is performed. Supported in mobile themes only.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ScrollView

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.

Default Value: null

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

JavaScript
var scrollViewOptions = {
    onPullDown: function(options){
        . . .
        options.component.release();
    }
}

onReachBottom

A function that is executed when the content is scrolled down to the bottom.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ScrollView

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.

Default Value: null

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

JavaScript
var scrollViewOptions = {
    onReachBottom: function(options){
        . . .
        options.component.release();
    }
}

onScroll

A function that is executed on each scroll gesture.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ScrollView

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.

Default Value: null

onUpdated

A function that is executed each time the widget is updated.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ScrollView

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.

Default Value: null

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...', '' (Material)

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...', '' (Material)

reachBottomText

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

Type:

String

Default Value: 'Loading...', '' (Material)

refreshingText

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

Type:

String

Default Value: 'Refreshing...', '' (Material)

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});
See Also

scrollByContent

A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. Applies only if useNative is false

Type:

Boolean

Default Value: true, false (non-touch devices)

scrollByThumb

A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar.

Type:

Boolean

Default Value: false, true (desktop)

showScrollbar

Specifies when the widget shows the scrollbar.

Type:

String

Default Value: 'onScroll', 'onHover' (desktop)
Accepted Values: 'onScroll' | 'onHover' | 'always' | 'never'

Setting this option makes sense only when the useNative option is set to false.

Use the ShowScrollbarMode enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: OnScroll, OnHover, Always, and Never.

useNative

Indicates whether to use native or simulated scrolling.

Type:

Boolean

Default Value: true, false (desktop), true (Mac)

width

Specifies the widget's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's width.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }