table.d.ts 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565
  1. import { OnInit, OnDestroy, AfterViewInit, AfterViewChecked, AfterContentInit, EventEmitter, ElementRef, TemplateRef, QueryList, NgZone, ChangeDetectorRef } from '@angular/core';
  2. import { Column, PrimeTemplate } from '../common/shared';
  3. import { SortMeta } from '../common/sortmeta';
  4. import { FilterMetadata } from '../common/filtermetadata';
  5. import { BlockableUI } from '../common/blockableui';
  6. import { Subscription } from 'rxjs';
  7. export declare class TableService {
  8. private sortSource;
  9. private selectionSource;
  10. private contextMenuSource;
  11. private valueSource;
  12. private totalRecordsSource;
  13. private columnsSource;
  14. sortSource$: import("rxjs").Observable<SortMeta | SortMeta[]>;
  15. selectionSource$: import("rxjs").Observable<{}>;
  16. contextMenuSource$: import("rxjs").Observable<any>;
  17. valueSource$: import("rxjs").Observable<any>;
  18. totalRecordsSource$: import("rxjs").Observable<any>;
  19. columnsSource$: import("rxjs").Observable<{}>;
  20. onSort(sortMeta: SortMeta | SortMeta[]): void;
  21. onSelectionChange(): void;
  22. onContextMenu(data: any): void;
  23. onValueChange(value: any): void;
  24. onTotalRecordsChange(value: number): void;
  25. onColumnsChange(columns: any[]): void;
  26. }
  27. export declare class Table implements OnInit, AfterViewInit, AfterContentInit, BlockableUI {
  28. el: ElementRef;
  29. zone: NgZone;
  30. tableService: TableService;
  31. cd: ChangeDetectorRef;
  32. frozenColumns: any[];
  33. frozenValue: any[];
  34. style: any;
  35. styleClass: string;
  36. tableStyle: any;
  37. tableStyleClass: string;
  38. paginator: boolean;
  39. pageLinks: number;
  40. rowsPerPageOptions: any[];
  41. alwaysShowPaginator: boolean;
  42. paginatorPosition: string;
  43. paginatorDropdownAppendTo: any;
  44. paginatorDropdownScrollHeight: string;
  45. currentPageReportTemplate: string;
  46. showCurrentPageReport: boolean;
  47. defaultSortOrder: number;
  48. sortMode: string;
  49. resetPageOnSort: boolean;
  50. selectionMode: string;
  51. selectionChange: EventEmitter<any>;
  52. contextMenuSelection: any;
  53. contextMenuSelectionChange: EventEmitter<any>;
  54. contextMenuSelectionMode: string;
  55. dataKey: string;
  56. metaKeySelection: boolean;
  57. rowTrackBy: Function;
  58. lazy: boolean;
  59. lazyLoadOnInit: boolean;
  60. compareSelectionBy: string;
  61. csvSeparator: string;
  62. exportFilename: string;
  63. filters: {
  64. [s: string]: FilterMetadata;
  65. };
  66. globalFilterFields: string[];
  67. filterDelay: number;
  68. expandedRowKeys: {
  69. [s: string]: boolean;
  70. };
  71. editingRowKeys: {
  72. [s: string]: boolean;
  73. };
  74. rowExpandMode: string;
  75. scrollable: boolean;
  76. scrollHeight: string;
  77. virtualScroll: boolean;
  78. virtualScrollDelay: number;
  79. virtualRowHeight: number;
  80. frozenWidth: string;
  81. responsive: boolean;
  82. contextMenu: any;
  83. resizableColumns: boolean;
  84. columnResizeMode: string;
  85. reorderableColumns: boolean;
  86. loading: boolean;
  87. loadingIcon: string;
  88. showLoader: boolean;
  89. rowHover: boolean;
  90. customSort: boolean;
  91. autoLayout: boolean;
  92. exportFunction: any;
  93. stateKey: string;
  94. stateStorage: string;
  95. editMode: string;
  96. onRowSelect: EventEmitter<any>;
  97. onRowUnselect: EventEmitter<any>;
  98. onPage: EventEmitter<any>;
  99. onSort: EventEmitter<any>;
  100. onFilter: EventEmitter<any>;
  101. onLazyLoad: EventEmitter<any>;
  102. onRowExpand: EventEmitter<any>;
  103. onRowCollapse: EventEmitter<any>;
  104. onContextMenuSelect: EventEmitter<any>;
  105. onColResize: EventEmitter<any>;
  106. onColReorder: EventEmitter<any>;
  107. onRowReorder: EventEmitter<any>;
  108. onEditInit: EventEmitter<any>;
  109. onEditComplete: EventEmitter<any>;
  110. onEditCancel: EventEmitter<any>;
  111. onHeaderCheckboxToggle: EventEmitter<any>;
  112. sortFunction: EventEmitter<any>;
  113. firstChange: EventEmitter<number>;
  114. rowsChange: EventEmitter<number>;
  115. onStateSave: EventEmitter<any>;
  116. onStateRestore: EventEmitter<any>;
  117. containerViewChild: ElementRef;
  118. resizeHelperViewChild: ElementRef;
  119. reorderIndicatorUpViewChild: ElementRef;
  120. reorderIndicatorDownViewChild: ElementRef;
  121. tableViewChild: ElementRef;
  122. templates: QueryList<PrimeTemplate>;
  123. _value: any[];
  124. _columns: any[];
  125. _totalRecords: number;
  126. _first: number;
  127. _rows: number;
  128. filteredValue: any[];
  129. headerTemplate: TemplateRef<any>;
  130. bodyTemplate: TemplateRef<any>;
  131. loadingBodyTemplate: TemplateRef<any>;
  132. captionTemplate: TemplateRef<any>;
  133. frozenRowsTemplate: TemplateRef<any>;
  134. footerTemplate: TemplateRef<any>;
  135. summaryTemplate: TemplateRef<any>;
  136. colGroupTemplate: TemplateRef<any>;
  137. expandedRowTemplate: TemplateRef<any>;
  138. frozenHeaderTemplate: TemplateRef<any>;
  139. frozenBodyTemplate: TemplateRef<any>;
  140. frozenFooterTemplate: TemplateRef<any>;
  141. frozenColGroupTemplate: TemplateRef<any>;
  142. emptyMessageTemplate: TemplateRef<any>;
  143. paginatorLeftTemplate: TemplateRef<any>;
  144. paginatorRightTemplate: TemplateRef<any>;
  145. selectionKeys: any;
  146. lastResizerHelperX: number;
  147. reorderIconWidth: number;
  148. reorderIconHeight: number;
  149. draggedColumn: any;
  150. draggedRowIndex: number;
  151. droppedRowIndex: number;
  152. rowDragging: boolean;
  153. dropPosition: number;
  154. editingCell: Element;
  155. editingCellData: any;
  156. editingCellField: any;
  157. editingCellClick: boolean;
  158. documentEditListener: any;
  159. _multiSortMeta: SortMeta[];
  160. _sortField: string;
  161. _sortOrder: number;
  162. virtualScrollTimer: any;
  163. virtualScrollCallback: Function;
  164. preventSelectionSetterPropagation: boolean;
  165. _selection: any;
  166. anchorRowIndex: number;
  167. rangeRowIndex: number;
  168. filterTimeout: any;
  169. initialized: boolean;
  170. rowTouched: boolean;
  171. restoringSort: boolean;
  172. restoringFilter: boolean;
  173. stateRestored: boolean;
  174. columnOrderStateRestored: boolean;
  175. columnWidthsState: string;
  176. tableWidthState: string;
  177. constructor(el: ElementRef, zone: NgZone, tableService: TableService, cd: ChangeDetectorRef);
  178. ngOnInit(): void;
  179. ngAfterContentInit(): void;
  180. ngAfterViewInit(): void;
  181. value: any[];
  182. columns: any[];
  183. first: number;
  184. rows: number;
  185. totalRecords: number;
  186. sortField: string;
  187. sortOrder: number;
  188. multiSortMeta: SortMeta[];
  189. selection: any;
  190. updateSelectionKeys(): void;
  191. onPageChange(event: any): void;
  192. sort(event: any): void;
  193. sortSingle(): void;
  194. sortMultiple(): void;
  195. multisortField(data1: any, data2: any, multiSortMeta: any, index: any): any;
  196. getSortMeta(field: string): SortMeta;
  197. isSorted(field: string): boolean;
  198. handleRowClick(event: any): void;
  199. handleRowTouchEnd(event: any): void;
  200. handleRowRightClick(event: any): void;
  201. selectRange(event: MouseEvent, rowIndex: number): void;
  202. clearSelectionRange(event: MouseEvent): void;
  203. isSelected(rowData: any): boolean;
  204. findIndexInSelection(rowData: any): number;
  205. toggleRowWithRadio(event: any, rowData: any): void;
  206. toggleRowWithCheckbox(event: any, rowData: any): void;
  207. toggleRowsWithCheckbox(event: Event, check: boolean): void;
  208. equals(data1: any, data2: any): boolean;
  209. filter(value: any, field: any, matchMode: any): void;
  210. filterGlobal(value: any, matchMode: any): void;
  211. isFilterBlank(filter: any): boolean;
  212. _filter(): void;
  213. hasFilter(): boolean;
  214. createLazyLoadMetadata(): any;
  215. reset(): void;
  216. exportCSV(options?: any): void;
  217. updateEditingCell(cell: any, data: any, field: any): void;
  218. isEditingCellValid(): boolean;
  219. bindDocumentEditListener(): void;
  220. unbindDocumentEditListener(): void;
  221. initRowEdit(rowData: any): void;
  222. saveRowEdit(rowData: any, rowElement: HTMLTableRowElement): void;
  223. cancelRowEdit(rowData: any): void;
  224. toggleRow(rowData: any, event?: Event): void;
  225. isRowExpanded(rowData: any): boolean;
  226. isRowEditing(rowData: any): boolean;
  227. isSingleSelectionMode(): boolean;
  228. isMultipleSelectionMode(): boolean;
  229. onColumnResizeBegin(event: any): void;
  230. onColumnResize(event: any): void;
  231. onColumnResizeEnd(event: any, column: any): void;
  232. setScrollableItemsWidthOnExpandResize(column: any, newColumnWidth: any, delta: any): void;
  233. findParentScrollableView(column: any): any;
  234. resizeColGroup(table: any, resizeColumnIndex: any, newColumnWidth: any, nextColumnWidth: any): void;
  235. onColumnDragStart(event: any, columnElement: any): void;
  236. onColumnDragEnter(event: any, dropHeader: any): void;
  237. onColumnDragLeave(event: any): void;
  238. onColumnDrop(event: any, dropColumn: any): void;
  239. onRowDragStart(event: any, index: any): void;
  240. onRowDragOver(event: any, index: any, rowElement: any): void;
  241. onRowDragLeave(event: any, rowElement: any): void;
  242. onRowDragEnd(event: any): void;
  243. onRowDrop(event: any, rowElement: any): void;
  244. handleVirtualScroll(event: any): void;
  245. isEmpty(): boolean;
  246. getBlockableElement(): HTMLElement;
  247. getStorage(): Storage;
  248. isStateful(): boolean;
  249. saveState(): void;
  250. clearState(): void;
  251. restoreState(): void;
  252. saveColumnWidths(state: any): void;
  253. restoreColumnWidths(): void;
  254. saveColumnOrder(state: any): void;
  255. restoreColumnOrder(): void;
  256. findColumnByKey(key: any): any;
  257. ngOnDestroy(): void;
  258. }
  259. export declare class TableBody {
  260. dt: Table;
  261. columns: Column[];
  262. template: TemplateRef<any>;
  263. frozen: boolean;
  264. constructor(dt: Table);
  265. }
  266. export declare class ScrollableView implements AfterViewInit, OnDestroy, AfterViewChecked {
  267. dt: Table;
  268. el: ElementRef;
  269. zone: NgZone;
  270. columns: Column[];
  271. frozen: boolean;
  272. scrollHeaderViewChild: ElementRef;
  273. scrollHeaderBoxViewChild: ElementRef;
  274. scrollBodyViewChild: ElementRef;
  275. scrollTableViewChild: ElementRef;
  276. scrollLoadingTableViewChild: ElementRef;
  277. scrollFooterViewChild: ElementRef;
  278. scrollFooterBoxViewChild: ElementRef;
  279. virtualScrollerViewChild: ElementRef;
  280. headerScrollListener: Function;
  281. bodyScrollListener: Function;
  282. footerScrollListener: Function;
  283. frozenSiblingBody: Element;
  284. scrollableSiblingBody: Element;
  285. _scrollHeight: string;
  286. subscription: Subscription;
  287. totalRecordsSubscription: Subscription;
  288. columnsSubscription: Subscription;
  289. initialized: boolean;
  290. preventBodyScrollPropagation: boolean;
  291. loadingArray: number[];
  292. constructor(dt: Table, el: ElementRef, zone: NgZone);
  293. scrollHeight: string;
  294. ngAfterViewChecked(): void;
  295. ngAfterViewInit(): void;
  296. bindEvents(): void;
  297. unbindEvents(): void;
  298. onHeaderScroll(event: any): void;
  299. onFooterScroll(event: any): void;
  300. onBodyScroll(event: any): void;
  301. setScrollHeight(): void;
  302. setVirtualScrollerHeight(): void;
  303. hasVerticalOverflow(): boolean;
  304. alignScrollBar(): void;
  305. ngOnDestroy(): void;
  306. }
  307. export declare class SortableColumn implements OnInit, OnDestroy {
  308. dt: Table;
  309. field: string;
  310. pSortableColumnDisabled: boolean;
  311. sorted: boolean;
  312. subscription: Subscription;
  313. constructor(dt: Table);
  314. ngOnInit(): void;
  315. updateSortState(): void;
  316. onClick(event: MouseEvent): void;
  317. onEnterKey(event: MouseEvent): void;
  318. isEnabled(): boolean;
  319. ngOnDestroy(): void;
  320. }
  321. export declare class SortIcon implements OnInit, OnDestroy {
  322. dt: Table;
  323. field: string;
  324. subscription: Subscription;
  325. sortOrder: number;
  326. constructor(dt: Table);
  327. ngOnInit(): void;
  328. onClick(event: any): void;
  329. updateSortState(): void;
  330. ngOnDestroy(): void;
  331. }
  332. export declare class SelectableRow implements OnInit, OnDestroy {
  333. dt: Table;
  334. tableService: TableService;
  335. data: any;
  336. index: number;
  337. pSelectableRowDisabled: boolean;
  338. selected: boolean;
  339. subscription: Subscription;
  340. constructor(dt: Table, tableService: TableService);
  341. ngOnInit(): void;
  342. onClick(event: Event): void;
  343. onTouchEnd(event: Event): void;
  344. onKeyDown(event: KeyboardEvent): void;
  345. findNextSelectableRow(row: HTMLTableRowElement): HTMLTableRowElement;
  346. findPrevSelectableRow(row: HTMLTableRowElement): HTMLTableRowElement;
  347. isEnabled(): boolean;
  348. ngOnDestroy(): void;
  349. }
  350. export declare class SelectableRowDblClick implements OnInit, OnDestroy {
  351. dt: Table;
  352. tableService: TableService;
  353. data: any;
  354. index: number;
  355. pSelectableRowDisabled: boolean;
  356. selected: boolean;
  357. subscription: Subscription;
  358. constructor(dt: Table, tableService: TableService);
  359. ngOnInit(): void;
  360. onClick(event: Event): void;
  361. isEnabled(): boolean;
  362. ngOnDestroy(): void;
  363. }
  364. export declare class ContextMenuRow {
  365. dt: Table;
  366. tableService: TableService;
  367. data: any;
  368. index: number;
  369. pContextMenuRowDisabled: boolean;
  370. selected: boolean;
  371. subscription: Subscription;
  372. constructor(dt: Table, tableService: TableService);
  373. onContextMenu(event: Event): void;
  374. isEnabled(): boolean;
  375. ngOnDestroy(): void;
  376. }
  377. export declare class RowToggler {
  378. dt: Table;
  379. data: any;
  380. pRowTogglerDisabled: boolean;
  381. constructor(dt: Table);
  382. onClick(event: Event): void;
  383. isEnabled(): boolean;
  384. }
  385. export declare class ResizableColumn implements AfterViewInit, OnDestroy {
  386. dt: Table;
  387. el: ElementRef;
  388. zone: NgZone;
  389. pResizableColumnDisabled: boolean;
  390. resizer: HTMLSpanElement;
  391. resizerMouseDownListener: any;
  392. documentMouseMoveListener: any;
  393. documentMouseUpListener: any;
  394. constructor(dt: Table, el: ElementRef, zone: NgZone);
  395. ngAfterViewInit(): void;
  396. bindDocumentEvents(): void;
  397. unbindDocumentEvents(): void;
  398. onMouseDown(event: MouseEvent): void;
  399. onDocumentMouseMove(event: MouseEvent): void;
  400. onDocumentMouseUp(event: MouseEvent): void;
  401. isEnabled(): boolean;
  402. ngOnDestroy(): void;
  403. }
  404. export declare class ReorderableColumn implements AfterViewInit, OnDestroy {
  405. dt: Table;
  406. el: ElementRef;
  407. zone: NgZone;
  408. pReorderableColumnDisabled: boolean;
  409. dragStartListener: any;
  410. dragOverListener: any;
  411. dragEnterListener: any;
  412. dragLeaveListener: any;
  413. mouseDownListener: any;
  414. constructor(dt: Table, el: ElementRef, zone: NgZone);
  415. ngAfterViewInit(): void;
  416. bindEvents(): void;
  417. unbindEvents(): void;
  418. onMouseDown(event: any): void;
  419. onDragStart(event: any): void;
  420. onDragOver(event: any): void;
  421. onDragEnter(event: any): void;
  422. onDragLeave(event: any): void;
  423. onDrop(event: any): void;
  424. isEnabled(): boolean;
  425. ngOnDestroy(): void;
  426. }
  427. export declare class EditableColumn implements AfterViewInit {
  428. dt: Table;
  429. el: ElementRef;
  430. zone: NgZone;
  431. data: any;
  432. field: any;
  433. pEditableColumnDisabled: boolean;
  434. pFocusCellSelector: string;
  435. constructor(dt: Table, el: ElementRef, zone: NgZone);
  436. ngAfterViewInit(): void;
  437. onClick(event: MouseEvent): void;
  438. openCell(): void;
  439. closeEditingCell(): void;
  440. onKeyDown(event: KeyboardEvent): void;
  441. findCell(element: any): any;
  442. moveToPreviousCell(event: KeyboardEvent): void;
  443. moveToNextCell(event: KeyboardEvent): void;
  444. findPreviousEditableColumn(cell: Element): any;
  445. findNextEditableColumn(cell: Element): any;
  446. isEnabled(): boolean;
  447. }
  448. export declare class EditableRow {
  449. el: ElementRef;
  450. data: any;
  451. pEditableRowDisabled: boolean;
  452. constructor(el: ElementRef);
  453. isEnabled(): boolean;
  454. }
  455. export declare class InitEditableRow {
  456. dt: Table;
  457. editableRow: EditableRow;
  458. constructor(dt: Table, editableRow: EditableRow);
  459. onClick(event: Event): void;
  460. }
  461. export declare class SaveEditableRow {
  462. dt: Table;
  463. editableRow: EditableRow;
  464. constructor(dt: Table, editableRow: EditableRow);
  465. onClick(event: Event): void;
  466. }
  467. export declare class CancelEditableRow {
  468. dt: Table;
  469. editableRow: EditableRow;
  470. constructor(dt: Table, editableRow: EditableRow);
  471. onClick(event: Event): void;
  472. }
  473. export declare class CellEditor implements AfterContentInit {
  474. dt: Table;
  475. editableColumn: EditableColumn;
  476. editableRow: EditableRow;
  477. templates: QueryList<PrimeTemplate>;
  478. inputTemplate: TemplateRef<any>;
  479. outputTemplate: TemplateRef<any>;
  480. constructor(dt: Table, editableColumn: EditableColumn, editableRow: EditableRow);
  481. ngAfterContentInit(): void;
  482. readonly editing: boolean;
  483. }
  484. export declare class TableRadioButton {
  485. dt: Table;
  486. tableService: TableService;
  487. disabled: boolean;
  488. value: any;
  489. index: number;
  490. boxViewChild: ElementRef;
  491. checked: boolean;
  492. subscription: Subscription;
  493. constructor(dt: Table, tableService: TableService);
  494. ngOnInit(): void;
  495. onClick(event: Event): void;
  496. onFocus(): void;
  497. onBlur(): void;
  498. ngOnDestroy(): void;
  499. }
  500. export declare class TableCheckbox {
  501. dt: Table;
  502. tableService: TableService;
  503. disabled: boolean;
  504. value: any;
  505. index: number;
  506. boxViewChild: ElementRef;
  507. checked: boolean;
  508. subscription: Subscription;
  509. constructor(dt: Table, tableService: TableService);
  510. ngOnInit(): void;
  511. onClick(event: Event): void;
  512. onFocus(): void;
  513. onBlur(): void;
  514. ngOnDestroy(): void;
  515. }
  516. export declare class TableHeaderCheckbox {
  517. dt: Table;
  518. tableService: TableService;
  519. boxViewChild: ElementRef;
  520. disabled: boolean;
  521. checked: boolean;
  522. selectionChangeSubscription: Subscription;
  523. valueChangeSubscription: Subscription;
  524. constructor(dt: Table, tableService: TableService);
  525. ngOnInit(): void;
  526. onClick(event: Event): void;
  527. onFocus(): void;
  528. onBlur(): void;
  529. isDisabled(): boolean;
  530. ngOnDestroy(): void;
  531. updateCheckedState(): boolean;
  532. isAllFilteredValuesChecked(): boolean;
  533. }
  534. export declare class ReorderableRowHandle implements AfterViewInit {
  535. el: ElementRef;
  536. index: number;
  537. constructor(el: ElementRef);
  538. ngAfterViewInit(): void;
  539. }
  540. export declare class ReorderableRow implements AfterViewInit {
  541. dt: Table;
  542. el: ElementRef;
  543. zone: NgZone;
  544. index: number;
  545. pReorderableRowDisabled: boolean;
  546. mouseDownListener: any;
  547. dragStartListener: any;
  548. dragEndListener: any;
  549. dragOverListener: any;
  550. dragLeaveListener: any;
  551. dropListener: any;
  552. constructor(dt: Table, el: ElementRef, zone: NgZone);
  553. ngAfterViewInit(): void;
  554. bindEvents(): void;
  555. unbindEvents(): void;
  556. onMouseDown(event: any): void;
  557. onDragStart(event: any): void;
  558. onDragEnd(event: any): void;
  559. onDragOver(event: any): void;
  560. onDragLeave(event: any): void;
  561. isEnabled(): boolean;
  562. onDrop(event: any): void;
  563. }
  564. export declare class TableModule {
  565. }