Vue List Methods
This section describes 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
collapseGroup(groupIndex)
Collapses a group with a specific index.
The group's index.
A Promise that is resolved if the group is collapsed and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Expand and Collapse a Group
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 List widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxList.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the List options } });
Angular
import List from "devextreme/ui/list"; // ... export class AppComponent { constructor () { List.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the List options } }); } }
Vue
<template> <div> <dx-list id="list1" /> <dx-list id="list2" /> </div> </template> <script> import DxList from "devextreme-vue/list"; import List from "devextreme/ui/list"; List.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the List options } }); export default { components: { DxList } } </script>
React
import React from "react"; import dxList from "devextreme/ui/list"; import List from "devextreme-react/list"; class App extends React.Component { render () { dxList.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the List options } }) return ( <div> <List id="list1" /> <List id="list2" /> </div> ) } } export default App;
deleteItem(itemElement)
Removes an item found using its DOM node.
The item's DOM node.
A Promise that is resolved if the item is deleted and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Item Deletion API
deleteItem(itemIndex)
Removes an item with a specific index.
A Promise that is resolved if the item is deleted and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Item Deletion API
dispose()
Disposes of all the resources allocated to the List instance.
The following code disposes of an List instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:
jQuery
$("#myList").dxList("dispose"); $("#myList").remove();
Angular
<dx-list #listVar id="myList"></dx-list>
import { ..., ViewChild } from "@angular/core"; import { DxListComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("listVar") list: DxListComponent; removeList (e) { this.list.instance.dispose(); document.getElementById("myList").remove(); } }
element()
Gets the root widget element.
An HTML element or a jQuery element when you use jQuery.
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
expandGroup(groupIndex)
Expands a group with a specific index.
The group's index.
A Promise that is resolved if the group is expanded and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Expand and Collapse a Group
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- Data Layer - Overview
- Data Layer - DataSource Examples
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 List instance found in an element with the myList
ID:
// Modular approach import List from "devextreme/ui/list"; ... let element = document.getElementById("myList"); let instance = List.getInstance(element) as List; // Non-modular approach let element = document.getElementById("myList"); let instance = DevExpress.ui.dxList.getInstance(element);
See Also
instance()
Gets the widget's instance. Use it to access other methods of the widget.
This widget's instance.
isItemSelected(itemElement)
Checks whether an item found using its DOM node is selected.
The item's DOM node.
true if the item is selected; otherwise false.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Selection API
isItemSelected(itemIndex)
Checks whether an item with a specific index is selected.
true if the item is selected; otherwise false.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Selection API
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()
Gets all widget options.
The widget's options.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
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: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
A key.
A handler. Accepts the keydown event as the argument. It is a dxEvent or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
reload()
Reloads list data.
You can also reload list data using the "pull down" gesture if the pullRefreshEnabled option is set to true.
See Also
reorderItem(itemElement, toItemElement)
Reorders items found using their DOM nodes.
A Promise that is resolved if the item is moved and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Item Reordering API
reorderItem(itemIndex, toItemIndex)
Reorders items with specific indexes.
A Promise that is resolved if the item is moved and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
If the widget displays a grouped list, the item index should be specified like the following.
{ group: 1, index: 1 }
Where the group property specifies the group index, and the index property specifies the index of the required item within the group.
$("#myList").dxList("instance").reorderItem({ group: 1, index: 4 }, { group: 3, index: 2 });
This code will move the 4th item of the 1st group to the 3rd position in the 3rd group.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Item Reordering API
scrollBy(distance)
Scrolls the content by a specified distance.
The distance in pixels.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Scrolling API
scrollHeight()
Gets the content's height in pixels.
The content's height in pixels.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Scrolling API
scrollTo(location)
Scrolls the content to a specific position.
The position to scroll to (in pixels).
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Scrolling API
scrollToItem(itemElement)
Scrolls the content to an item found using its DOM node.
The item's DOM node.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Scrolling API
scrollToItem(itemIndex)
Scrolls the content to an item with a specific index.
If the widget displays a grouped list, specify the target item index using an object containing the following fields.
group
Specifies the index of the group containing the target item.item
Specifies the item index within the specified group.
var list = $("#myList").dxList("instance"); list.scrollToItem({ group: 3, item: 8 });
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Scrolling API
scrollTop()
Gets the top scroll offset.
The top scroll offset in pixels.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Scrolling API
selectAll()
Selects all items.
Depending on the value of the selectAllMode option, this method selects all items on all pages or on the currently rendered pages only. If a filter is applied, this method selects only those items that meet the filtering conditions.
See Also
selectItem(itemElement)
Selects an item found using its DOM node.
The item's DOM node.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Selection API
selectItem(itemIndex)
Selects an item with a specific index.
Note that the result of the method execution depends on the current value of the selectionMode option that accepts the following values.
none
The method does nothing.single
The method selects the specified item while the previously selected item becomes unselected.multi and all The method adds the specified item to the list of currently selected items.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Selection API
unselectAll()
Cancels the selection of all items.
Depending on the value of the selectAllMode option, this method clears selection of all items on all pages or on the currently rendered pages only. If a filter is applied, this method clears selection only of those items that meet the filtering conditions.
See Also
unselectItem(itemElement)
Cancels the selection of an item found using its DOM node.
The item's DOM node.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Selection API
unselectItem(itemIndex)
Cancels the selection of an item with a specific index.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- List - Selection API
updateDimensions()
Updates the widget scrollbar according to widget content size.
A Promise that is resolved after the update process 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.