Angular List API

Specifies the shortcut key that sets focus on the UI component.

Specifies whether the UI component changes its visual state as a result of user interaction.

Specifies whether or not an end user can delete list items.

A Boolean value specifying whether to enable or disable the bounce-back effect.

Specifies whether or not an end user can collapse groups.

Binds the UI component to data.

Specifies whether the UI component responds to user interaction.

Specifies the data field whose values should be displayed. Defaults to "text" when the data source contains objects.

Specifies the global attributes to be attached to the UI component's container element.

Specifies whether the UI component can be focused using keyboard navigation.

An alias for the groupTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

Specifies whether data items should be grouped.

An alias for the groupTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

Specifies a custom template for group captions.

Specifies the UI component's height.

Specifies text for a hint that appears when a user pauses on the UI component.

Specifies whether the UI component changes its state when a user pauses on it.

Specifies whether or not to show the loading panel when the DataSource bound to the UI component is loading data.

An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

Specifies the way a user can delete items from the list.

Configures item reordering using drag and drop gestures.

The time period in milliseconds before the onItemHold event is raised.

An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

An array of items displayed by the UI component.

Specifies a custom template for items.

Specifies the key property that provides key values to access data items. Each key value must be unique.

Specifies the array of items for a context menu called for a list item.

Specifies whether an item context menu is shown when a user holds or swipes an item.

The text displayed on the button used to load the next page from the data source.

Specifies the text or HTML markup displayed by the UI component if the item collection is empty.

A function that is executed when the UI component is rendered and each time the component is repainted.

A function that is executed before the UI component is disposed of.

A function that is executed when a group element is rendered.

A function used in JavaScript frameworks to save the UI component instance.

A function that is executed when a collection item is clicked or tapped.

A function that is executed when a collection item is right-clicked or pressed.

A function that is executed after a list item is deleted from the data source.

A function that is executed before a collection item is deleted from the data source.

A function that is executed when a collection item has been held for a specified period.

A function that is executed after a collection item is rendered.

A function that is executed after a list item is moved to another position.

A function that is executed when a list item is swiped.

A function that is executed after a UI component property is changed.

A function that is executed before the next page is loaded.

A function that is executed when the "pull to refresh" gesture is performed. Supported on mobile devices only.

A function that is executed on each scroll gesture.

A function that is executed when the "Select All" check box value is changed. Applies only if the selectionMode is "all".

A function that is executed when a collection item is selected or selection is canceled.

Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom.

Specifies whether the next page is loaded when a user scrolls the UI component to the bottom or when the "next" button is clicked.

Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold.

Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold.

A Boolean value specifying whether or not the UI component supports the "pull down to refresh" gesture.

Specifies the text displayed in the pullDown panel while the list is being refreshed.

Specifies whether to repaint only those elements whose data changed.

Switches the UI component to a right-to-left representation.

A Boolean value specifying if the list is scrolled by content.

Specifies whether a user can scroll the content with the scrollbar. Applies only if useNativeScrolling is false.

A Boolean value specifying whether to enable or disable list scrolling.

Configures the search panel.

Specifies whether the search panel is visible.

Specifies a data object's field name or an expression whose value is compared to the search string.

Specifies a comparison operation used to search UI component items.

Specifies a delay in milliseconds between when a user finishes typing, and the search is executed.

Specifies the current search string.

Specifies the mode in which all items are selected.

Specifies the text displayed at the "Select All" check box.

Specifies whether an item is selected if a user clicks it.

Specifies an array of currently selected item keys.

An array of currently selected item objects.

Specifies item selection mode.

Specifies when the UI component shows the scrollbar.

Specifies whether or not to display controls used to select list items.

Specifies the number of the element when the Tab key is used for navigating.

Specifies whether or not the UI component uses native scrolling.

Specifies whether the UI component is visible.

Specifies the UI component's width.

Postpones rendering that can negatively affect performance until the endUpdate() method is called.

Gets the UI component's height in pixels.

Collapses a group with a specific index.

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

Removes an item found using its DOM node.

Removes an item with a specific index.

Disposes of all the resources allocated to the List instance.

Gets the root UI component element.

Refreshes the UI component after a call of the beginUpdate() method.

Expands a group with a specific index.

Sets focus on the UI component.

Gets the DataSource instance.

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

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

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

Checks whether an item with a specific index is selected.

Detaches all event handlers from a single event.

Detaches a particular event handler from a single event.

Subscribes to an event.

Subscribes to events.

Gets all UI component properties.

Gets the value of a single property.

Updates the value of a single property.

Updates the values of several properties.

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

Reloads list data.

Reorders items found using their DOM nodes.

Reorders items with specific indexes.

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.

Scrolls the content to a specific position.

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

Scrolls the content to an item with a specific index.

Gets the top scroll offset.

Selects all items.

Selects an item found using its DOM node.

Selects an item with a specific index.

Cancels the selection of all items.

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

Cancels the selection of an item with a specific index.

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

Raised when the UI component's content is ready.

Raised before the UI component is disposed of.

Raised when a group element is rendered.

Raised only once, after the UI component is initialized.

Raised when a collection item is clicked or tapped.

Raised when a collection item is right-clicked or pressed.

Raised after a list item is deleted from the data source.

Raised before a collection item is deleted from the data source.

Raised when a collection item has been held for a specified period.

Raised after a collection item is rendered.

Raised after a list item is moved to another position.

Raised when a list item is swiped.

Raised after a UI component property is changed.

Raised before the next page is loaded.

Raised when the "pull to refresh" gesture is performed.

Raised on each scroll gesture.

Raised when the "Select All" check box value is changed.

Raised when a collection item is selected or selection is canceled.

The type of the contentReady event handler's argument.

The type of the disposing event handler's argument.

The type of the groupRendered event handler's argument.

The type of the initialized event handler's argument.

The type of the itemClick event handler's argument.

The type of the itemContextMenu event handler's argument.

The type of the itemDeleted event handler's argument.

Specifies the way a user can delete items from the list.

The type of the itemDeleting event handler's argument.

The type of the itemHold event handler's argument.

The type of the itemRendered event handler's argument.

The type of the itemReordered event handler's argument.

The type of the itemSwipe event handler's argument.

Specifies whether an item context menu is shown when a user holds or swipes an item.

The type of the optionChanged event handler's argument.

The type of the pageLoading event handler's argument.

The type of the pullRefresh event handler's argument.

The type of the scroll event handler's argument.

The type of the selectAllValueChanged event handler's argument.

The type of the selectionChanged event handler's argument.