A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://js.devexpress.com/Vue/Documentation/ApiReference/UI_Components/dxList/Methods/ below:

Vue List Methods | Vue Documentation

This section describes members used to manipulate the UI component.

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

Gets the UI component's height in pixels.

The UI component's height in pixels.

Collapses a group with a specific 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.

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

Parameters:

The component's default device properties.

Object structure:

Name Type Description device

Device

|

Function

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

options

Object

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

Removes an item found using its DOM node.

Removes an item with a specific index.

Parameters:

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

Disposes of all the resources allocated to the List instance.

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;

Gets the root UI component element.

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

Expands a group with a specific index.

Sets focus on the UI component.

Gets the instance of a UI component found using its DOM node.

Parameters:

The UI component's container.

The UI component's instance.

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

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

This UI component's instance.

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

true if the item is selected; otherwise false.

Checks whether an item with a specific index is selected.

Parameters:

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

true if the item is selected; otherwise false.

Detaches all event handlers from a single event.

The object for which this method is called.

Detaches a particular event handler from a single event.

Parameters:

The event's name.

The event's handler.

The object for which this method is called.

Subscribes to an event.

Parameters:

The event's name.

The event's handler.

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

Subscribes to events.

Parameters:

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

Gets the value of a single property.

Parameters:

The property's name or full path.

Return Value: any

This property's value.

Updates the value of a single property.

Parameters:

The property's name or full path.

optionValue: any

This property's new value.

Updates the values of several properties.

Parameters:

Options with their new values.

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

Parameters:

A key.

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:

A custom handler for a key cancels the default handler for this key.

See Also

Reloads list data.

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

See Also

Reorders items found using their DOM nodes.

Parameters:

The DOM node of the item to be reordered.

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

Reorders items with specific indexes.

Parameters:

The index of the item to be reordered.

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

If the UI component displays a grouped list, the item index should be specified like the following:

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

This method reorders items in the

items

array, but it does not affect the

dataSource

.

See Also

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.

Resets a property to its default value.

Scrolls the content by a specified distance.

Gets the content's height in pixels.

The content's height in pixels.

Scrolls the content to a specific position.

Parameters:

The position to scroll to (in pixels).

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

Scrolls the content to an item with a specific index.

If the UI component displays a grouped list, specify the target item index using an object containing the following fields.

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

Gets the top scroll offset.

The top scroll offset in pixels.

Selects all items.

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

Selects an item found using its DOM node.

Selects an item with a specific index.

Parameters:

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 property that accepts the following values.

See Also

Cancels the selection of all items.

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

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

Cancels the selection of an item with a specific index.

Parameters:

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

Updates the UI component scrollbar according to UI component content size.

Use this method to update the position of list items after the UI component element was resized.

See Also Feel free to share topic-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you for the feedback!

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4