React ScrollView Methods

This section describes the members used to manipulate the widget.

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

clientHeight()

Gets the widget's height.

Return Value:

Number

The widget's height in pixels.

See Also

clientWidth()

Gets the widget's width.

Return Value:

Number

The widget's width in pixels.

See Also

content()

Gets the widget's content.

Return Value:

HTMLElement | jQuery

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

See Also

defaultOptions(rule)

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

Parameters:
rule:

Object

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.

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
            }
        });
    }
}

dispose()

Disposes of all the resources allocated to the ScrollView instance.

The following code disposes of an ScrollView instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:

jQuery
JavaScript
$("#myScrollView").dxScrollView("dispose");
$("#myScrollView").remove();
Angular
HTML
<dx-scroll-view #scrollViewVar id="myScrollView"></dx-scroll-view>
TypeScript
import { ..., ViewChild } from "@angular/core";
import { DxScrollViewComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("scrollViewVar") scrollView: DxScrollViewComponent;

    removeScrollView (e) {
        this.scrollView.instance.dispose();
        document.getElementById("myScrollView").remove();
    }
}

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

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

See Also

endUpdate()

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

Main article: beginUpdate()

See Also

getInstance(element)

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

Parameters:
element:

DOM Node

|

jQuery

The widget's container.

Return Value:

Object

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);
See Also

instance()

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

Return Value:

ScrollView

This widget's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

ScrollView

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

ScrollView

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

ScrollView

The object for which this method is called.

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

See Also

on(events)

Subscribes to events.

Parameters:
events:

Object

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

Return Value:

ScrollView

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.

See Also

option()

Gets all widget options.

Return Value:

Object

The widget's options.

See Also

option(optionName)

Gets the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

Return Value: any

This option's value.

See Also

option(optionName, optionValue)

Updates the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

See Also

option(options)

Updates the values of several options.

Parameters:
options:

Object

Options with their new values.

See Also

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.

See Also

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.

See Also

scrollBy(distance)

Scrolls the content by a specific distance.

Parameters:
distance:

Number

The distance in pixels.

See Also

scrollBy(distanceObject)

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

Parameters:
distanceObject:

Object

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

See Also

scrollHeight()

Gets the scrollable content's height in pixels.

Return Value:

Number

The content's height in pixels.

See Also

scrollLeft()

Gets the left scroll offset.

Return Value:

Number

The left scroll offset in pixels.

See Also

scrollOffset()

Gets the scroll offset.

Return Value:

Object

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

See Also

scrollTo(targetLocation)

Scrolls the content to a specific position.

Parameters:
targetLocation:

Number

The position to scroll to (in pixels).

See Also

scrollTo(targetLocationObject)

Scrolls the content to a specific position.

Parameters:
targetLocation:

Object

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

See Also

scrollToElement(targetLocation)

Scrolls the content to an element.

Parameters:
element:

DOM Node

|

jQuery

A DOM Node or jQuery element to scroll to.

See Also

scrollTop()

Gets the top scroll offset.

Return Value:

Number

The top scroll offset in pixels.

See Also

scrollWidth()

Gets the scrollable content's width in pixels.

Return Value:

Number

The content's width in pixels.

See Also

update()

Updates the scrollable contents' dimensions.

Return Value:

Promise<void> (jQuery or native)

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

Use this method to fit the widget's contents to the widget's size if it changes.

See Also