JavaScript/jQuery ScrollView Methods
This section describes the members used to manipulate the UI component.
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
content()
Gets the UI component's content.
An HTML element or a jQuery element when you use jQuery.
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
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
DevExpress.ui.dxScrollView.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ScrollView properties } });
Angular
import ScrollView from "devextreme/ui/scroll_view"; // ... export class AppComponent { constructor () { ScrollView.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ScrollView properties } }); } }
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 properties } }); export default { components: { DxScrollView } } </script>
React
import React, {useEffect} from "react"; import dxScrollView from "devextreme/ui/scroll_view"; import ScrollView from "devextreme-react/scroll-view"; export default function App() { useEffect(() => { dxScrollView.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ScrollView properties } }) }); return ( <div> <ScrollView id="scrollView1" /> <ScrollView id="scrollView2" /> </div> ) }
dispose()
Disposes of all the resources allocated to the ScrollView instance.
After calling this method, remove the DOM element associated with the UI component:
$("#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
<dx-scroll-view ... *ngIf="condition"> </dx-scroll-view>
Vue
<template> <DxScrollView ... v-if="condition"> </DxScrollView> </template> <script> import DxScrollView from 'devextreme-vue/scroll-view'; export default { components: { DxScrollView } } </script>
React
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;
See Also
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
getInstance(element)
Gets the instance of a UI component found using its DOM node.
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);
See Also
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
option(options)
Updates the values of several properties.
Options with 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.
Specifies whether to prevent the onReachBottom handler execution.
A Promise that is resolved after the UI component is released. It is a native Promise or a jQuery.Promise when you use jQuery.
resetOption(optionName)
Resets a property to its default value.
A property's name.
scrollHeight()
Gets the scrollable content's height in pixels.
The content's height in pixels.
scrollOffset()
Gets the scroll offset.
The scroll offset. Has the following format: { top: scrollTop, left: scrollLeft }.
scrollWidth()
Gets the scrollable content's width in pixels.
The content's width in pixels.
update()
Updates the scrollable contents' dimensions.
A Promise that is resolved after the update is completed. It is a native Promise or a jQuery.Promise when you use jQuery.
If you have technical questions, please create a support ticket in the DevExpress Support Center.