treetable.d.ts 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432
  1. import { AfterContentInit, OnInit, OnDestroy, EventEmitter, TemplateRef, QueryList, ElementRef, NgZone, AfterViewInit, AfterViewChecked } from '@angular/core';
  2. import { TreeNode } from '../common/treenode';
  3. import { Subscription } from 'rxjs';
  4. import { PrimeTemplate } from '../common/shared';
  5. import { SortMeta } from '../common/sortmeta';
  6. import { BlockableUI } from '../common/blockableui';
  7. import { FilterMetadata } from '../common/filtermetadata';
  8. export declare class TreeTableService {
  9. private sortSource;
  10. private selectionSource;
  11. private contextMenuSource;
  12. private uiUpdateSource;
  13. private totalRecordsSource;
  14. sortSource$: import("rxjs").Observable<SortMeta | SortMeta[]>;
  15. selectionSource$: import("rxjs").Observable<{}>;
  16. contextMenuSource$: import("rxjs").Observable<any>;
  17. uiUpdateSource$: import("rxjs").Observable<any>;
  18. totalRecordsSource$: import("rxjs").Observable<any>;
  19. onSort(sortMeta: SortMeta | SortMeta[]): void;
  20. onSelectionChange(): void;
  21. onContextMenu(node: any): void;
  22. onUIUpdate(value: any): void;
  23. onTotalRecordsChange(value: number): void;
  24. }
  25. export declare class TreeTable implements AfterContentInit, OnInit, OnDestroy, BlockableUI {
  26. el: ElementRef;
  27. zone: NgZone;
  28. tableService: TreeTableService;
  29. columns: any[];
  30. style: any;
  31. styleClass: string;
  32. autoLayout: boolean;
  33. lazy: boolean;
  34. paginator: boolean;
  35. rows: number;
  36. first: number;
  37. pageLinks: number;
  38. rowsPerPageOptions: any[];
  39. alwaysShowPaginator: boolean;
  40. paginatorPosition: string;
  41. paginatorDropdownAppendTo: any;
  42. defaultSortOrder: number;
  43. sortMode: string;
  44. resetPageOnSort: boolean;
  45. customSort: boolean;
  46. selectionMode: string;
  47. selectionChange: EventEmitter<any>;
  48. contextMenuSelection: any;
  49. contextMenuSelectionChange: EventEmitter<any>;
  50. contextMenuSelectionMode: string;
  51. dataKey: string;
  52. metaKeySelection: boolean;
  53. compareSelectionBy: string;
  54. rowHover: boolean;
  55. loading: boolean;
  56. loadingIcon: string;
  57. showLoader: boolean;
  58. scrollable: boolean;
  59. scrollHeight: string;
  60. virtualScroll: boolean;
  61. virtualScrollDelay: number;
  62. virtualRowHeight: number;
  63. frozenWidth: string;
  64. frozenColumns: any[];
  65. resizableColumns: boolean;
  66. columnResizeMode: string;
  67. reorderableColumns: boolean;
  68. contextMenu: any;
  69. rowTrackBy: Function;
  70. filters: {
  71. [s: string]: FilterMetadata;
  72. };
  73. globalFilterFields: string[];
  74. filterDelay: number;
  75. filterMode: string;
  76. onFilter: EventEmitter<any>;
  77. onNodeExpand: EventEmitter<any>;
  78. onNodeCollapse: EventEmitter<any>;
  79. onPage: EventEmitter<any>;
  80. onSort: EventEmitter<any>;
  81. onLazyLoad: EventEmitter<any>;
  82. sortFunction: EventEmitter<any>;
  83. onColResize: EventEmitter<any>;
  84. onColReorder: EventEmitter<any>;
  85. onNodeSelect: EventEmitter<any>;
  86. onNodeUnselect: EventEmitter<any>;
  87. onContextMenuSelect: EventEmitter<any>;
  88. onHeaderCheckboxToggle: EventEmitter<any>;
  89. onEditInit: EventEmitter<any>;
  90. onEditComplete: EventEmitter<any>;
  91. onEditCancel: EventEmitter<any>;
  92. containerViewChild: ElementRef;
  93. resizeHelperViewChild: ElementRef;
  94. reorderIndicatorUpViewChild: ElementRef;
  95. reorderIndicatorDownViewChild: ElementRef;
  96. tableViewChild: ElementRef;
  97. templates: QueryList<PrimeTemplate>;
  98. _value: TreeNode[];
  99. serializedValue: any[];
  100. _totalRecords: number;
  101. _multiSortMeta: SortMeta[];
  102. _sortField: string;
  103. _sortOrder: number;
  104. virtualScrollTimer: any;
  105. virtualScrollCallback: Function;
  106. filteredNodes: any[];
  107. filterTimeout: any;
  108. colGroupTemplate: TemplateRef<any>;
  109. captionTemplate: TemplateRef<any>;
  110. headerTemplate: TemplateRef<any>;
  111. bodyTemplate: TemplateRef<any>;
  112. loadingBodyTemplate: TemplateRef<any>;
  113. footerTemplate: TemplateRef<any>;
  114. summaryTemplate: TemplateRef<any>;
  115. emptyMessageTemplate: TemplateRef<any>;
  116. paginatorLeftTemplate: TemplateRef<any>;
  117. paginatorRightTemplate: TemplateRef<any>;
  118. frozenHeaderTemplate: TemplateRef<any>;
  119. frozenBodyTemplate: TemplateRef<any>;
  120. frozenFooterTemplate: TemplateRef<any>;
  121. frozenColGroupTemplate: TemplateRef<any>;
  122. lastResizerHelperX: number;
  123. reorderIconWidth: number;
  124. reorderIconHeight: number;
  125. draggedColumn: any;
  126. dropPosition: number;
  127. preventSelectionSetterPropagation: boolean;
  128. _selection: any;
  129. selectionKeys: any;
  130. rowTouched: boolean;
  131. editingCell: Element;
  132. editingCellClick: boolean;
  133. documentEditListener: any;
  134. initialized: boolean;
  135. toggleRowIndex: number;
  136. ngOnInit(): void;
  137. ngAfterContentInit(): void;
  138. constructor(el: ElementRef, zone: NgZone, tableService: TreeTableService);
  139. value: any[];
  140. updateSerializedValue(): void;
  141. serializeNodes(parent: any, nodes: any, level: any, visible: any): void;
  142. serializePageNodes(): void;
  143. totalRecords: number;
  144. sortField: string;
  145. sortOrder: number;
  146. multiSortMeta: SortMeta[];
  147. selection: any;
  148. updateSelectionKeys(): void;
  149. onPageChange(event: any): void;
  150. sort(event: any): void;
  151. sortSingle(): void;
  152. sortNodes(nodes: any): void;
  153. sortMultiple(): void;
  154. sortMultipleNodes(nodes: any): void;
  155. multisortField(node1: any, node2: any, multiSortMeta: any, index: any): any;
  156. getSortMeta(field: string): SortMeta;
  157. isSorted(field: string): boolean;
  158. createLazyLoadMetadata(): any;
  159. handleVirtualScroll(event: any): void;
  160. isEmpty(): boolean;
  161. getBlockableElement(): HTMLElement;
  162. onColumnResizeBegin(event: any): void;
  163. onColumnResize(event: any): void;
  164. onColumnResizeEnd(event: any, column: any): void;
  165. findParentScrollableView(column: any): any;
  166. resizeColGroup(table: any, resizeColumnIndex: any, newColumnWidth: any, nextColumnWidth: any): void;
  167. onColumnDragStart(event: any, columnElement: any): void;
  168. onColumnDragEnter(event: any, dropHeader: any): void;
  169. onColumnDragLeave(event: any): void;
  170. onColumnDrop(event: any, dropColumn: any): void;
  171. handleRowClick(event: any): void;
  172. handleRowTouchEnd(event: any): void;
  173. handleRowRightClick(event: any): void;
  174. toggleNodeWithCheckbox(event: any): void;
  175. toggleNodesWithCheckbox(event: Event, check: boolean): void;
  176. propagateSelectionUp(node: TreeNode, select: boolean): void;
  177. propagateSelectionDown(node: TreeNode, select: boolean): void;
  178. isSelected(node: any): boolean;
  179. findIndexInSelection(node: any): number;
  180. isSingleSelectionMode(): boolean;
  181. isMultipleSelectionMode(): boolean;
  182. equals(node1: any, node2: any): boolean;
  183. filter(value: any, field: any, matchMode: any): void;
  184. filterGlobal(value: any, matchMode: any): void;
  185. isFilterBlank(filter: any): boolean;
  186. _filter(): void;
  187. findFilteredNodes(node: any, paramsWithoutNode: any): boolean;
  188. isFilterMatched(node: any, { filterField, filterValue, filterConstraint, isStrictMode }: {
  189. filterField: any;
  190. filterValue: any;
  191. filterConstraint: any;
  192. isStrictMode: any;
  193. }): boolean;
  194. isNodeLeaf(node: any): boolean;
  195. hasFilter(): boolean;
  196. reset(): void;
  197. updateEditingCell(cell: any): void;
  198. isEditingCellValid(): boolean;
  199. bindDocumentEditListener(): void;
  200. unbindDocumentEditListener(): void;
  201. ngOnDestroy(): void;
  202. }
  203. export declare class TTBody {
  204. tt: TreeTable;
  205. columns: any[];
  206. template: TemplateRef<any>;
  207. constructor(tt: TreeTable);
  208. }
  209. export declare class TTScrollableView implements AfterViewInit, OnDestroy, AfterViewChecked {
  210. tt: TreeTable;
  211. el: ElementRef;
  212. zone: NgZone;
  213. columns: any[];
  214. frozen: boolean;
  215. scrollHeaderViewChild: ElementRef;
  216. scrollHeaderBoxViewChild: ElementRef;
  217. scrollBodyViewChild: ElementRef;
  218. scrollTableViewChild: ElementRef;
  219. scrollLoadingTableViewChild: ElementRef;
  220. scrollFooterViewChild: ElementRef;
  221. scrollFooterBoxViewChild: ElementRef;
  222. virtualScrollerViewChild: ElementRef;
  223. headerScrollListener: Function;
  224. bodyScrollListener: Function;
  225. footerScrollListener: Function;
  226. frozenSiblingBody: Element;
  227. _scrollHeight: string;
  228. subscription: Subscription;
  229. totalRecordsSubscription: Subscription;
  230. initialized: boolean;
  231. loadingArray: number[];
  232. constructor(tt: TreeTable, el: ElementRef, zone: NgZone);
  233. scrollHeight: string;
  234. ngAfterViewChecked(): void;
  235. ngAfterViewInit(): void;
  236. bindEvents(): void;
  237. unbindEvents(): void;
  238. onHeaderScroll(event: any): void;
  239. onFooterScroll(event: any): void;
  240. onBodyScroll(event: any): void;
  241. setScrollHeight(): void;
  242. setVirtualScrollerHeight(): void;
  243. hasVerticalOverflow(): boolean;
  244. alignScrollBar(): void;
  245. ngOnDestroy(): void;
  246. }
  247. export declare class TTSortableColumn implements OnInit, OnDestroy {
  248. tt: TreeTable;
  249. field: string;
  250. ttSortableColumnDisabled: boolean;
  251. sorted: boolean;
  252. subscription: Subscription;
  253. constructor(tt: TreeTable);
  254. ngOnInit(): void;
  255. updateSortState(): void;
  256. onClick(event: MouseEvent): void;
  257. onEnterKey(event: MouseEvent): void;
  258. isEnabled(): boolean;
  259. ngOnDestroy(): void;
  260. }
  261. export declare class TTSortIcon implements OnInit, OnDestroy {
  262. tt: TreeTable;
  263. field: string;
  264. ariaLabelDesc: string;
  265. ariaLabelAsc: string;
  266. subscription: Subscription;
  267. sortOrder: number;
  268. constructor(tt: TreeTable);
  269. ngOnInit(): void;
  270. onClick(event: any): void;
  271. updateSortState(): void;
  272. ngOnDestroy(): void;
  273. }
  274. export declare class TTResizableColumn implements AfterViewInit, OnDestroy {
  275. tt: TreeTable;
  276. el: ElementRef;
  277. zone: NgZone;
  278. ttResizableColumnDisabled: boolean;
  279. resizer: HTMLSpanElement;
  280. resizerMouseDownListener: any;
  281. documentMouseMoveListener: any;
  282. documentMouseUpListener: any;
  283. constructor(tt: TreeTable, el: ElementRef, zone: NgZone);
  284. ngAfterViewInit(): void;
  285. bindDocumentEvents(): void;
  286. unbindDocumentEvents(): void;
  287. onMouseDown(event: Event): void;
  288. onDocumentMouseMove(event: Event): void;
  289. onDocumentMouseUp(event: Event): void;
  290. isEnabled(): boolean;
  291. ngOnDestroy(): void;
  292. }
  293. export declare class TTReorderableColumn implements AfterViewInit, OnDestroy {
  294. tt: TreeTable;
  295. el: ElementRef;
  296. zone: NgZone;
  297. ttReorderableColumnDisabled: boolean;
  298. dragStartListener: any;
  299. dragOverListener: any;
  300. dragEnterListener: any;
  301. dragLeaveListener: any;
  302. mouseDownListener: any;
  303. constructor(tt: TreeTable, el: ElementRef, zone: NgZone);
  304. ngAfterViewInit(): void;
  305. bindEvents(): void;
  306. unbindEvents(): void;
  307. onMouseDown(event: any): void;
  308. onDragStart(event: any): void;
  309. onDragOver(event: any): void;
  310. onDragEnter(event: any): void;
  311. onDragLeave(event: any): void;
  312. onDrop(event: any): void;
  313. isEnabled(): boolean;
  314. ngOnDestroy(): void;
  315. }
  316. export declare class TTSelectableRow implements OnInit, OnDestroy {
  317. tt: TreeTable;
  318. tableService: TreeTableService;
  319. rowNode: any;
  320. ttSelectableRowDisabled: boolean;
  321. selected: boolean;
  322. subscription: Subscription;
  323. constructor(tt: TreeTable, tableService: TreeTableService);
  324. ngOnInit(): void;
  325. onClick(event: Event): void;
  326. onEnterKey(event: Event): void;
  327. onTouchEnd(event: Event): void;
  328. isEnabled(): boolean;
  329. ngOnDestroy(): void;
  330. }
  331. export declare class TTSelectableRowDblClick implements OnInit, OnDestroy {
  332. tt: TreeTable;
  333. tableService: TreeTableService;
  334. rowNode: any;
  335. ttSelectableRowDisabled: boolean;
  336. selected: boolean;
  337. subscription: Subscription;
  338. constructor(tt: TreeTable, tableService: TreeTableService);
  339. ngOnInit(): void;
  340. onClick(event: Event): void;
  341. isEnabled(): boolean;
  342. ngOnDestroy(): void;
  343. }
  344. export declare class TTContextMenuRow {
  345. tt: TreeTable;
  346. tableService: TreeTableService;
  347. rowNode: any;
  348. ttContextMenuRowDisabled: boolean;
  349. selected: boolean;
  350. subscription: Subscription;
  351. constructor(tt: TreeTable, tableService: TreeTableService);
  352. onContextMenu(event: Event): void;
  353. isEnabled(): boolean;
  354. ngOnDestroy(): void;
  355. }
  356. export declare class TTCheckbox {
  357. tt: TreeTable;
  358. tableService: TreeTableService;
  359. disabled: boolean;
  360. rowNode: any;
  361. boxViewChild: ElementRef;
  362. checked: boolean;
  363. subscription: Subscription;
  364. constructor(tt: TreeTable, tableService: TreeTableService);
  365. ngOnInit(): void;
  366. onClick(event: Event): void;
  367. onFocus(): void;
  368. onBlur(): void;
  369. ngOnDestroy(): void;
  370. }
  371. export declare class TTHeaderCheckbox {
  372. tt: TreeTable;
  373. tableService: TreeTableService;
  374. boxViewChild: ElementRef;
  375. checked: boolean;
  376. disabled: boolean;
  377. selectionChangeSubscription: Subscription;
  378. valueChangeSubscription: Subscription;
  379. constructor(tt: TreeTable, tableService: TreeTableService);
  380. ngOnInit(): void;
  381. onClick(event: Event, checked: any): void;
  382. onFocus(): void;
  383. onBlur(): void;
  384. ngOnDestroy(): void;
  385. updateCheckedState(): boolean;
  386. }
  387. export declare class TTEditableColumn implements AfterViewInit {
  388. tt: TreeTable;
  389. el: ElementRef;
  390. zone: NgZone;
  391. data: any;
  392. field: any;
  393. ttEditableColumnDisabled: boolean;
  394. constructor(tt: TreeTable, el: ElementRef, zone: NgZone);
  395. ngAfterViewInit(): void;
  396. onClick(event: MouseEvent): void;
  397. openCell(): void;
  398. closeEditingCell(): void;
  399. onKeyDown(event: KeyboardEvent): void;
  400. findCell(element: any): any;
  401. moveToPreviousCell(event: KeyboardEvent): void;
  402. moveToNextCell(event: KeyboardEvent): void;
  403. findPreviousEditableColumn(cell: Element): any;
  404. findNextEditableColumn(cell: Element): any;
  405. isEnabled(): boolean;
  406. }
  407. export declare class TreeTableCellEditor implements AfterContentInit {
  408. tt: TreeTable;
  409. editableColumn: TTEditableColumn;
  410. templates: QueryList<PrimeTemplate>;
  411. inputTemplate: TemplateRef<any>;
  412. outputTemplate: TemplateRef<any>;
  413. constructor(tt: TreeTable, editableColumn: TTEditableColumn);
  414. ngAfterContentInit(): void;
  415. }
  416. export declare class TTRow {
  417. tt: TreeTable;
  418. el: ElementRef;
  419. zone: NgZone;
  420. rowNode: any;
  421. constructor(tt: TreeTable, el: ElementRef, zone: NgZone);
  422. onKeyDown(event: KeyboardEvent): void;
  423. restoreFocus(): void;
  424. }
  425. export declare class TreeTableToggler {
  426. tt: TreeTable;
  427. rowNode: any;
  428. constructor(tt: TreeTable);
  429. onClick(event: Event): void;
  430. }
  431. export declare class TreeTableModule {
  432. }