devextreme-angular

/*! * devextreme-angular * Version: 20.2.5 * Build date: Fri Jan 15 2021 * * Copyright (c) 2012 - 2021 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 { dxSortableOptions } from 'devextreme/ui/sortable'; import { dxTextBoxOptions } from 'devextreme/ui/text_box'; import DxList from 'devextreme/ui/list'; import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core'; import { DxiItemComponent } from 'devextreme-angular/ui/nested'; import { DxiMenuItemComponent } from 'devextreme-angular/ui/nested'; /** * The List is a UI component 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 UI component. */ accessKey: string; /** * Specifies whether or not the UI component changes its state when interacting with a user. */ activeStateEnabled: boolean; /** * Specifies whether or not an end user can delete list items. */ allowItemDeleting: 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 UI component to data. */ dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.dxListItem | any>; /** * Specifies whether the UI component 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 global attributes to be attached to the UI component's container element. */ elementAttr: any; /** * Specifies whether the UI component 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 UI component's height. */ height: number | Function | string; /** * Specifies text for a hint that appears when a user pauses on the UI component. */ hint: string; /** * Specifies whether the UI component 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 UI component is loading data. */ indicateLoading: boolean; /** * Specifies the way a user can delete items from the list. */ itemDeleteMode: string; /** * Configures item reordering using drag and drop gestures. */ itemDragging: dxSortableOptions; /** * The time period in milliseconds before the onItemHold event is raised. */ itemHoldTimeout: number; /** * An array of items displayed by the UI component. */ items: Array<string | any | { badge?: string; disabled?: boolean; html?: string; icon?: string; key?: string; showChevron?: boolean; template?: any; text?: string; visible?: boolean; }>; /** * Specifies a custom template for items. */ itemTemplate: any; /** * Specifies the key property that provides key values to access data items. Each key value must be unique. */ keyExpr: Function | string; /** * Specifies the array of items for a context menu called for a list item. */ menuItems: Array<any | { action?: Function; text?: string; }>; /** * 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 UI component 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 UI component 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 UI component 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 UI component 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: 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 | string | Array<Function | string>; /** * Specifies a comparison operation used to search UI component 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<any>; /** * An array of currently selected item objects. */ selectedItems: Array<any>; /** * Specifies item selection mode. */ selectionMode: string; /** * Specifies when the UI component 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 UI component uses native scrolling. */ useNativeScrolling: boolean; /** * Specifies whether the UI component is visible. */ visible: boolean; /** * Specifies the UI component's width. */ width: number | Function | string; /** * A function that is executed when the UI component's content is ready and each time the content is changed. */ onContentReady: EventEmitter<any>; /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<any>; /** * A function that is executed when a group element is rendered. */ onGroupRendered: EventEmitter<any>; /** * A function used in JavaScript frameworks to save the UI component instance. */ onInitialized: EventEmitter<any>; /** * A function that is executed when a collection item is clicked or tapped. */ onItemClick: EventEmitter<any>; /** * A function that is executed when a collection item is right-clicked or pressed. */ onItemContextMenu: EventEmitter<any>; /** * A function that is executed after a list item is deleted from the data source. */ onItemDeleted: EventEmitter<any>; /** * A function that is executed before a collection item is deleted from the data source. */ onItemDeleting: EventEmitter<any>; /** * A function that is executed when a collection item has been held for a specified period. */ onItemHold: EventEmitter<any>; /** * A function that is executed after a collection item is rendered. */ onItemRendered: EventEmitter<any>; /** * A function that is executed after a list item is moved to another position. */ onItemReordered: EventEmitter<any>; /** * A function that is executed when a list item is swiped. */ onItemSwipe: EventEmitter<any>; /** * A function that is executed after a UI component property is changed. */ onOptionChanged: EventEmitter<any>; /** * A function that is executed before the next page is loaded. */ onPageLoading: EventEmitter<any>; /** * A function that is executed when the 'pull to refresh' gesture is performed. Supported in mobile themes only. */ onPullRefresh: EventEmitter<any>; /** * A function that is executed on each scroll gesture. */ onScroll: EventEmitter<any>; /** * A function that is executed when the 'Select All' check box value is changed. Applies only if the selectionMode is 'all'. */ onSelectAllValueChanged: EventEmitter<any>; /** * A function that is executed when a collection item is selected or selection is canceled. */ onSelectionChanged: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ accessKeyChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ activeStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ allowItemDeletingChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ bounceEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ collapsibleGroupsChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<string | DevExpress.ui.dxListItem | any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ disabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ displayExprChange: EventEmitter<Function | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ elementAttrChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ focusStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ groupedChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ groupTemplateChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter<number | Function | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hoverStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ indicateLoadingChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemDeleteModeChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemDraggingChange: EventEmitter<dxSortableOptions>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemHoldTimeoutChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemsChange: EventEmitter<Array<string | any | { badge?: string; disabled?: boolean; html?: string; icon?: string; key?: string; showChevron?: boolean; template?: any; text?: string; visible?: boolean; }>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemTemplateChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ keyExprChange: EventEmitter<Function | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ menuItemsChange: EventEmitter<Array<any | { action?: Function; text?: string; }>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ menuModeChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ nextButtonTextChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ noDataTextChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pageLoadingTextChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pageLoadModeChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pulledDownTextChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pullingDownTextChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ pullRefreshEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ refreshingTextChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ repaintChangesOnlyChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rtlEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ scrollByContentChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ scrollByThumbChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ scrollingEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchEditorOptionsChange: EventEmitter<dxTextBoxOptions>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchExprChange: EventEmitter<Function | string | Array<Function | string>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchModeChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchTimeoutChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ searchValueChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectAllModeChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectedItemKeysChange: EventEmitter<Array<any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectedItemsChange: EventEmitter<Array<any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ selectionModeChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showScrollbarChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showSelectionControlsChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ tabIndexChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ useNativeScrollingChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ visibleChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ widthChange: EventEmitter<number | Function | string>; itemsChildren: QueryList<DxiItemComponent>; menuItemsChildren: QueryList<DxiMenuItemComponent>; 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 { }