1 | import { VXETableComponent, RowInfo, RecordInfo } from './component'
|
2 | import { ColumnOptions, ColumnInfo } from './column'
|
3 | import { ColumnCellRenderParams, TableEmptyRender } from './v-x-e-table'
|
4 | import { TableExportConfig, TableImportConfig, TablePrintConfig, SaveFileOptions, ReadFileOptions, ReadFileParams } from './export'
|
5 | import { ColumnFilterOption } from './filter'
|
6 | import { ColumnEditRule, ColumnEditValidErrMapParams } from './validator'
|
7 | import { ColumnFooterRenderParams } from './footer'
|
8 | import { MenuOptions, MenuFirstOption } from './menu'
|
9 |
|
10 |
|
11 |
|
12 |
|
13 | export declare class Table extends VXETableComponent {
|
14 | |
15 |
|
16 |
|
17 | id?: string;
|
18 | |
19 |
|
20 |
|
21 | data?: any[];
|
22 | |
23 |
|
24 |
|
25 | height?: number | string;
|
26 | |
27 |
|
28 |
|
29 | maxHeight?: number | string;
|
30 | |
31 |
|
32 |
|
33 | resizable?: boolean;
|
34 | |
35 |
|
36 |
|
37 | stripe?: boolean;
|
38 | |
39 |
|
40 |
|
41 | border?: TableBorder;
|
42 | |
43 |
|
44 |
|
45 | loading?: boolean;
|
46 | |
47 |
|
48 |
|
49 | align?: TableAlign;
|
50 | |
51 |
|
52 |
|
53 | headerAlign?: TableAlign;
|
54 | |
55 |
|
56 |
|
57 | footerAlign?: TableAlign;
|
58 | |
59 |
|
60 |
|
61 | showHeader?: boolean;
|
62 | |
63 |
|
64 |
|
65 | highlightCurrentRow?: boolean;
|
66 | |
67 |
|
68 |
|
69 | highlightHoverRow?: boolean;
|
70 | |
71 |
|
72 |
|
73 | highlightCurrentColumn?: boolean;
|
74 | |
75 |
|
76 |
|
77 | highlightHoverColumn?: boolean;
|
78 | |
79 |
|
80 |
|
81 | highlightCell?: boolean;
|
82 | |
83 |
|
84 |
|
85 | showFooter?: boolean;
|
86 | |
87 |
|
88 |
|
89 | footerMethod?: typeof TableFooterMethod;
|
90 | |
91 |
|
92 |
|
93 | rowClassName?: string | Function;
|
94 | |
95 |
|
96 |
|
97 | cellClassName?: string | Function;
|
98 | |
99 |
|
100 |
|
101 | headerRowClassName?: string | Function;
|
102 | |
103 |
|
104 |
|
105 | headerCellClassName?: string | Function;
|
106 | |
107 |
|
108 |
|
109 | footerRowClassName?: string | Function;
|
110 | |
111 |
|
112 |
|
113 | footerCellClassName?: string | Function;
|
114 | |
115 |
|
116 |
|
117 | cellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
118 | |
119 |
|
120 |
|
121 | headerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
122 | |
123 |
|
124 |
|
125 | footerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
126 | |
127 |
|
128 |
|
129 | rowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
130 | |
131 |
|
132 |
|
133 | headerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
134 | |
135 |
|
136 |
|
137 | footerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
138 | |
139 |
|
140 |
|
141 | mergeCells: TableMergeConfig[];
|
142 | |
143 |
|
144 |
|
145 | mergeFooterItems: TableMergeConfig[];
|
146 | |
147 |
|
148 |
|
149 | spanMethod?: typeof TableSpanMethod;
|
150 | |
151 |
|
152 |
|
153 | footerSpanMethod?: typeof TableFooterSpanMethod;
|
154 | |
155 |
|
156 |
|
157 | showOverflow?: TableOverflow;
|
158 | |
159 |
|
160 |
|
161 | showHeaderOverflow?: TableOverflow;
|
162 | |
163 |
|
164 |
|
165 | showFooterOverflow?: TableOverflow;
|
166 |
|
167 |
|
168 |
|
169 | columnKey?: boolean;
|
170 | rowKey?: boolean;
|
171 | rowId?: string;
|
172 | zIndex?: number;
|
173 | keepSource?: boolean;
|
174 |
|
175 | autoResize?: boolean;
|
176 |
|
177 | syncResize?: boolean | string | number;
|
178 |
|
179 | columnConfig?: TableColumnConfig;
|
180 |
|
181 | seqConfig?: TableSeqConfig;
|
182 |
|
183 | sortConfig?: TableSortConfig;
|
184 |
|
185 | filterConfig?: TableFilterConfig;
|
186 |
|
187 | radioConfig?: TableRadioConfig;
|
188 |
|
189 | checkboxConfig?: TableCheckboxConfig;
|
190 | checkboxOpts: TableCheckboxConfig;
|
191 |
|
192 | tooltipConfig?: TableTooltipConfig;
|
193 | tooltipOpts: TableTooltipConfig;
|
194 |
|
195 | exportConfig?: TableExportConfig;
|
196 | exportOpts: TableExportConfig;
|
197 |
|
198 | importConfig?: TableImportConfig;
|
199 | importOpts: TableImportConfig;
|
200 |
|
201 | printConfig?: TablePrintConfig;
|
202 | printOpts: TablePrintConfig;
|
203 |
|
204 | expandConfig?: TableExpandConfig;
|
205 | expandOpts: TableExpandConfig;
|
206 |
|
207 | treeConfig?: TableTreeConfig;
|
208 | treeOpts: TreeOpts;
|
209 |
|
210 | menuConfig?: TableMenuConfig;
|
211 | |
212 |
|
213 |
|
214 |
|
215 | contextMenu?: TableMenuConfig;
|
216 |
|
217 | mouseConfig?: TableMouseConfig;
|
218 | mouseOpts: TableMouseConfig;
|
219 |
|
220 | keyboardConfig?: TableKeyboardConfig;
|
221 | keyboardOpts: TableKeyboardConfig;
|
222 | clipConfig?: TableClipConfig;
|
223 |
|
224 | editConfig?: TableEditConfig;
|
225 | editOpts: TableEditConfig;
|
226 |
|
227 | validConfig?: TableValidConfig;
|
228 |
|
229 | editRules?: EditVaildRules;
|
230 | emptyText?: string;
|
231 |
|
232 | emptyRender?: TableEmptyRender;
|
233 | animat?: boolean;
|
234 | delayHover?: number;
|
235 | |
236 |
|
237 |
|
238 | scrollX?: {
|
239 | |
240 |
|
241 |
|
242 | gt?: number;
|
243 | |
244 |
|
245 |
|
246 | oSize?: number;
|
247 | [key: string]: any;
|
248 | };
|
249 | |
250 |
|
251 |
|
252 | scrollY?: {
|
253 | |
254 |
|
255 |
|
256 | gt?: number;
|
257 | |
258 |
|
259 |
|
260 | oSize?: number;
|
261 | [key: string]: any;
|
262 | };
|
263 |
|
264 | params?: any;
|
265 |
|
266 |
|
267 | |
268 |
|
269 |
|
270 |
|
271 | clearAll(): Promise<any>;
|
272 | |
273 |
|
274 |
|
275 |
|
276 | syncData(): Promise<any>;
|
277 | |
278 |
|
279 |
|
280 |
|
281 | updateData(): Promise<any>;
|
282 | |
283 |
|
284 |
|
285 |
|
286 | loadData(data: RecordInfo[]): Promise<any>;
|
287 | |
288 |
|
289 |
|
290 |
|
291 | reloadData(data: RecordInfo[]): Promise<any>;
|
292 | |
293 |
|
294 |
|
295 |
|
296 |
|
297 |
|
298 | reloadRow(rows: RowInfo | RowInfo[], record?: RecordInfo, field?: string): Promise<any>;
|
299 | |
300 |
|
301 |
|
302 |
|
303 | loadColumn(columns: ColumnOptions[]): Promise<any>;
|
304 | |
305 |
|
306 |
|
307 |
|
308 | reloadColumn(columns: ColumnOptions[]): Promise<any>;
|
309 | |
310 |
|
311 |
|
312 |
|
313 | getRowNode(trElem: HTMLElement): {
|
314 | rowid: string;
|
315 | item: RowInfo;
|
316 | items: RowInfo[];
|
317 | index: number;
|
318 | parent?: RowInfo;
|
319 | };
|
320 | |
321 |
|
322 |
|
323 |
|
324 | getColumnNode(cellElem: HTMLElement): {
|
325 | colid: string;
|
326 | item: ColumnInfo;
|
327 | items: ColumnInfo[];
|
328 | index: number;
|
329 | parent?: ColumnInfo;
|
330 | };
|
331 | |
332 |
|
333 |
|
334 |
|
335 | getRowIndex(row: RowInfo): number;
|
336 | |
337 |
|
338 |
|
339 |
|
340 | getVTRowIndex(row: RowInfo): number;
|
341 | |
342 |
|
343 |
|
344 |
|
345 | getVMRowIndex(row: RowInfo): number;
|
346 | |
347 |
|
348 |
|
349 |
|
350 | getColumnIndex(column: ColumnInfo): number;
|
351 | |
352 |
|
353 |
|
354 |
|
355 | getVTColumnIndex(column: ColumnInfo): number;
|
356 | |
357 |
|
358 |
|
359 |
|
360 | getVMColumnIndex(column: ColumnInfo): number;
|
361 | |
362 |
|
363 |
|
364 |
|
365 |
|
366 | createData(records: any[]): Promise<any[]>;
|
367 | |
368 |
|
369 |
|
370 |
|
371 |
|
372 | createRow(records: any | any[]): Promise<any | any[]>;
|
373 | |
374 |
|
375 |
|
376 |
|
377 |
|
378 | revertData(rows?: RowInfo | RowInfo[], field?: string): Promise<any>;
|
379 | |
380 |
|
381 |
|
382 |
|
383 |
|
384 | clearData(rows?: RowInfo | RowInfo[], field?: string): Promise<any>;
|
385 | |
386 |
|
387 |
|
388 |
|
389 | isInsertByRow(row: RowInfo): boolean;
|
390 | |
391 |
|
392 |
|
393 |
|
394 | isUpdateByRow(row: any, field?: string): boolean;
|
395 | |
396 |
|
397 |
|
398 |
|
399 | getColumns(columnIndex?: number): ColumnInfo | ColumnInfo[];
|
400 | |
401 |
|
402 |
|
403 |
|
404 | getColumnById(colid: string): ColumnInfo;
|
405 | |
406 |
|
407 |
|
408 |
|
409 | getColumnByField(field: string): ColumnInfo;
|
410 | |
411 |
|
412 |
|
413 |
|
414 | getTableColumn(): {
|
415 | collectColumn: ColumnInfo[];
|
416 | fullColumn: ColumnInfo[];
|
417 | visibleColumn: ColumnInfo[];
|
418 | tableColumn: ColumnInfo[];
|
419 | };
|
420 | |
421 |
|
422 |
|
423 | getData(rowIndex?: number): RowInfo[];
|
424 | |
425 |
|
426 |
|
427 | getCheckboxRecords(isFull?: boolean): RowInfo[];
|
428 | |
429 |
|
430 |
|
431 |
|
432 | getRowById(rowid: string | number): RowInfo;
|
433 | |
434 |
|
435 |
|
436 |
|
437 | getTableData(): {
|
438 | fullData: RowInfo[];
|
439 | visibleData: RowInfo[];
|
440 | tableData: RowInfo[];
|
441 | footerData: any[][];
|
442 | };
|
443 | |
444 |
|
445 |
|
446 |
|
447 | hideColumn(column: ColumnInfo): Promise<any>;
|
448 | |
449 |
|
450 |
|
451 |
|
452 | showColumn(column: ColumnInfo): Promise<any>;
|
453 | |
454 |
|
455 |
|
456 |
|
457 |
|
458 | resetColumn(options: boolean | { visible?: boolean, resizable?: boolean }): Promise<any>;
|
459 | |
460 |
|
461 |
|
462 |
|
463 | refreshColumn(): Promise<any>;
|
464 | |
465 |
|
466 |
|
467 |
|
468 | refreshScroll(): Promise<any>;
|
469 | |
470 |
|
471 |
|
472 |
|
473 | recalculate(refull?: boolean): Promise<any>;
|
474 | |
475 |
|
476 |
|
477 |
|
478 |
|
479 | openTooltip (target: HTMLElement, content: string | number): Promise<any>;
|
480 | |
481 |
|
482 |
|
483 | closeTooltip(): Promise<any>;
|
484 | |
485 |
|
486 |
|
487 |
|
488 |
|
489 | setCheckboxRow(rows: RowInfo | RowInfo[], checked: boolean): Promise<any>;
|
490 | |
491 |
|
492 |
|
493 | isAllCheckboxChecked(): boolean;
|
494 | |
495 |
|
496 |
|
497 | isAllCheckboxIndeterminate(): boolean;
|
498 | |
499 |
|
500 |
|
501 |
|
502 | isCheckedByCheckboxRow(row: RowInfo): boolean;
|
503 | |
504 |
|
505 |
|
506 |
|
507 | toggleCheckboxRow(row: RowInfo): Promise<any>;
|
508 | |
509 |
|
510 |
|
511 |
|
512 | setAllCheckboxRow(checked: boolean): Promise<any>;
|
513 | |
514 |
|
515 |
|
516 | getRadioReserveRecord(isFull?: boolean): RowInfo[];
|
517 | |
518 |
|
519 |
|
520 | clearRadioReserve(): Promise<any>;
|
521 | |
522 |
|
523 |
|
524 | getCheckboxReserveRecords(isFull?: boolean): RowInfo[];
|
525 | |
526 |
|
527 |
|
528 | getCheckboxIndeterminateRecords(isFull?: boolean): RowInfo[]
|
529 | |
530 |
|
531 |
|
532 | clearCheckboxReserve(): Promise<any>;
|
533 | |
534 |
|
535 |
|
536 | toggleAllCheckboxRow(): Promise<any>;
|
537 | |
538 |
|
539 |
|
540 | clearCheckboxRow(): Promise<any>;
|
541 | |
542 |
|
543 |
|
544 |
|
545 | setCurrentRow(row: RowInfo): Promise<any>;
|
546 | |
547 |
|
548 |
|
549 |
|
550 | isCheckedByRadioRow(row: RowInfo): boolean;
|
551 | |
552 |
|
553 |
|
554 |
|
555 | setRadioRow(row: RowInfo): Promise<any>;
|
556 | |
557 |
|
558 |
|
559 | clearMergeCells(): Promise<any>;
|
560 | |
561 |
|
562 |
|
563 | clearMergeFooterItems(): Promise<any>;
|
564 | |
565 |
|
566 |
|
567 | clearCurrentRow(): Promise<any>;
|
568 | |
569 |
|
570 |
|
571 | clearRadioRow(): Promise<any>;
|
572 | |
573 |
|
574 |
|
575 | getMergeCells(): MergeItem[];
|
576 | |
577 |
|
578 |
|
579 | getMergeFooterItems(): MergeItem[];
|
580 | |
581 |
|
582 |
|
583 | getCurrentColumn(): ColumnInfo | null;
|
584 | |
585 |
|
586 |
|
587 | getCurrentRecord(): RowInfo;
|
588 | |
589 |
|
590 |
|
591 | getRadioRecord(isFull?: boolean): RowInfo;
|
592 | |
593 |
|
594 |
|
595 |
|
596 | setCurrentColumn(column: ColumnInfo): Promise<any>;
|
597 | |
598 |
|
599 |
|
600 | clearCurrentColumn(): Promise<any>;
|
601 | |
602 |
|
603 |
|
604 |
|
605 |
|
606 | sort(sortConfs: string | TableSortConfs | TableSortConfs[], order?: TableSortOrder): Promise<any>;
|
607 | |
608 |
|
609 |
|
610 | clearSort(fieldOrColumn?: string | ColumnInfo | null): Promise<any>;
|
611 | |
612 |
|
613 |
|
614 | getSortColumn(): ColumnInfo;
|
615 | |
616 |
|
617 |
|
618 | closeFilter(): Promise<any>;
|
619 | |
620 |
|
621 |
|
622 |
|
623 | isFilter(column: ColumnInfo): boolean;
|
624 | |
625 |
|
626 |
|
627 |
|
628 | isRowExpandLoaded(row: RowInfo): boolean;
|
629 | |
630 |
|
631 |
|
632 | clearRowExpandLoaded(row: any): Promise<any>;
|
633 | |
634 |
|
635 |
|
636 |
|
637 | reloadRowExpand(rows: RowInfo | RowInfo[]): Promise<any>;
|
638 | |
639 |
|
640 |
|
641 |
|
642 | toggleRowExpand(row: RowInfo): Promise<any>;
|
643 | |
644 |
|
645 |
|
646 |
|
647 |
|
648 | setAllRowExpand(checked: boolean): Promise<any>;
|
649 | |
650 |
|
651 |
|
652 |
|
653 |
|
654 | setRowExpand(rows: RowInfo | RowInfo[], checked: boolean): Promise<any>;
|
655 | |
656 |
|
657 |
|
658 |
|
659 | isExpandByRow(row: RowInfo): boolean;
|
660 | |
661 |
|
662 |
|
663 | clearRowExpand(): Promise<any>;
|
664 | |
665 |
|
666 |
|
667 | getRowExpandRecords(): RowInfo[];
|
668 | |
669 |
|
670 |
|
671 |
|
672 | getTreeExpandRecords(): RowInfo[];
|
673 | |
674 |
|
675 |
|
676 | isTreeExpandLoaded(row: RowInfo): boolean;
|
677 | |
678 |
|
679 |
|
680 | clearTreeExpandLoaded(row: any): Promise<any>;
|
681 | |
682 |
|
683 |
|
684 |
|
685 | reloadTreeChilds(rows: RowInfo | RowInfo[]): Promise<any>;
|
686 | |
687 |
|
688 |
|
689 |
|
690 | toggleTreeExpand(row: RowInfo): Promise<any>;
|
691 | |
692 |
|
693 |
|
694 |
|
695 |
|
696 | setAllTreeExpand(checked: boolean): Promise<any>;
|
697 | |
698 |
|
699 |
|
700 |
|
701 |
|
702 | setTreeExpand(rows: RowInfo | RowInfo, checked: boolean): Promise<any>;
|
703 | |
704 |
|
705 |
|
706 |
|
707 | isTreeExpandByRow(row: RowInfo): boolean;
|
708 | |
709 |
|
710 |
|
711 | clearTreeExpand(): Promise<any>;
|
712 | |
713 |
|
714 |
|
715 | getScroll(): {
|
716 | virtualX: boolean;
|
717 | virtualY: boolean;
|
718 | scrollTop: number;
|
719 | scrollLeft: number;
|
720 | };
|
721 | |
722 |
|
723 |
|
724 |
|
725 |
|
726 | scrollTo(scrollLeft: number, scrollTop?: number): Promise<any>;
|
727 | |
728 |
|
729 |
|
730 |
|
731 |
|
732 | scrollToRow(row: RowInfo, column?: ColumnInfo): Promise<any>;
|
733 | |
734 |
|
735 |
|
736 |
|
737 | scrollToColumn(column: ColumnInfo): Promise<any>;
|
738 | |
739 |
|
740 |
|
741 | clearScroll(): Promise<any>;
|
742 | |
743 |
|
744 |
|
745 | updateFooter(): Promise<any>;
|
746 | |
747 |
|
748 |
|
749 |
|
750 | updateStatus(
|
751 | params: {
|
752 | row: RowInfo;
|
753 | column: ColumnInfo;
|
754 | }
|
755 | ): Promise<any>;
|
756 | |
757 |
|
758 |
|
759 |
|
760 |
|
761 |
|
762 | setFilter(column: ColumnInfo, options: ColumnFilterOption[]): Promise<any>;
|
763 | |
764 |
|
765 |
|
766 |
|
767 |
|
768 | clearFilter(column?: ColumnInfo): Promise<any>;
|
769 | |
770 |
|
771 |
|
772 | closeMenu(): Promise<any>;
|
773 | |
774 |
|
775 |
|
776 | getSelectedCell(): {
|
777 | row: RowInfo;
|
778 | column: ColumnInfo;
|
779 | };
|
780 | |
781 |
|
782 |
|
783 | getCellAreas(): MouseCellArea[];
|
784 | |
785 |
|
786 |
|
787 | copyCellArea(): { text: string, html: string };
|
788 | |
789 |
|
790 |
|
791 | cutCellArea(): { text: string, html: string };
|
792 | |
793 |
|
794 |
|
795 | pasteCellArea(): Promise<any>;
|
796 | |
797 |
|
798 |
|
799 | clearSelected(): Promise<any>;
|
800 | |
801 |
|
802 |
|
803 |
|
804 | insert(records: RecordInfo | RecordInfo[]): Promise<{ row: RowInfo, rows: RowInfo[] }>;
|
805 | |
806 |
|
807 |
|
808 |
|
809 |
|
810 |
|
811 |
|
812 |
|
813 | insertAt(records: RecordInfo | RecordInfo[], row: RowInfo | -1 | null): Promise<{ row: RowInfo, rows: RowInfo[] }>;
|
814 | |
815 |
|
816 |
|
817 |
|
818 | remove(rows?: RowInfo | RowInfo[]): Promise<{ row: RowInfo, rows: RowInfo[] }>;
|
819 | |
820 |
|
821 |
|
822 | removeCheckboxRow(): Promise<{ row: RowInfo, rows: RowInfo[] }>;
|
823 | |
824 |
|
825 |
|
826 | removeRadioRow(): Promise<{ row: RowInfo, rows: RowInfo[] }>;
|
827 | |
828 |
|
829 |
|
830 | removeCurrentRow(): Promise<{ row: RowInfo, rows: RowInfo[] }>;
|
831 | |
832 |
|
833 |
|
834 | removeMergeCells(merges: TableMergeConfig | TableMergeConfig[]): Promise<MergeItem[]>;
|
835 | |
836 |
|
837 |
|
838 | removeMergeFooterItems(merges: TableMergeConfig | TableMergeConfig[]): Promise<MergeItem[]>;
|
839 | |
840 |
|
841 |
|
842 |
|
843 | getRecordset(): {
|
844 | insertRecords: RowInfo[];
|
845 | removeRecords: RowInfo[];
|
846 | updateRecords: RowInfo[];
|
847 | };
|
848 | |
849 |
|
850 |
|
851 | getInsertRecords(): RowInfo[];
|
852 | |
853 |
|
854 |
|
855 | getRemoveRecords(): RowInfo[];
|
856 | |
857 |
|
858 |
|
859 | getUpdateRecords(): RowInfo[];
|
860 | |
861 |
|
862 |
|
863 | clearActived(): Promise<any>;
|
864 | |
865 |
|
866 |
|
867 | clearCellAreas(area?: number | MouseCellArea): Promise<any>;
|
868 | |
869 |
|
870 |
|
871 | getActiveRecord(): {
|
872 | row: RowInfo;
|
873 | rowIndex: number;
|
874 | $rowIndex: number;
|
875 | column: ColumnInfo;
|
876 | columnIndex: number;
|
877 | $columnIndex: number;
|
878 | cell: HTMLElement;
|
879 | };
|
880 | |
881 |
|
882 |
|
883 |
|
884 | isActiveByRow(row: RowInfo): boolean;
|
885 | |
886 |
|
887 |
|
888 |
|
889 | setActiveRow(row: RowInfo): Promise<any>;
|
890 | |
891 |
|
892 |
|
893 |
|
894 |
|
895 | setActiveCell(row: RowInfo, field: string): Promise<any>;
|
896 | |
897 |
|
898 |
|
899 |
|
900 |
|
901 | setSelectCell(row: RowInfo, field: string): Promise<any>;
|
902 | |
903 |
|
904 |
|
905 |
|
906 | setCellAreas(areaConfigs: CellAreaConfig[], activeArea?: {
|
907 | area?: number | MouseCellArea;
|
908 | column?: number | ColumnInfo;
|
909 | row?: number | RowInfo;
|
910 | }): Promise<any>;
|
911 | |
912 |
|
913 |
|
914 |
|
915 | setActiveCellArea(activeArea: {
|
916 | area: MouseCellArea;
|
917 | column: number | ColumnInfo;
|
918 | row: number | RowInfo;
|
919 | }): Promise<any>;
|
920 | |
921 |
|
922 |
|
923 | setMergeCells(merges: TableMergeConfig | TableMergeConfig[]): Promise<any>;
|
924 | |
925 |
|
926 |
|
927 | setMergeFooterItems(merges: TableMergeConfig | TableMergeConfig[]): Promise<any>;
|
928 | |
929 |
|
930 |
|
931 | clearValidate(): Promise<any>;
|
932 | |
933 |
|
934 |
|
935 |
|
936 |
|
937 | fullValidate(rows?: boolean | RowInfo | RowInfo[] | ((errMap?: ColumnEditValidErrMapParams) => void), callback?: (errMap: ColumnEditValidErrMapParams) => void): Promise<ColumnEditValidErrMapParams>;
|
938 | |
939 |
|
940 |
|
941 |
|
942 |
|
943 | validate(rows?: boolean | RowInfo | RowInfo[] | ((errMap?: ColumnEditValidErrMapParams) => void), callback?: (errMap?: ColumnEditValidErrMapParams) => void): Promise<ColumnEditValidErrMapParams>;
|
944 | |
945 |
|
946 |
|
947 |
|
948 | openExport(options?: TableExportConfig): Promise<any>;
|
949 | |
950 |
|
951 |
|
952 |
|
953 | exportData(options?: TableExportConfig): Promise<any>;
|
954 | |
955 |
|
956 |
|
957 |
|
958 | openImport(options?: TableImportConfig): Promise<any>;
|
959 | |
960 |
|
961 |
|
962 |
|
963 | importData(options?: TableImportConfig): Promise<any>;
|
964 | |
965 |
|
966 |
|
967 |
|
968 | saveFile(options: SaveFileOptions): Promise<any>;
|
969 | |
970 |
|
971 |
|
972 |
|
973 | readFile(options?: ReadFileOptions): Promise<ReadFileParams>;
|
974 | |
975 |
|
976 |
|
977 |
|
978 | print(options?: TablePrintConfig): Promise<any>;
|
979 | |
980 |
|
981 |
|
982 |
|
983 | openPrint(options?: TablePrintConfig): Promise<any>;
|
984 | |
985 |
|
986 |
|
987 | openFind(): Promise<any>;
|
988 | |
989 |
|
990 |
|
991 | openReplace(): Promise<any>;
|
992 | |
993 |
|
994 |
|
995 |
|
996 | connect(toolbar: any): Promise<any>;
|
997 | |
998 |
|
999 |
|
1000 | focus(): Promise<any>;
|
1001 | |
1002 |
|
1003 |
|
1004 | blur(): Promise<any>;
|
1005 | [key: string]: any;
|
1006 | }
|
1007 |
|
1008 | export type TableBorder = boolean | 'default' | 'full' | 'outer' | 'inner' | 'none';
|
1009 | export type TableAlign = 'left' | 'center' | 'right' | null;
|
1010 | export type TableOverflow = boolean | 'ellipsis' | 'title' | 'tooltip' | null;
|
1011 |
|
1012 | export interface TableFooterMethodParams {
|
1013 | $table: Table;
|
1014 | columns: ColumnInfo[];
|
1015 | data: any[];
|
1016 | }
|
1017 | export function TableFooterMethod(params: TableFooterMethodParams): Array<string | number | null>[];
|
1018 |
|
1019 | export interface TableSpanMethodParams extends ColumnCellRenderParams {}
|
1020 | export function TableSpanMethod(params: TableSpanMethodParams): { rowspan: number, colspan: number }
|
1021 |
|
1022 | export interface TableFooterSpanMethodParams extends ColumnFooterRenderParams {}
|
1023 | export function TableFooterSpanMethod(params: TableFooterSpanMethodParams): { rowspan: number, colspan: number }
|
1024 |
|
1025 | export interface TableOptions {
|
1026 | id?: string;
|
1027 | data?: any[];
|
1028 | height?: number | string;
|
1029 | maxHeight?: number | string;
|
1030 | resizable?: boolean;
|
1031 | stripe?: boolean;
|
1032 | border?: TableBorder;
|
1033 | loading?: boolean;
|
1034 | align?: TableAlign;
|
1035 | headerAlign?: TableAlign;
|
1036 | footerAlign?: TableAlign;
|
1037 | showHeader?: boolean;
|
1038 | highlightCurrentRow?: boolean;
|
1039 | highlightHoverRow?: boolean;
|
1040 | highlightCurrentColumn?: boolean;
|
1041 | highlightHoverColumn?: boolean;
|
1042 | highlightCell?: boolean;
|
1043 | showFooter?: boolean;
|
1044 | footerMethod?: typeof TableFooterMethod;
|
1045 | rowClassName?: string | Function;
|
1046 | cellClassName?: string | Function;
|
1047 | headerRowClassName?: string | Function;
|
1048 | headerCellClassName?: string | Function;
|
1049 | footerRowClassName?: string | Function;
|
1050 | footerCellClassName?: string | Function;
|
1051 | cellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
1052 | headerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
1053 | footerCellStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
1054 | rowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
1055 | headerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
1056 | footerRowStyle?: { [key: string]: any } | Array<string | number | boolean | { [key: string]: any }> | Function;
|
1057 | mergeCells?: TableMergeConfig[];
|
1058 | mergeFooterItems?: TableMergeConfig[];
|
1059 | spanMethod?: typeof TableSpanMethod;
|
1060 | footerSpanMethod?: typeof TableFooterSpanMethod;
|
1061 | showOverflow?: TableOverflow;
|
1062 | showHeaderOverflow?: TableOverflow;
|
1063 | showFooterOverflow?: TableOverflow;
|
1064 | columnKey?: boolean;
|
1065 | rowKey?: boolean;
|
1066 | rowId?: string;
|
1067 | keepSource?: boolean;
|
1068 | autoResize?: boolean;
|
1069 | syncResize?: boolean | string | number;
|
1070 | columnConfig?: TableColumnConfig;
|
1071 | customConfig?: TableCustomConfig;
|
1072 | seqConfig?: TableSeqConfig;
|
1073 | sortConfig?: TableSortConfig;
|
1074 | filterConfig?: TableFilterConfig;
|
1075 | radioConfig?: TableRadioConfig;
|
1076 | checkboxConfig?: TableCheckboxConfig;
|
1077 | tooltipConfig?: TableTooltipConfig;
|
1078 | exportConfig?: TableExportConfig;
|
1079 | importConfig?: TableImportConfig;
|
1080 | printConfig?: TablePrintConfig;
|
1081 | expandConfig?: TableExpandConfig;
|
1082 | treeConfig?: TableTreeConfig;
|
1083 | menuConfig?: TableMenuConfig;
|
1084 | |
1085 |
|
1086 |
|
1087 |
|
1088 | contextMenu?: TableMenuConfig;
|
1089 | mouseConfig?: TableMouseConfig;
|
1090 | keyboardConfig?: TableKeyboardConfig;
|
1091 | clipConfig?: TableClipConfig;
|
1092 | editConfig?: TableEditConfig;
|
1093 | validConfig?: TableValidConfig;
|
1094 | editRules?: EditVaildRules;
|
1095 | emptyText?: string;
|
1096 | emptyRender?: TableEmptyRender;
|
1097 | animat?: boolean;
|
1098 | delayHover?: number;
|
1099 | scrollX?: {
|
1100 | gt?: number;
|
1101 | oSize?: number;
|
1102 | [key: string]: any;
|
1103 | };
|
1104 | scrollY?: {
|
1105 | gt?: number;
|
1106 | oSize?: number;
|
1107 | [key: string]: any;
|
1108 | };
|
1109 | params?: any;
|
1110 | [key: string]: any;
|
1111 | }
|
1112 |
|
1113 |
|
1114 |
|
1115 |
|
1116 | export interface TableColumnConfig {
|
1117 | width?: number;
|
1118 | minWidth?: number;
|
1119 | }
|
1120 | export interface ColumnDefaultConfig extends TableColumnConfig {}
|
1121 |
|
1122 |
|
1123 |
|
1124 |
|
1125 | export interface TableCustomConfig {
|
1126 | storage?: boolean | {
|
1127 | visible?: boolean;
|
1128 | resizable?: boolean;
|
1129 | };
|
1130 | checkMethod?(params: { column: ColumnInfo }): boolean;
|
1131 | }
|
1132 | export interface CustomConfig extends TableCustomConfig {}
|
1133 |
|
1134 |
|
1135 |
|
1136 |
|
1137 | export interface TableSeqConfig {
|
1138 | startIndex?: number;
|
1139 | seqMethod?(params: ColumnCellRenderParams): number;
|
1140 | }
|
1141 | export interface SeqConfig extends TableSeqConfig {}
|
1142 |
|
1143 | export interface TableSortConfs {
|
1144 | field: string;
|
1145 | order?: TableSortOrder;
|
1146 | }
|
1147 |
|
1148 | export type TableSortOrder = 'asc' | 'desc' | null;
|
1149 |
|
1150 |
|
1151 |
|
1152 |
|
1153 | export interface TableSortConfig {
|
1154 | defaultSort?: {
|
1155 | field: string;
|
1156 | order: TableSortOrder;
|
1157 | };
|
1158 | orders?: TableSortOrder[];
|
1159 | sortMethod?(params: { data: any[], column: ColumnInfo, property: string, order: string }): any[];
|
1160 | remote?: boolean;
|
1161 | trigger?: 'default' | 'cell';
|
1162 | showIcon: boolean;
|
1163 | iconAsc?: string;
|
1164 | iconDesc?: string;
|
1165 | }
|
1166 | export interface SortConfig extends TableSortConfig {}
|
1167 |
|
1168 |
|
1169 |
|
1170 |
|
1171 | export interface TableFilterConfig {
|
1172 | remote?: boolean;
|
1173 | showIcon?: string;
|
1174 | iconNone?: string;
|
1175 | iconMatch?: string;
|
1176 | }
|
1177 | export interface FilterConfig extends TableFilterConfig {}
|
1178 |
|
1179 |
|
1180 |
|
1181 |
|
1182 | export interface TableRadioConfig {
|
1183 | reserve?: boolean;
|
1184 | labelField?: string;
|
1185 | checkRowKey?: string | number;
|
1186 | checkMethod?(params: { row: RowInfo }): boolean;
|
1187 | trigger?: 'default' | 'cell' | 'row';
|
1188 | highlight?: boolean;
|
1189 | }
|
1190 | export interface RadioConfig extends TableRadioConfig {}
|
1191 |
|
1192 |
|
1193 |
|
1194 |
|
1195 | export interface TableCheckboxConfig {
|
1196 | reserve?: boolean;
|
1197 | labelField?: string;
|
1198 | checkField?: string;
|
1199 | halfField?: string;
|
1200 | showHeader?: boolean;
|
1201 | checkAll?: boolean;
|
1202 | checkRowKeys?: string[] | number[];
|
1203 | checkStrictly?: boolean;
|
1204 | strict?: boolean;
|
1205 | checkMethod?(params: { row: RowInfo }): boolean;
|
1206 | trigger?: 'default' | 'cell' | 'row';
|
1207 | highlight?: boolean;
|
1208 | range?: boolean;
|
1209 | }
|
1210 | export interface CheckboxConfig extends TableCheckboxConfig {}
|
1211 |
|
1212 |
|
1213 |
|
1214 |
|
1215 | export interface TableTooltipConfig {
|
1216 | enabled?: boolean;
|
1217 | theme?: 'dark' | 'light';
|
1218 | enterable?: boolean;
|
1219 | leaveDelay?: number;
|
1220 | contentMethod?(params: { items: any[], row: RowInfo, rowIndex: number, $rowIndex: number, column: ColumnInfo, columnIndex: number, $columnIndex: number, type: 'header' | 'body' | 'footer', cell: HTMLElement, $event: any }): string | null | void;
|
1221 | }
|
1222 | export interface TooltipConfig extends TableTooltipConfig {}
|
1223 |
|
1224 |
|
1225 |
|
1226 |
|
1227 | export interface TableExpandConfig {
|
1228 | labelField?: string;
|
1229 | expandAll?: boolean;
|
1230 | expandRowKeys?: string[] | number[];
|
1231 | accordion?: boolean;
|
1232 | trigger?: 'default' | 'cell' | 'row';
|
1233 | lazy?: boolean;
|
1234 | loadMethod?(params: { row: RowInfo, rowIndex: number, $rowIndex: number }): Promise<any>;
|
1235 | toggleMethod?(params: { expanded: boolean, row: RowInfo, column: ColumnInfo, columnIndex: number, $columnIndex: number }): boolean;
|
1236 | visibleMethod?(params: { expanded: boolean, row: RowInfo, column: ColumnInfo, columnIndex: number, $columnIndex: number }): boolean;
|
1237 | showIcon?: boolean;
|
1238 | iconOpen?: string;
|
1239 | iconClose?: string;
|
1240 | iconLoaded?: string;
|
1241 | }
|
1242 | export interface ExpandConfig extends TableExpandConfig {}
|
1243 |
|
1244 |
|
1245 |
|
1246 |
|
1247 | export interface TableTreeConfig {
|
1248 | children?: string;
|
1249 | indent?: number;
|
1250 | line?: boolean;
|
1251 | expandAll?: boolean;
|
1252 | expandRowKeys?: string[] | number[];
|
1253 | accordion?: boolean;
|
1254 | trigger?: 'default' | 'cell' | 'row';
|
1255 | lazy?: boolean;
|
1256 | hasChild?: string;
|
1257 | loadMethod?(params: { row: RowInfo }): Promise<any[]>;
|
1258 | toggleMethod?(params: { expanded: boolean, row: RowInfo, column: ColumnInfo, columnIndex: number, $columnIndex: number }): boolean;
|
1259 | showIcon?: boolean;
|
1260 | iconOpen?: string;
|
1261 | iconClose?: string;
|
1262 | iconLoaded?: string;
|
1263 | }
|
1264 | export interface TreeConfig extends TableTreeConfig {}
|
1265 |
|
1266 | export interface TreeOpts {
|
1267 | children: string;
|
1268 | indent: number;
|
1269 | line?: boolean;
|
1270 | expandAll?: boolean;
|
1271 | expandRowKeys?: string[] | number[];
|
1272 | accordion?: boolean;
|
1273 | trigger?: 'default' | 'cell' | 'row';
|
1274 | lazy?: boolean;
|
1275 | hasChild: string;
|
1276 | loadMethod?(params: { row: RowInfo }): Promise<any[]>;
|
1277 | toggleMethod?(params: { expanded: boolean, row: RowInfo, column: ColumnInfo, columnIndex: number, $columnIndex: number }): boolean;
|
1278 | showIcon: boolean;
|
1279 | iconOpen: string;
|
1280 | iconClose: string;
|
1281 | iconLoaded: string;
|
1282 | }
|
1283 |
|
1284 |
|
1285 |
|
1286 |
|
1287 | export interface TableMenuConfig {
|
1288 | header?: MenuOptions;
|
1289 | body?: MenuOptions;
|
1290 | footer?: MenuOptions;
|
1291 | trigger?: 'default' | 'cell';
|
1292 | visibleMethod?(params: { type: string, options: MenuFirstOption[], columns: ColumnInfo[], row?: RowInfo, rowIndex?: number, column?: ColumnInfo, columnIndex?: number }): boolean;
|
1293 | className?: string;
|
1294 | }
|
1295 | export interface TableContextMenu extends TableMenuConfig {}
|
1296 | export interface ContextMenuConfig extends TableContextMenu {}
|
1297 |
|
1298 |
|
1299 |
|
1300 |
|
1301 | export interface TableMouseConfig {
|
1302 | selected?: boolean;
|
1303 | |
1304 |
|
1305 |
|
1306 | area?: boolean;
|
1307 | }
|
1308 | export interface MouseConfig extends TableMouseConfig {}
|
1309 |
|
1310 | export interface MouseCellArea {
|
1311 | main: boolean;
|
1312 | rows: RowInfo[];
|
1313 | cols: ColumnInfo[];
|
1314 | top: number;
|
1315 | left: number;
|
1316 | width: number;
|
1317 | height: number;
|
1318 | }
|
1319 |
|
1320 | export type CELL_AREA_TYPE = 'main' | 'copy' | 'extend' | 'multi' | 'active'
|
1321 |
|
1322 | export interface CellAreaConfig {
|
1323 | type?: CELL_AREA_TYPE;
|
1324 | startColumn: ColumnInfo;
|
1325 | endColumn: ColumnInfo;
|
1326 | startRow: RowInfo;
|
1327 | endRow: RowInfo;
|
1328 | }
|
1329 |
|
1330 | export interface TableMergeConfig {
|
1331 | row: RowInfo | number;
|
1332 | col: ColumnInfo | number;
|
1333 | rowspan: number;
|
1334 | colspan: number;
|
1335 | }
|
1336 | export interface MergeOptions extends TableMergeConfig {}
|
1337 |
|
1338 | export interface MergeItem {
|
1339 | row: number;
|
1340 | col: number;
|
1341 | rowspan: number;
|
1342 | colspan: number;
|
1343 | [key: string]: any;
|
1344 | }
|
1345 |
|
1346 |
|
1347 |
|
1348 |
|
1349 | export interface TableKeyboardConfig {
|
1350 | |
1351 |
|
1352 |
|
1353 | isArrow?: boolean;
|
1354 | |
1355 |
|
1356 |
|
1357 | isDel?: boolean;
|
1358 | |
1359 |
|
1360 |
|
1361 | isEnter?: boolean;
|
1362 | |
1363 |
|
1364 |
|
1365 | isTab?: boolean;
|
1366 | |
1367 |
|
1368 |
|
1369 | isEdit?: boolean;
|
1370 | |
1371 |
|
1372 |
|
1373 | isClip?: boolean;
|
1374 | |
1375 |
|
1376 |
|
1377 | isChecked?: boolean;
|
1378 | |
1379 |
|
1380 |
|
1381 | enterToTab?: boolean;
|
1382 | |
1383 |
|
1384 |
|
1385 | editMethod?(params: { row: RowInfo, rowIndex: number, column: ColumnInfo, columnIndex: number, cell: HTMLElement }): boolean;
|
1386 | }
|
1387 | export interface KeyboardConfig extends TableKeyboardConfig {}
|
1388 |
|
1389 |
|
1390 |
|
1391 |
|
1392 | export interface TableClipConfig {
|
1393 | getMethod?(params: {
|
1394 | row: any;
|
1395 | column: ColumnInfo;
|
1396 | }): string;
|
1397 | beforeGetMethod?(params: {
|
1398 | targetAreas: any[];
|
1399 | }): boolean;
|
1400 | setMethod?(params: {
|
1401 | row: any,
|
1402 | column: ColumnInfo;
|
1403 | cellValue: any;
|
1404 | }): void;
|
1405 | beforeSetMethod?(params: {
|
1406 | currentAreas: any[];
|
1407 | targetAreas: any[];
|
1408 | cellValues: any[][];
|
1409 | }): boolean;
|
1410 | }
|
1411 |
|
1412 |
|
1413 |
|
1414 |
|
1415 | export interface TableEditConfig {
|
1416 | trigger?: 'manual' | 'click' | 'dblclick';
|
1417 | mode?: string;
|
1418 | showIcon?: boolean;
|
1419 | showStatus?: boolean;
|
1420 | autoClear?: boolean;
|
1421 | |
1422 |
|
1423 |
|
1424 | activeMethod?(params: { row: RowInfo, rowIndex: number, column: ColumnInfo, columnIndex: number }): boolean;
|
1425 | }
|
1426 | export interface EditConfig extends TableEditConfig {}
|
1427 |
|
1428 |
|
1429 |
|
1430 |
|
1431 | export interface TableValidConfig {
|
1432 | autoPos?: boolean;
|
1433 | message?: string;
|
1434 | maxWidth?: number;
|
1435 | }
|
1436 | export interface ValidConfig extends TableValidConfig {}
|
1437 |
|
1438 |
|
1439 |
|
1440 |
|
1441 | export interface EditVaildRules {
|
1442 | [field: string]: ColumnEditRule[];
|
1443 | }
|
1444 | export interface VaildRules extends EditVaildRules {}
|