UNPKG

primeng

Version:

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![npm version](https://badge.fury.io/js/primeng.svg)](https://badge.fury.io/js/primeng) [![npm downloads](https://img.shields.io/npm/dm/primeng.sv

741 lines (740 loc) 24.6 kB
import { OnInit, OnDestroy, AfterViewInit, AfterContentInit, EventEmitter, ElementRef, TemplateRef, QueryList, NgZone, ChangeDetectorRef, OnChanges, SimpleChanges, Renderer2 } from '@angular/core'; import { PrimeTemplate, SelectItem, PrimeNGConfig, FilterService } from 'primeng/api'; import { SortMeta } from 'primeng/api'; import { FilterMetadata } from 'primeng/api'; import { BlockableUI } from 'primeng/api'; import { Subscription } from 'rxjs'; import { CdkVirtualScrollViewport } from '@angular/cdk/scrolling'; import { AnimationEvent } from '@angular/animations'; export declare class TableService { private sortSource; private selectionSource; private contextMenuSource; private valueSource; private totalRecordsSource; private columnsSource; private resetSource; sortSource$: import("rxjs").Observable<SortMeta | SortMeta[]>; selectionSource$: import("rxjs").Observable<unknown>; contextMenuSource$: import("rxjs").Observable<any>; valueSource$: import("rxjs").Observable<any>; totalRecordsSource$: import("rxjs").Observable<any>; columnsSource$: import("rxjs").Observable<unknown>; resetSource$: import("rxjs").Observable<unknown>; onSort(sortMeta: SortMeta | SortMeta[]): void; onSelectionChange(): void; onResetChange(): void; onContextMenu(data: any): void; onValueChange(value: any): void; onTotalRecordsChange(value: number): void; onColumnsChange(columns: any[]): void; } export declare class Table implements OnInit, AfterViewInit, AfterContentInit, BlockableUI, OnChanges { el: ElementRef; zone: NgZone; tableService: TableService; cd: ChangeDetectorRef; filterService: FilterService; frozenColumns: any[]; frozenValue: any[]; style: any; styleClass: string; tableStyle: any; tableStyleClass: string; paginator: boolean; pageLinks: number; rowsPerPageOptions: any[]; alwaysShowPaginator: boolean; paginatorPosition: string; paginatorDropdownAppendTo: any; paginatorDropdownScrollHeight: string; currentPageReportTemplate: string; showCurrentPageReport: boolean; showJumpToPageDropdown: boolean; showFirstLastIcon: boolean; showPageLinks: boolean; defaultSortOrder: number; sortMode: string; resetPageOnSort: boolean; selectionMode: string; selectionChange: EventEmitter<any>; contextMenuSelection: any; contextMenuSelectionChange: EventEmitter<any>; contextMenuSelectionMode: string; dataKey: string; metaKeySelection: boolean; rowTrackBy: Function; lazy: boolean; lazyLoadOnInit: boolean; compareSelectionBy: string; csvSeparator: string; exportFilename: string; filters: { [s: string]: FilterMetadata | FilterMetadata[]; }; globalFilterFields: string[]; filterDelay: number; filterLocale: string; expandedRowKeys: { [s: string]: boolean; }; editingRowKeys: { [s: string]: boolean; }; rowExpandMode: string; scrollable: boolean; scrollHeight: string; virtualScroll: boolean; virtualScrollDelay: number; virtualRowHeight: number; frozenWidth: string; responsive: boolean; contextMenu: any; resizableColumns: boolean; columnResizeMode: string; reorderableColumns: boolean; loading: boolean; loadingIcon: string; showLoader: boolean; rowHover: boolean; customSort: boolean; showInitialSortBadge: boolean; autoLayout: boolean; exportFunction: any; stateKey: string; stateStorage: string; editMode: string; minBufferPx: number; maxBufferPx: number; onRowSelect: EventEmitter<any>; onRowUnselect: EventEmitter<any>; onPage: EventEmitter<any>; onSort: EventEmitter<any>; onFilter: EventEmitter<any>; onLazyLoad: EventEmitter<any>; onRowExpand: EventEmitter<any>; onRowCollapse: EventEmitter<any>; onContextMenuSelect: EventEmitter<any>; onColResize: EventEmitter<any>; onColReorder: EventEmitter<any>; onRowReorder: EventEmitter<any>; onEditInit: EventEmitter<any>; onEditComplete: EventEmitter<any>; onEditCancel: EventEmitter<any>; onHeaderCheckboxToggle: EventEmitter<any>; sortFunction: EventEmitter<any>; firstChange: EventEmitter<number>; rowsChange: EventEmitter<number>; onStateSave: EventEmitter<any>; onStateRestore: EventEmitter<any>; containerViewChild: ElementRef; resizeHelperViewChild: ElementRef; reorderIndicatorUpViewChild: ElementRef; reorderIndicatorDownViewChild: ElementRef; tableViewChild: ElementRef; scrollableViewChild: any; scrollableFrozenViewChild: any; templates: QueryList<PrimeTemplate>; _value: any[]; _columns: any[]; _totalRecords: number; _first: number; _rows: number; filteredValue: any[]; headerTemplate: TemplateRef<any>; bodyTemplate: TemplateRef<any>; loadingBodyTemplate: TemplateRef<any>; captionTemplate: TemplateRef<any>; frozenRowsTemplate: TemplateRef<any>; footerTemplate: TemplateRef<any>; summaryTemplate: TemplateRef<any>; colGroupTemplate: TemplateRef<any>; expandedRowTemplate: TemplateRef<any>; frozenExpandedRowTemplate: TemplateRef<any>; frozenHeaderTemplate: TemplateRef<any>; frozenBodyTemplate: TemplateRef<any>; frozenFooterTemplate: TemplateRef<any>; frozenColGroupTemplate: TemplateRef<any>; emptyMessageTemplate: TemplateRef<any>; paginatorLeftTemplate: TemplateRef<any>; paginatorRightTemplate: TemplateRef<any>; paginatorDropdownItemTemplate: TemplateRef<any>; selectionKeys: any; lastResizerHelperX: number; reorderIconWidth: number; reorderIconHeight: number; draggedColumn: any; draggedRowIndex: number; droppedRowIndex: number; rowDragging: boolean; dropPosition: number; editingCell: Element; editingCellData: any; editingCellField: any; editingCellRowIndex: number; editingCellClick: boolean; documentEditListener: any; _multiSortMeta: SortMeta[]; _sortField: string; _sortOrder: number; preventSelectionSetterPropagation: boolean; _selection: any; anchorRowIndex: number; rangeRowIndex: number; filterTimeout: any; initialized: boolean; rowTouched: boolean; restoringSort: boolean; restoringFilter: boolean; stateRestored: boolean; columnOrderStateRestored: boolean; columnWidthsState: string; tableWidthState: string; constructor(el: ElementRef, zone: NgZone, tableService: TableService, cd: ChangeDetectorRef, filterService: FilterService); ngOnInit(): void; ngAfterContentInit(): void; ngAfterViewInit(): void; ngOnChanges(simpleChange: SimpleChanges): void; get value(): any[]; set value(val: any[]); get columns(): any[]; set columns(cols: any[]); get first(): number; set first(val: number); get rows(): number; set rows(val: number); get totalRecords(): number; set totalRecords(val: number); get sortField(): string; set sortField(val: string); get sortOrder(): number; set sortOrder(val: number); get multiSortMeta(): SortMeta[]; set multiSortMeta(val: SortMeta[]); get selection(): any; set selection(val: any); updateSelectionKeys(): void; onPageChange(event: any): void; sort(event: any): void; sortSingle(): void; sortMultiple(): void; multisortField(data1: any, data2: any, multiSortMeta: any, index: any): any; getSortMeta(field: string): SortMeta; isSorted(field: string): boolean; handleRowClick(event: any): void; handleRowTouchEnd(event: any): void; handleRowRightClick(event: any): void; selectRange(event: MouseEvent, rowIndex: number): void; clearSelectionRange(event: MouseEvent): void; isSelected(rowData: any): boolean; findIndexInSelection(rowData: any): number; toggleRowWithRadio(event: any, rowData: any): void; toggleRowWithCheckbox(event: any, rowData: any): void; toggleRowsWithCheckbox(event: Event, check: boolean): void; equals(data1: any, data2: any): boolean; filter(value: any, field: string, matchMode: string): void; filterGlobal(value: any, matchMode: any): void; isFilterBlank(filter: any): boolean; _filter(): void; executeLocalFilter(field: string, rowData: any, filterMeta: FilterMetadata): boolean; hasFilter(): boolean; createLazyLoadMetadata(): any; clear(): void; reset(): void; exportCSV(options?: any): void; resetScrollTop(): void; scrollToVirtualIndex(index: number): void; scrollTo(options: any): void; updateEditingCell(cell: any, data: any, field: any, index: any): void; isEditingCellValid(): boolean; bindDocumentEditListener(): void; unbindDocumentEditListener(): void; initRowEdit(rowData: any): void; saveRowEdit(rowData: any, rowElement: HTMLTableRowElement): void; cancelRowEdit(rowData: any): void; toggleRow(rowData: any, event?: Event): void; isRowExpanded(rowData: any): boolean; isRowEditing(rowData: any): boolean; isSingleSelectionMode(): boolean; isMultipleSelectionMode(): boolean; onColumnResizeBegin(event: any): void; onColumnResize(event: any): void; onColumnResizeEnd(event: any, column: any): void; setScrollableItemsWidthOnExpandResize(column: any, newColumnWidth: any, delta: any): void; findParentScrollableView(column: any): any; resizeColGroup(table: any, resizeColumnIndex: any, newColumnWidth: any, nextColumnWidth: any): void; onColumnDragStart(event: any, columnElement: any): void; onColumnDragEnter(event: any, dropHeader: any): void; onColumnDragLeave(event: any): void; onColumnDrop(event: any, dropColumn: any): void; onRowDragStart(event: any, index: any): void; onRowDragOver(event: any, index: any, rowElement: any): void; onRowDragLeave(event: any, rowElement: any): void; onRowDragEnd(event: any): void; onRowDrop(event: any, rowElement: any): void; isEmpty(): boolean; getBlockableElement(): HTMLElement; getStorage(): Storage; isStateful(): boolean; saveState(): void; clearState(): void; restoreState(): void; saveColumnWidths(state: any): void; restoreColumnWidths(): void; saveColumnOrder(state: any): void; restoreColumnOrder(): void; findColumnByKey(key: any): any; ngOnDestroy(): void; } export declare class TableBody implements OnDestroy { dt: Table; tableService: TableService; cd: ChangeDetectorRef; columns: any[]; template: TemplateRef<any>; frozen: boolean; subscription: Subscription; constructor(dt: Table, tableService: TableService, cd: ChangeDetectorRef); ngOnDestroy(): void; } export declare class ScrollableView implements AfterViewInit, OnDestroy { dt: Table; el: ElementRef; zone: NgZone; columns: any[]; frozen: boolean; scrollHeaderViewChild: ElementRef; scrollHeaderBoxViewChild: ElementRef; scrollBodyViewChild: ElementRef; scrollTableViewChild: ElementRef; scrollFooterViewChild: ElementRef; scrollFooterBoxViewChild: ElementRef; scrollableAlignerViewChild: ElementRef; virtualScrollBody: CdkVirtualScrollViewport; headerScrollListener: any; bodyScrollListener: any; footerScrollListener: any; frozenSiblingBody: HTMLDivElement; preventBodyScrollPropagation: boolean; _scrollHeight: string; virtualScrollTimeout: any; virtualPage: number; get scrollHeight(): string; set scrollHeight(val: string); constructor(dt: Table, el: ElementRef, zone: NgZone); ngAfterViewInit(): void; bindEvents(): void; unbindEvents(): void; onHeaderScroll(): void; onFooterScroll(): void; onBodyScroll(event: any): void; onScrollIndexChange(index: number): void; getPageCount(): number; scrollToVirtualIndex(index: number): void; scrollTo(options: any): void; ngOnDestroy(): void; } export declare class SortableColumn implements OnInit, OnDestroy { dt: Table; field: string; pSortableColumnDisabled: boolean; sorted: boolean; sortOrder: string; subscription: Subscription; constructor(dt: Table); ngOnInit(): void; updateSortState(): void; onClick(event: MouseEvent): void; onEnterKey(event: MouseEvent): void; isEnabled(): boolean; isFilterElement(element: HTMLElement): boolean; ngOnDestroy(): void; } export declare class SortIcon implements OnInit, OnDestroy { dt: Table; cd: ChangeDetectorRef; field: string; subscription: Subscription; sortOrder: number; constructor(dt: Table, cd: ChangeDetectorRef); ngOnInit(): void; onClick(event: any): void; updateSortState(): void; getMultiSortMetaIndex(): number; isMultiSorted(): boolean; ngOnDestroy(): void; } export declare class SelectableRow implements OnInit, OnDestroy { dt: Table; tableService: TableService; data: any; index: number; pSelectableRowDisabled: boolean; selected: boolean; subscription: Subscription; constructor(dt: Table, tableService: TableService); ngOnInit(): void; onClick(event: Event): void; onTouchEnd(event: Event): void; onArrowDownKeyDown(event: KeyboardEvent): void; onArrowUpKeyDown(event: KeyboardEvent): void; onEnterKeyDown(event: KeyboardEvent): void; onPageDownKeyDown(): void; onSpaceKeydown(): void; findNextSelectableRow(row: HTMLTableRowElement): HTMLTableRowElement; findPrevSelectableRow(row: HTMLTableRowElement): HTMLTableRowElement; isEnabled(): boolean; ngOnDestroy(): void; } export declare class SelectableRowDblClick implements OnInit, OnDestroy { dt: Table; tableService: TableService; data: any; index: number; pSelectableRowDisabled: boolean; selected: boolean; subscription: Subscription; constructor(dt: Table, tableService: TableService); ngOnInit(): void; onClick(event: Event): void; isEnabled(): boolean; ngOnDestroy(): void; } export declare class ContextMenuRow { dt: Table; tableService: TableService; private el; data: any; index: number; pContextMenuRowDisabled: boolean; selected: boolean; subscription: Subscription; constructor(dt: Table, tableService: TableService, el: ElementRef); onContextMenu(event: Event): void; isEnabled(): boolean; ngOnDestroy(): void; } export declare class RowToggler { dt: Table; data: any; pRowTogglerDisabled: boolean; constructor(dt: Table); onClick(event: Event): void; isEnabled(): boolean; } export declare class ResizableColumn implements AfterViewInit, OnDestroy { dt: Table; el: ElementRef; zone: NgZone; pResizableColumnDisabled: boolean; resizer: HTMLSpanElement; resizerMouseDownListener: any; documentMouseMoveListener: any; documentMouseUpListener: any; constructor(dt: Table, el: ElementRef, zone: NgZone); ngAfterViewInit(): void; bindDocumentEvents(): void; unbindDocumentEvents(): void; onMouseDown(event: MouseEvent): void; onDocumentMouseMove(event: MouseEvent): void; onDocumentMouseUp(event: MouseEvent): void; isEnabled(): boolean; ngOnDestroy(): void; } export declare class ReorderableColumn implements AfterViewInit, OnDestroy { dt: Table; el: ElementRef; zone: NgZone; pReorderableColumnDisabled: boolean; dragStartListener: any; dragOverListener: any; dragEnterListener: any; dragLeaveListener: any; mouseDownListener: any; constructor(dt: Table, el: ElementRef, zone: NgZone); ngAfterViewInit(): void; bindEvents(): void; unbindEvents(): void; onMouseDown(event: any): void; onDragStart(event: any): void; onDragOver(event: any): void; onDragEnter(event: any): void; onDragLeave(event: any): void; onDrop(event: any): void; isEnabled(): boolean; ngOnDestroy(): void; } export declare class EditableColumn implements AfterViewInit { dt: Table; el: ElementRef; zone: NgZone; data: any; field: any; rowIndex: number; pEditableColumnDisabled: boolean; pFocusCellSelector: string; constructor(dt: Table, el: ElementRef, zone: NgZone); ngAfterViewInit(): void; onClick(event: MouseEvent): void; openCell(): void; closeEditingCell(completed: any, event: any): void; onEnterKeyDown(event: KeyboardEvent): void; onEscapeKeyDown(event: KeyboardEvent): void; onShiftKeyDown(event: KeyboardEvent): void; onArrowDown(event: KeyboardEvent): void; onArrowUp(event: KeyboardEvent): void; onArrowLeft(event: KeyboardEvent): void; onArrowRight(event: KeyboardEvent): void; findCell(element: any): any; moveToPreviousCell(event: KeyboardEvent): void; moveToNextCell(event: KeyboardEvent): void; findPreviousEditableColumn(cell: Element): any; findNextEditableColumn(cell: Element): any; findNextEditableColumnByIndex(cell: Element, index: number): Element; findPrevEditableColumnByIndex(cell: Element, index: number): Element; isEnabled(): boolean; } export declare class EditableRow { el: ElementRef; data: any; pEditableRowDisabled: boolean; constructor(el: ElementRef); isEnabled(): boolean; } export declare class InitEditableRow { dt: Table; editableRow: EditableRow; constructor(dt: Table, editableRow: EditableRow); onClick(event: Event): void; } export declare class SaveEditableRow { dt: Table; editableRow: EditableRow; constructor(dt: Table, editableRow: EditableRow); onClick(event: Event): void; } export declare class CancelEditableRow { dt: Table; editableRow: EditableRow; constructor(dt: Table, editableRow: EditableRow); onClick(event: Event): void; } export declare class CellEditor implements AfterContentInit { dt: Table; editableColumn: EditableColumn; editableRow: EditableRow; templates: QueryList<PrimeTemplate>; inputTemplate: TemplateRef<any>; outputTemplate: TemplateRef<any>; constructor(dt: Table, editableColumn: EditableColumn, editableRow: EditableRow); ngAfterContentInit(): void; get editing(): boolean; } export declare class TableRadioButton { dt: Table; tableService: TableService; cd: ChangeDetectorRef; disabled: boolean; value: any; index: number; inputId: string; name: string; ariaLabel: string; boxViewChild: ElementRef; checked: boolean; subscription: Subscription; constructor(dt: Table, tableService: TableService, cd: ChangeDetectorRef); ngOnInit(): void; onClick(event: Event): void; onFocus(): void; onBlur(): void; ngOnDestroy(): void; } export declare class TableCheckbox { dt: Table; tableService: TableService; cd: ChangeDetectorRef; disabled: boolean; value: any; index: number; inputId: string; name: string; required: boolean; ariaLabel: string; boxViewChild: ElementRef; checked: boolean; subscription: Subscription; constructor(dt: Table, tableService: TableService, cd: ChangeDetectorRef); ngOnInit(): void; onClick(event: Event): void; onFocus(): void; onBlur(): void; ngOnDestroy(): void; } export declare class TableHeaderCheckbox { dt: Table; tableService: TableService; cd: ChangeDetectorRef; boxViewChild: ElementRef; disabled: boolean; inputId: string; name: string; ariaLabel: string; checked: boolean; selectionChangeSubscription: Subscription; valueChangeSubscription: Subscription; constructor(dt: Table, tableService: TableService, cd: ChangeDetectorRef); ngOnInit(): void; onClick(event: Event): void; onFocus(): void; onBlur(): void; isDisabled(): boolean; ngOnDestroy(): void; updateCheckedState(): boolean; isAllFilteredValuesChecked(): boolean; } export declare class ReorderableRowHandle implements AfterViewInit { el: ElementRef; index: number; constructor(el: ElementRef); ngAfterViewInit(): void; } export declare class ReorderableRow implements AfterViewInit { dt: Table; el: ElementRef; zone: NgZone; index: number; pReorderableRowDisabled: boolean; mouseDownListener: any; dragStartListener: any; dragEndListener: any; dragOverListener: any; dragLeaveListener: any; dropListener: any; constructor(dt: Table, el: ElementRef, zone: NgZone); ngAfterViewInit(): void; bindEvents(): void; unbindEvents(): void; onMouseDown(event: any): void; onDragStart(event: any): void; onDragEnd(event: any): void; onDragOver(event: any): void; onDragLeave(event: any): void; isEnabled(): boolean; onDrop(event: any): void; } export declare class ColumnFilterFormElement implements OnInit { dt: Table; field: string; type: string; filterConstraint: FilterMetadata; filterTemplate: TemplateRef<any>; placeholder: string; minFractionDigits: number; maxFractionDigits: number; prefix: string; suffix: string; locale: string; localeMatcher: string; currency: string; currencyDisplay: string; useGrouping: boolean; filterCallback: Function; constructor(dt: Table); ngOnInit(): void; onModelChange(value: any): void; onTextInputEnterKeyDown(event: KeyboardEvent): void; onNumericInputKeyDown(event: KeyboardEvent): void; } export declare class ColumnFilter implements AfterContentInit { el: ElementRef; dt: Table; renderer: Renderer2; config: PrimeNGConfig; field: string; type: string; display: string; showMenu: boolean; matchMode: string; operator: string; showOperator: boolean; showClearButton: boolean; showApplyButton: boolean; showMatchModes: boolean; showAddButton: boolean; hideOnClear: boolean; placeholder: string; matchModeOptions: SelectItem[]; maxConstraints: number; minFractionDigits: number; maxFractionDigits: number; prefix: string; suffix: string; locale: string; localeMatcher: string; currency: string; currencyDisplay: string; useGrouping: boolean; icon: ElementRef; templates: QueryList<any>; constructor(el: ElementRef, dt: Table, renderer: Renderer2, config: PrimeNGConfig); headerTemplate: TemplateRef<any>; filterTemplate: TemplateRef<any>; footerTemplate: TemplateRef<any>; operatorOptions: any[]; overlayVisible: boolean; overlay: HTMLElement; scrollHandler: any; documentClickListener: any; documentResizeListener: any; matchModes: SelectItem[]; translationSubscription: Subscription; resetSubscription: Subscription; ngOnInit(): void; generateMatchModeOptions(): void; generateOperatorOptions(): void; ngAfterContentInit(): void; initFieldFilterConstraint(): void; onMenuMatchModeChange(value: any, filterMeta: FilterMetadata): void; onRowMatchModeChange(matchMode: string): void; onRowMatchModeKeyDown(event: KeyboardEvent): void; onRowClearItemClick(): void; isRowMatchModeSelected(matchMode: string): boolean; addConstraint(): void; removeConstraint(filterMeta: FilterMetadata): void; onOperatorChange(value: any): void; toggleMenu(): void; onToggleButtonKeyDown(event: KeyboardEvent): void; onEscape(): void; findNextItem(item: HTMLLIElement): any; findPrevItem(item: HTMLLIElement): any; onOverlayAnimationStart(event: AnimationEvent): void; getDefaultMatchMode(): string; getDefaultOperator(): string; hasRowFilter(): boolean; get fieldConstraints(): FilterMetadata[]; get showRemoveIcon(): boolean; get showMenuButton(): boolean; get isShowOperator(): boolean; get isShowAddConstraint(): boolean; get applyButtonLabel(): string; get clearButtonLabel(): string; get addRuleButtonLabel(): string; get removeRuleButtonLabel(): string; get noFilterLabel(): string; hasFilter(): boolean; isOutsideClicked(event: any): boolean; bindDocumentClickListener(): void; unbindDocumentClickListener(): void; bindDocumentResizeListener(): void; unbindDocumentResizeListener(): void; bindScrollListener(): void; unbindScrollListener(): void; hide(): void; onOverlayHide(): void; clearFilter(): void; applyFilter(): void; ngOnDestroy(): void; } export declare class TableModule { }