/*! * devextreme-angular * Version: 19.1.16 * Build date: Tue Oct 18 2022 * * Copyright (c) 2012 - 2022 Developer Express Inc. ALL RIGHTS RESERVED * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file in the root of the project for details. * * https://github.com/DevExpress/devextreme-angular */ import { TransferState } from '@angular/platform-browser'; import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core'; import DevExpress from 'devextreme/bundles/dx.all'; import DxList from 'devextreme/ui/list'; import { DxComponent } from '../core/component'; import { DxTemplateHost } from '../core/template-host'; import { NestedOptionHost } from '../core/nested-option'; import { WatcherHelper } from '../core/watcher-helper'; import { IterableDifferHelper } from '../core/iterable-differ-helper'; import { DxiItemComponent } from './nested/item-dxi'; import { DxiMenuItemComponent } from './nested/menu-item-dxi'; /** * The List is a widget that represents a collection of items in a scrollable list. */ export declare class DxListComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxList; /** * Specifies the shortcut key that sets focus on the widget. */ accessKey: string; /** * Specifies whether or not the widget changes its state when interacting with a user. */ activeStateEnabled: boolean; /** * Specifies whether or not an end user can delete list items. */ allowItemDeleting: boolean; /** * Specifies whether a user can reorder list items. Grouped items cannot be moved from one group to another. */ allowItemReordering: boolean; /** * A Boolean value specifying whether to enable or disable the bounce-back effect. */ bounceEnabled: boolean; /** * Specifies whether or not an end-user can collapse groups. */ collapsibleGroups: boolean; /** * Binds the widget to data. */ dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array; /** * Specifies whether the widget responds to user interaction. */ disabled: boolean; /** * Specifies the data field whose values should be displayed. Defaults to "text" when the data source contains objects. */ displayExpr: Function | string; /** * Specifies the attributes to be attached to the widget's root element. */ elementAttr: any; /** * Specifies whether the widget can be focused using keyboard navigation. */ focusStateEnabled: boolean; /** * Specifies whether data items should be grouped. */ grouped: boolean; /** * Specifies a custom template for group captions. */ groupTemplate: any; /** * Specifies the widget's height. */ height: number | Function | string; /** * Specifies text for a hint that appears when a user pauses on the widget. */ hint: string; /** * Specifies whether the widget changes its state when a user pauses on it. */ hoverStateEnabled: boolean; /** * Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data. */ indicateLoading: boolean; /** * Specifies the way a user can delete items from the list. */ itemDeleteMode: string; /** * The time period in milliseconds before the onItemHold event is raised. */ itemHoldTimeout: number; /** * An array of items displayed by the widget. */ items: Array; /** * Specifies a custom template for items. */ itemTemplate: any; /** * Specifies which data field provides keys for widget items. */ keyExpr: Function | string; /** * Specifies the array of items for a context menu called for a list item. */ menuItems: Array; /** * Specifies whether an item context menu is shown when a user holds or swipes an item. */ menuMode: string; /** * The text displayed on the button used to load the next page from the data source. */ nextButtonText: string; /** * The text or HTML markup displayed by the widget if the item collection is empty. */ noDataText: string; /** * Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom. */ pageLoadingText: string; /** * Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked. */ pageLoadMode: string; /** * Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold. */ pulledDownText: string; /** * Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. */ pullingDownText: string; /** * A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture. */ pullRefreshEnabled: boolean; /** * Specifies the text displayed in the pullDown panel while the list is being refreshed. */ refreshingText: string; /** * Specifies whether to repaint only those elements whose data changed. */ repaintChangesOnly: boolean; /** * Switches the widget to a right-to-left representation. */ rtlEnabled: boolean; /** * A Boolean value specifying if the list is scrolled by content. */ scrollByContent: boolean; /** * A Boolean value specifying if the list is scrolled using the scrollbar. */ scrollByThumb: boolean; /** * A Boolean value specifying whether to enable or disable list scrolling. */ scrollingEnabled: boolean; /** * Configures the search panel. */ searchEditorOptions: DevExpress.ui.dxTextBoxOptions; /** * Specifies whether the search panel is visible. */ searchEnabled: boolean; /** * Specifies a data object's field name or an expression whose value is compared to the search string. */ searchExpr: Function | Array; /** * Specifies a comparison operation used to search widget items. */ searchMode: string; /** * Specifies a delay in milliseconds between when a user finishes typing, and the search is executed. */ searchTimeout: number; /** * Specifies the current search string. */ searchValue: string; /** * Specifies the mode in which all items are selected. */ selectAllMode: string; /** * Specifies an array of currently selected item keys. */ selectedItemKeys: Array; /** * An array of currently selected item objects. */ selectedItems: Array; /** * Specifies item selection mode. */ selectionMode: string; /** * Specifies when the widget shows the scrollbar. */ showScrollbar: string; /** * Specifies whether or not to display controls used to select list items. */ showSelectionControls: boolean; /** * Specifies the number of the element when the Tab key is used for navigating. */ tabIndex: number; /** * Specifies whether or not the widget uses native scrolling. */ useNativeScrolling: boolean; /** * Specifies whether the widget is visible. */ visible: boolean; /** * Specifies the widget's width. */ width: number | Function | string; /** * A function that is executed when the widget's content is ready and each time the content is changed. */ onContentReady: EventEmitter; /** * A function that is executed before the widget is disposed of. */ onDisposing: EventEmitter; /** * A function that is executed when a group element is rendered. */ onGroupRendered: EventEmitter; /** * A function used in JavaScript frameworks to save the widget instance. */ onInitialized: EventEmitter; /** * A function that is executed when a collection item is clicked or tapped. */ onItemClick: EventEmitter; /** * A function that is executed when a collection item is right-clicked or pressed. */ onItemContextMenu: EventEmitter; /** * A function that is executed after a list item is deleted from the data source. */ onItemDeleted: EventEmitter; /** * A function that is executed before a collection item is deleted from the data source. */ onItemDeleting: EventEmitter; /** * A function that is executed when a collection item has been held for a specified period. */ onItemHold: EventEmitter; /** * A function that is executed after a collection item is rendered. */ onItemRendered: EventEmitter; /** * A function that is executed after a list item is moved to another position. */ onItemReordered: EventEmitter; /** * A function that is executed when a list item is swiped. */ onItemSwipe: EventEmitter; /** * A function that is executed after a widget option is changed. */ onOptionChanged: EventEmitter; /** * A function that is executed before the next page is loaded. */ onPageLoading: EventEmitter; /** * A function that is executed when the "pull to refresh" gesture is performed. Supported in mobile themes only. */ onPullRefresh: EventEmitter; /** * A function that is executed on each scroll gesture. */ onScroll: EventEmitter; /** * A function that is executed when the "Select All" check box value is changed. Applies only if the selectionMode is "all". */ onSelectAllValueChanged: EventEmitter; /** * A function that is executed when a collection item is selected or selection is canceled. */ onSelectionChanged: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ accessKeyChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ activeStateEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ allowItemDeletingChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ allowItemReorderingChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ bounceEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ collapsibleGroupsChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ dataSourceChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ disabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ displayExprChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ elementAttrChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ focusStateEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ groupedChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ groupTemplateChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hoverStateEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ indicateLoadingChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemDeleteModeChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemHoldTimeoutChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemsChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemTemplateChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ keyExprChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ menuItemsChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ menuModeChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ nextButtonTextChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ noDataTextChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pageLoadingTextChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pageLoadModeChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pulledDownTextChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pullingDownTextChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pullRefreshEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ refreshingTextChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ repaintChangesOnlyChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rtlEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ scrollByContentChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ scrollByThumbChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ scrollingEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchEditorOptionsChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchExprChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchModeChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchTimeoutChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchValueChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectAllModeChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectedItemKeysChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectedItemsChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectionModeChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showScrollbarChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showSelectionControlsChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ tabIndexChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ useNativeScrollingChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ visibleChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ widthChange: EventEmitter; itemsChildren: QueryList; menuItemsChildren: QueryList; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxList; ngOnDestroy(): void; ngOnChanges(changes: SimpleChanges): void; setupChanges(prop: string, changes: SimpleChanges): void; ngDoCheck(): void; _setOption(name: string, value: any): void; } export declare class DxListModule { }