JavaScript/jQuery List Methods

The widget's height in pixels.

collapseGroup(groupIndex)

Collapses a group with a specific index.

Parameters:

groupIndex:

The group's index.

Return Value:

Promise<void> (jQuery or native)

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.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

Parameters:

rule:

The component's default device options.

Object structure:

Name	Type	Description
device	Device \| Array<Device> \| Function	Device parameters. When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.
options	Object	Options to be applied.

Name

Type

Description

device

Device

|

Array<Device>

|

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.

options

Options to be applied.

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

JavaScript

DevExpress.ui.dxList.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the List options
    }
});

Angular

TypeScript

import List from "devextreme/ui/list";
// ...
export class AppComponent {
    constructor () {
        List.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the List options
            }
        });
    }
}

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 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.

Parameters:

itemElement:

The item's DOM node.

Return Value:

Promise<void> (jQuery or native)

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.

deleteItem(itemIndex)

Removes an item with a specific index.

Parameters:

itemIndex:

|

The item's index. If the items are grouped, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

Return Value:

Promise<void> (jQuery or native)

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.

dispose()

Disposes of all the resources allocated to the List instance.

After calling this method, remove the DOM element associated with the widget:

jQuery

JavaScript

$("#myList").dxList("dispose");
$("#myList").remove();

Angular

HTML

<dx-list #listVar id="myList"></dx-list>

TypeScript

import { ..., ViewChild } from "@angular/core";
import { DxListComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("listVar", { static: false }) list: DxListComponent;
    // Prior to Angular 8
    // @ViewChild("listVar") list: DxListComponent;

    removeList (e) {
        this.list.instance.dispose();
        document.getElementById("myList").remove();
    }
}

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

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()

expandGroup(groupIndex)

Expands a group with a specific index.

Parameters:

groupIndex:

The group's index.

Return Value:

Promise<void> (jQuery or native)

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.

focus()

Sets focus on the widget.

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE

This method returns the DataSource instance even if the widget's dataSource option was given a simple array.

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:

element:

|

jQuery

The widget's container.

Return Value:

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);

instance()

Gets the widget's instance. Use it to access other methods of the widget.

Return Value:

This widget's instance.

isItemSelected(itemElement)

Checks whether an item found using its DOM node is selected.

Parameters:

itemElement:

The item's DOM node.

Return Value:

Boolean

true if the item is selected; otherwise false.

isItemSelected(itemIndex)

Checks whether an item with a specific index is selected.

Parameters:

itemIndex:

|

The item's index. If the items are grouped, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

Return Value:

Boolean

true if the item is selected; otherwise false.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

on(events)

Subscribes to events.

Parameters:

events:

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

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.

option()

Gets all widget options.

Return Value:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:

optionName:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:

key:

A key.

handler:

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.

reload()

Reloads list data.

You can also reload list data using the "pull down" gesture if the pullRefreshEnabled option is set to true.

reorderItem(itemElement, toItemElement)

Reorders items found using their DOM nodes.

Parameters:

itemElement:

The DOM node of the item to be reordered.

toItemElement:

The DOM node of the item after which the reordered item should be placed.

Return Value:

Promise<void> (jQuery or native)

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.

NOTE

This method reorders items in the items array, but it does not affect the dataSource.

reorderItem(itemIndex, toItemIndex)

Reorders items with specific indexes.

Parameters:

itemIndex:

|

The index of the item to be reordered.

toItemIndex:

|

The index of the item after which the reordered item should be placed.

Return Value:

Promise<void> (jQuery or native)

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.

JavaScript

{
    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.

JavaScript

$("#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.

NOTE

This method reorders items in the items array, but it does not affect the dataSource.

repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.

scrollBy(distance)

Scrolls the content by a specified distance.

Parameters:

distance:

The distance in pixels.

scrollHeight()

Gets the content's height in pixels.

Return Value:

The content's height in pixels.

scrollTo(location)

Scrolls the content to a specific position.

Parameters:

location:

The position to scroll to (in pixels).

scrollToItem(itemElement)

Scrolls the content to an item found using its DOM node.

Parameters:

itemElement:

The item's DOM node.

scrollToItem(itemIndex)

Scrolls the content to an item with a specific index.

Parameters:

itemIndex:

|

The item's 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.

JavaScript

var list = $("#myList").dxList("instance");
list.scrollToItem({
    group: 3,
    item: 8
});

scrollTop()

Gets the top scroll offset.

Return Value:

The top scroll offset in pixels.

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.

selectItem(itemElement)

Selects an item found using its DOM node.

Parameters:

itemElement:

The item's DOM node.

selectItem(itemIndex)

Selects an item with a specific index.

Parameters:

itemIndex:

|

The item's index. If items are grouped, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

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.

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.

unselectItem(itemElement)

Cancels the selection of an item found using its DOM node.

Parameters:

itemElement:

The item's DOM node.

unselectItem(itemIndex)

Cancels the selection of an item with a specific index.

Parameters:

itemIndex:

|