JavaScript/jQuery ScrollView Methods
This section describes the members used to manipulate the UI component.
See Also
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
clientHeight()
Gets the UI component's height.
The UI component's height in pixels.
See Also
clientWidth()
Gets the UI component's width.
The UI component's width in pixels.
See Also
content()
Gets the UI component's content.
An HTML element or a jQuery element when you use jQuery.
See Also
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
| Name | Type | Description |
|---|---|---|
| device | | |
Device parameters. |
| options |
Options to 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
DevExpress.ui.dxScrollView.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the ScrollView properties
}
});Angular
import ScrollView, { Properties } from "devextreme/ui/scroll_view";
// ...
export class AppComponent {
constructor () {
ScrollView.defaultOptions<Properties>({
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 dxScrollView from "devextreme/ui/scroll_view";
import ScrollView from "devextreme-react/scroll-view";
dxScrollView.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the ScrollView properties
}
});
export default function App() {
return (
<div>
<ScrollView id="scrollView1" />
<ScrollView id="scrollView2" />
</div>
)
}You can also set rules for multiple device types:
jQuery
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
DevExpress.ui.dxScrollView.defaultOptions({
device: deviceConfig,
options: {
// Here go the ScrollView properties
}
});
});Angular
import ScrollView, { Properties } from "devextreme/ui/scroll_view";
// ...
export class AppComponent {
constructor () {
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
ScrollView.defaultOptions<Properties>({
device: deviceConfig,
options: {
// Here go the ScrollView properties
}
});
});
}
}Vue
<template>
<div>
<DxScrollView />
</div>
</template>
<script>
import DxScrollView from "devextreme-vue/scroll-view";
import ScrollView from "devextreme/ui/scroll_view";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
ScrollView.defaultOptions({
device: deviceConfig,
options: {
// Here go the ScrollView properties
}
});
});
export default {
components: {
DxScrollView
}
}
</script>React
import dxScrollView from "devextreme/ui/scroll_view";
import ScrollView from "devextreme-react/scroll-view";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
dxScrollView.defaultOptions({
device: deviceConfig,
options: {
// Here go the ScrollView properties
}
});
});
export default function App() {
return (
<div>
<ScrollView />
</div>
)
}dispose()
Disposes of all the resources allocated to the ScrollView instance.
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myScrollView").dxScrollView("dispose");
$("#myScrollView").remove();Angular
Use conditional rendering instead of this method:
<dx-scroll-view ...
*ngIf="condition">
</dx-scroll-view>Vue
Use conditional rendering instead of this method:
<template>
<DxScrollView ...
v-if="condition">
</DxScrollView>
</template>
<script>
import DxScrollView from 'devextreme-vue/scroll-view';
export default {
components: {
DxScrollView
}
}
</script>React
Use conditional rendering instead of this method:
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.
An HTML element or a jQuery element when you use jQuery.
See Also
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
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.
See Also
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
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
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
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
option(options)
Updates the values of several properties.
Options with their new values.
See Also
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.
See Also
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.
Use this method to hide the load indicator and release the scroll view after the pullDown or reachBottom events have been raised.
See Also
resetOption(optionName)
Resets a property to its default value.
A property's name.
See Also
scrollHeight()
Gets the scrollable content's height in pixels.
The content's height in pixels.
See Also
scrollOffset()
Gets the scroll offset.
The scroll offset. Has the following format: { top: scrollTop, left: scrollLeft }.
See Also
scrollWidth()
Gets the scrollable content's width in pixels.
The content's width in pixels.
See Also
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 UI component's contents to the UI component's size if it changes.