JavaScript/jQuery List Methods
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
collapseGroup(groupIndex)
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
defaultOptions(rule)
| 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 List UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxList.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the List properties
}
});Angular
import List, { Properties } from "devextreme/ui/list";
// ...
export class AppComponent {
constructor () {
List.defaultOptions<Properties>({
device: { deviceType: "desktop" },
options: {
// Here go the List properties
}
});
}
}Vue
<template>
<div>
<DxList id="list1" />
<DxList 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 properties
}
});
export default {
components: {
DxList
}
}
</script>React
import dxList from "devextreme/ui/list";
import List from "devextreme-react/list";
dxList.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the List properties
}
});
export default function App() {
return (
<div>
<List id="list1" />
<List id="list2" />
</div>
)
}You can also set rules for multiple device types:
jQuery
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
DevExpress.ui.dxList.defaultOptions({
device: deviceConfig,
options: {
// Here go the List properties
}
});
});Angular
import List, { Properties } from "devextreme/ui/list";
// ...
export class AppComponent {
constructor () {
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
List.defaultOptions<Properties>({
device: deviceConfig,
options: {
// Here go the List properties
}
});
});
}
}Vue
<template>
<div>
<DxList />
</div>
</template>
<script>
import DxList from "devextreme-vue/list";
import List from "devextreme/ui/list";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
List.defaultOptions({
device: deviceConfig,
options: {
// Here go the List properties
}
});
});
export default {
components: {
DxList
}
}
</script>React
import dxList from "devextreme/ui/list";
import List from "devextreme-react/list";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
dxList.defaultOptions({
device: deviceConfig,
options: {
// Here go the List properties
}
});
});
export default function App() {
return (
<div>
<List />
</div>
)
}deleteItem(itemElement)
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
deleteItem(itemIndex)
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
dispose()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myList").dxList("dispose");
$("#myList").remove();Angular
Use conditional rendering instead of this method:
<dx-list ...
*ngIf="condition">
</dx-list>Vue
Use conditional rendering instead of this method:
<template>
<DxList ...
v-if="condition">
</DxList>
</template>
<script>
import DxList from 'devextreme-vue/list';
export default {
components: {
DxList
}
}
</script>React
Use conditional rendering instead of this method:
import React from 'react';
import List from 'devextreme-react/list';
function DxList(props) {
if (!props.shouldRender) {
return null;
}
return (
<List ... >
</List>
);
}
class App extends React.Component {
render() {
return (
<DxList shouldRender="condition" />
);
}
}
export default App;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
expandGroup(groupIndex)
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
getDataSource()
Gets the DataSource instance.
See Also
getInstance(element)
getInstance is a static method that the UI component 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
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a EventObject 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()
You can also reload list data using the "pull down" gesture if the pullRefreshEnabled property is set to true.
See Also
reorderItem(itemElement, toItemElement)
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
reorderItem(itemIndex, toItemIndex)
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 UI component 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.
jQuery
This code will move the 4th item of the 1st group to the 3rd position in the 3rd group:
$("#myList").dxList("instance").reorderItem({
group: 1,
index: 4
},
{
group: 3,
index: 2
});See Also
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint() method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
scrollToItem(itemIndex)
If the UI component 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.
jQuery
const list = $("#myList").dxList("instance");
list.scrollToItem({
group: 3,
item: 8
});See Also
selectAll()
Depending on the value of the selectAllMode property, 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(itemIndex)
Note that the result of the method execution depends on the current value of the selectionMode property 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
unselectAll()
Depending on the value of the selectAllMode property, 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
updateDimensions()
A Promise that is resolved after the update process is completed. It is a native Promise or a jQuery.Promise when you use jQuery.
Use this method to update the position of list items after the UI component element was resized.