Angular ScrollView Methods

The UI component's height in pixels.

clientWidth()

Gets the UI component's width.

Return Value:

The UI component's width in pixels.

content()

Gets the UI component'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 properties for this component.

Parameters:

rule:

The component's default device properties.

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 properties should be applied to the device.
options	Object	Propertiesto 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 properties should be applied to the device.

options

Propertiesto be applied.

defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the ScrollView UI component 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 UI component:

JavaScript

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

Use this method only if the UI component 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 UI component element.

Return Value:

HTMLElement | jQuery

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

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:

element:

Element

|

jQuery

The UI component's container.

Return Value:

The UI component's instance.

getInstance is a static method that the UI component 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 UI component's instance. Use it to access other methods of the UI component.

Return Value:

This UI component'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 UI component properties.

Return Value:

The UI component's properties.

option(optionName)

Gets the value of a single property.

Parameters:

optionName:

The property's name or full path.

Return Value: any

This property's value.

option(optionName, optionValue)

Updates the value of a single property.

Parameters:

optionName:

The property's name or full path.

optionValue: any

This property's new value.

option(options)

Updates the values of several properties.

Parameters:

options:

Propertieswith their new values.

refresh()

Locks the UI component until the release(preventScrollBottom) method is called and executes the function passed to the onPullDown property 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 UI component 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 property to its default value.

Parameters:

optionName:

An property's name.

scrollBy(distance)

Scrolls the content by a specific distance.

Parameters:

distance:

|

The distance in pixels.
When you specify this parameter with an object, it should have the following structure: { 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).
When you specify this parameter with an object, it should have the following structure: { left: value1, top: value2 }.

scrollToElement(element)

Scrolls 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: