JavaScript/jQuery ScrollView Methods

The widget's height in pixels.

clientWidth()

Gets the widget's width.

Return Value:

The widget's width in pixels.

content()

Gets the widget's content.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

Parameters:

rule:

The component's default device options.

Object structure:

Name	Type	Description
device	Device \| Array<Device> \| Function	Device parameters. When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.
options	Object	Options to be applied.

Name

Type

Description

device

Device

|

Array<Device>

|

Function

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.

options

Options to be applied.

defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the ScrollView widget in an application executed on the desktop.

jQuery

JavaScript

DevExpress.ui.dxScrollView.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the ScrollView options
    }
});

Angular

TypeScript

import ScrollView from "devextreme/ui/scroll_view";
// ...
export class AppComponent {
    constructor () {
        ScrollView.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the ScrollView options
            }
        });
    }
}

Vue

<template>
    <div>
        <DxScrollView id="scrollView1" />
        <DxScrollView id="scrollView2" />
    </div>
</template>
<script>
import DxScrollView from "devextreme-vue/scroll-view";
import ScrollView from "devextreme/ui/scroll_view";

ScrollView.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the ScrollView options
    }
});

export default {
    components: {
        DxScrollView
    }
}
</script>

React

import React from "react";
import dxScrollView from "devextreme/ui/scroll_view";
import ScrollView from "devextreme-react/scroll-view";

class App extends React.Component {
    render () {
        dxScrollView.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the ScrollView options
            }
        })
        return (
            <div>
                <ScrollView id="scrollView1" />
                <ScrollView id="scrollView2" />
            </div>
        )
    }
}

export default App;

dispose()

Disposes of all the resources allocated to the ScrollView instance.

After calling this method, remove the DOM element associated with the widget:

JavaScript

$("#myScrollView").dxScrollView("dispose");
$("#myScrollView").remove();

Use this method only if the widget was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular

app.component.html

<dx-scroll-view ...
    *ngIf="condition">
</dx-scroll-view>

Vue

App.vue

<template>
    <DxScrollView ...
        v-if="condition">
    </DxScrollView>
</template>

<script>
import DxScrollView from 'devextreme-vue/scroll-view';

export default {
    components: {
        DxScrollView
    }
}
</script>

React

App.js

import React from 'react';

import ScrollView from 'devextreme-react/scroll-view';

function DxScrollView(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <ScrollView ... >    
        </ScrollView>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxScrollView shouldRender="condition" />
        );
    }
}
export default App;

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:

element:

Element

|

jQuery

The widget's container.

Return Value:

The widget's instance.

getInstance is a static method that the widget class supports. The following code demonstrates how to get the ScrollView instance found in an element with the myScrollView ID:

// Modular approach
import ScrollView from "devextreme/ui/scroll_view";
...
let element = document.getElementById("myScrollView");
let instance = ScrollView.getInstance(element) as ScrollView;

// Non-modular approach
let element = document.getElementById("myScrollView");
let instance = DevExpress.ui.dxScrollView.getInstance(element);

instance()

Gets the widget's instance. Use it to access other methods of the widget.

Return Value:

This widget's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

on(events)

Subscribes to events.

Parameters:

events:

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

option()

Gets all widget options.

Return Value:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:

optionName:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

refresh()

Locks the widget until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown option and the handler assigned to the pullDown event.

release(preventScrollBottom)

Notifies the ScrollView that data loading is finished.

Parameters:

preventScrollBottom:

Boolean

Specifies whether to prevent the onReachBottom handler execution.

Return Value:

Promise<void> (jQuery or native)

A Promise that is resolved after the widget is released. It is a native Promise or a jQuery.Promise when you use jQuery.

Use this method to hide the load indicator and release the scroll view after the pullDown or reachBottom events have been raised.

resetOption(optionName)

Resets an option to its default value.

Parameters:

optionName:

An option's name.

scrollBy(distance)

Scrolls the content by a specific distance.

Parameters:

distance:

The distance in pixels.

scrollBy(distanceObject)

Scrolls the content by a specific distance in horizontal and vertical directions.

Parameters:

distanceObject:

The distance in pixels. Has the following format: { left: value1, top: value2 }.

scrollHeight()

Gets the scrollable content's height in pixels.

Return Value:

The content's height in pixels.

scrollLeft()

Gets the left scroll offset.

Return Value:

The left scroll offset in pixels.

scrollOffset()

Gets the scroll offset.

Return Value:

The scroll offset. Has the following format: { top: scrollTop, left: scrollLeft }.

scrollTo(targetLocation)

Scrolls the content to a specific position.

Parameters:

targetLocation:

The position to scroll to (in pixels).

scrollTo(targetLocationObject)

Scrolls the content to a specific position.

Parameters:

targetLocation:

The position to scroll to (in pixels). Has the following format: { left: value1, top: value2 }.

scrollToElement(targetLocation)

Scrolls the content to an element.

Parameters:

element:

Element

|

jQuery

A DOM Node or jQuery element to scroll to.

scrollTop()

Gets the top scroll offset.

Return Value:

The top scroll offset in pixels.

scrollWidth()

Gets the scrollable content's width in pixels.

Return Value: