The native 'android.widget.FrameLayout' object.
The native 'com.telerik.widget.list.RadListView' object.
Gets or sets a value indicating if the collapse/expand grouping functionality of the RadListView is enabled.
Gets or sets a function that will be called to filter the items of the RadListView if either {@link enableGroups} or enableCollapsibleGroups property is set to 'true'.
Gets or sets the template used to visualize a footer in the list.
Gets or sets a function that will be called to group the items of the RadListView if either {@link enableGroups} or enableCollapsibleGroups property is set to 'true'.
Gets or sets the template used to visualize a header in the list.
Gets or sets a boolean value determining whether reordering items is enabled or not.
[@deprecated: Please use the 'swipeActions' instead].
Gets or sets the UI template for the background view of an item shown on during swipe.
Gets or sets the UI template for list view items.
A function that returns the appropriate key that represents the template based on the data item.
Gets or sets the UI templates for list view items.
Gets or sets the item view loaded used by the @link RadListView} when creating its item views.
Gets or sets the source collection used to populate the RadListView.
The layout object used to arrange items.
Gets or sets a number determining the amount of items remaining between the current scrolling position and the end which, when exceeded, will trigger a loadMoreDataRequestedEvent.
Gets or sets a value from the ListViewLoadOnDemandMode list determining the currently active load-on-demand mode.
Gets or sets a boolean value determining whether multiple selection is enabled or not.
Gets or sets a boolean value determining whether the user is able to perform the pull-to-refresh gesture.
Gets or sets an instance of the PullToRefreshStyle class used to style the Pull-to-Refresh indicator.
Gets or sets a value from the ListViewReorderMode enum determining whether item reorder will happen on hold and drag or simply drag.
Gets or sets the scroll position used by the 'scrollToIndex()' function. Available on iOS only.
Gets or sets a value from the ListViewSelectionBehavior list determining whether items are selected on press, long press, or can't be selected at all.
Gets or sets a function that will be called to sort the items of the RadListView if either {@link enableGroups} or enableCollapsibleGroups property is set to 'true'.
Gets or sets a boolean value determining whether the user is able to swipe items or not.
This event is raised when the RadListView has populated an object from its 'items' collection.
Identifies the enableCollapsibleGroups dependency property. NOTE: This feature is not supported on iOS
Identifies the filteringFunction dependency property.
Identifies the footerItemTemplate dependency property.
Identifies the groupingFunction dependency property.
Identifies the headerItemTemplate dependency property.
This event is fired after deselecting an item. The event exposes an instance of the ListViewEventData class.
This event is fired before item to be deselected. Return value indicates whether the specified item should be deselected. The event exposes an instance of the ListViewEventData class.
This event is fired when the user presses and holds an item. The event exposes an instance of the ListViewEventData class.
This event is fired each time an item is about to be visualized by RadListView. The event provides an instance of the ListViewEventData class and exposes the a View instance that represents container to be visualized. It allows for customization of the appearance of a particular item depending on the data object assigned to it.
Identifies the itemReorder dependency property.
This event is fired when an item is about to be reordered. The event exposes an instance of the ListViewEventData class which contains the items of the item that is about to be reordered.
This event is fired when the user attempts to reorder an item. It can be used to cancel the reorder procedure. The event exposes an instance of the ListViewEventData class which contains the items of the item that is about to be reordered. Using the {@code returnValue} property of the event arguments you can block or allow the reordering procedure.
This event is fired after reordering an item in list view. The event exposes an instance of the ListViewEventData class which data property which returns an object containing a targetIndex and targetGroupIndex properties depicting the destination of the reordered item.
This event is fired after selecting an item. The event exposes an instance of the ListViewEventData class.
This event is fired before an item to be selected. Return value indicates whether the specified item should be selected. The event exposes an instance of the ListViewEventData class.
This event is continuously fired while the user is swiping an item. The event arguments expose an instance of the ListViewEventData. An additional 'data' property of the arguments exposes an instance of the SwipeOffsets class containing information about the swipe progress.
This event is fired when the user has finished swiping an item. The event arguments expose an instance of the ListViewEventData. An additional 'data' property of the arguments exposes an instance of the SwipeOffsets class containing information about the swipe progress.
This event is fired when the user starts swiping a item. The event arguments expose an instance of the ListViewEventData. An additional 'data' property exposes an instance of the SwipeOffsets class containing information about the swipe progress.
[@deprecated: Please use the 'swipeActions' instead].
Identifies the itemSwipeTemplate dependency property.
This event is fired when the user starts swiping a item. The handler of the event receives an instance of the ListViewEventData. The returnValue property of the arguments can be used to cancel the swipe gesture.
This event is fired when the user clicks/taps an item. The event exposes an instance of the ListViewEventData class.
Identifies the itemTemplate dependency property.
Identifies the items dependency property.
Identifies the listViewLayout dependency property.
Called after the user requested loading more data on demand by scrolling over the item buffer limit size. The event exposes an instance of the ListViewEventData class which returnValue property determines whether more data will be loaded.
Identifies the loadOnDemandBufferSize dependency property.
Identifies the loadOnDemandMode dependency property.
Identifies the multipleSelection dependency property.
Called after the user requested loading more data by pulling down the list. The event exposes an instance of the ListViewEventData class which returnValue property determines whether more data will be loaded.
Identifies the pullToRefresh dependency property.
Identifies the pullToRefreshStyle dependency property.
Identifies the reorderMode dependency property.
This event is fired each time the user raises their finger from the device's screen as a result of a scrolling gesture. This event marks the end of a user-interaction sessions related to scrolling the list. An instance of the ListViewScrollEventData is provided with information about the scroll offset.
This event is fired each time the list stops scrolling. An instance of the ListViewScrollEventData is provided with information about the scroll offset.
Identifies the scrollPosition dependency property. Available on iOS only.
This event is fired each time the list starts scrolling. An instance of the ListViewScrollEventData is provided with information about the scroll offset.
This event is fired each time the list changes its scroll offset. An instance of the ListViewScrollEventData is provided with information about the scroll offset.
Identifies the selectionBehavior dependency property.
Identifies the sortingFunction dependency property.
Identifies the swipeActions dependency property.
Deselects all items currently available in RadListView.
Deselects the item at the provided index if it is selected.
the index of the item within the data source.
Returns the data item at the specified index.
Returns the current scroll offset of the list in pixels.
Returns an ObservableArray that contains the items currently selected in RadListView.
Returns the {N} View that is used to visualize the provided item from the currently assigned source.
In case the item is not in the current viewport the method returns undefined.
The item from the current source for which to find the View.
The {N} View used to visualize the provided item.
Checks whether the provided item is selected or not. Returns true if the item is selected, otherwise false.
an arbitrary item part of the data source the current RadListView instance is populated with.
Must be called when data is delivered after a load-on-demand request has been made.
Must be called when data is delivered after a pull-to-refresh gesture initiated by the user.
Must be called when a swipe-to-execute action has been requested. Calling this method will close the revealed swipe actions.
Refreshes the RadListView by rebinding it to the source.
When called, resumes the UI updates performed by RadListView when changes in the source collection occur.
When true RadListView will perform a complete UI refresh.
Scrolls the list to a position where the item with the provided index is visible.
the index of the item from the source which needs to be shown.
a boolean value determining whether the list will animate to the desired position.
Scrolls the list to a position where the item with the provided index is visible.
the index of the item from the source which needs to be shown.
a boolean value determining whether the list will animate to the desired position. Currently, the animate value must always be {@code true}.
a value from the ListViewItemSnapMode enum determining the snap position for the item at the target index.
Scrolls the list to a position where the item with the provided index is visible.
the index of the item from the source which needs to be shown.
Scrolls the list component with a given amount of pixels in the currently active direction. The scroll is either in a forward or a backward direction depending on the sign of the amount.
the amount of pixels to scroll by.
if animation is to be used when scrolling, otherwise {@code false}.
Selects all items currently available in RadListView.
Selects the item from the data source at the provided index.
the index of the item within the data source.
When called, prevents RadListView from refreshing its UI when changes in the source collection occur. This call is reversed via a call of the resumeUpdates method.
Returns a boolean value that determines whether the UI updates are currently suspended.
Generated using TypeDoc
This class represents the RadListView component. RadListView is based on the already familiar native Android and iOS components from Progress Telerik UI for Android and Progress Telerik UI for iOS. The component exposes all major features supported by the native controls through a unified API suitable for NativeScript developers.