JavaScript/jQuery ScrollView Methods
This section describes the members used to manipulate the widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
clientHeight()
Gets the widget's height.
The widget's height in pixels.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
clientWidth()
Gets the widget's width.
The widget's width in pixels.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
content()
Gets the widget's content.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
defaultOptions(rule)
Specifies the device-dependent default configuration options for this component.
The component's default device options.
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
DevExpress.ui.dxScrollView.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ScrollView options } });
Angular
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:
jQuery
$("#myScrollView").dxScrollView("dispose"); $("#myScrollView").remove();
Angular
<dx-scroll-view #scrollViewVar id="myScrollView"></dx-scroll-view>
import { ..., ViewChild } from "@angular/core"; import { DxScrollViewComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("scrollViewVar", { static: false }) scrollView: DxScrollViewComponent; // Prior to Angular 8 // @ViewChild("scrollViewVar") scrollView: DxScrollViewComponent; removeScrollView (e) { this.scrollView.instance.dispose(); document.getElementById("myScrollView").remove(); } }
element()
Gets the root widget element.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getInstance(element)
Gets the instance of a widget found using its DOM node.
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.
This widget's instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Subscribes to an event.
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
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
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
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all widget options.
The widget's options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
Gets the value of a single option.
The option's name or full path.
This option's value.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollBy(distance)
Scrolls the content by a specific distance.
The distance in pixels.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollBy(distanceObject)
Scrolls the content by a specific distance in horizontal and vertical directions.
The distance in pixels. Has the following format: { left: value1, top: value2 }.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollHeight()
Gets the scrollable content's height in pixels.
The content's height in pixels.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollLeft()
Gets the left scroll offset.
The left scroll offset in pixels.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollOffset()
Gets the scroll offset.
The scroll offset. Has the following format: { top: scrollTop, left: scrollLeft }.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollTo(targetLocation)
Scrolls the content to a specific position.
The position to scroll to (in pixels).
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollTo(targetLocationObject)
Scrolls the content to a specific position.
The position to scroll to (in pixels). Has the following format: { left: value1, top: value2 }.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollToElement(targetLocation)
Scrolls the content to an element.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollTop()
Gets the top scroll offset.
The top scroll offset in pixels.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
scrollWidth()
Gets the scrollable content's width in pixels.
The content's width in pixels.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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.
Use this method to fit the widget's contents to the widget's size if it changes.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.