@antv/s2-vue 1.2.1 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/esm/index.d.ts CHANGED
@@ -28,6 +28,7 @@ import { LayoutResult } from '@antv/s2';
28
28
  import { MemoizedFunction } from 'lodash';
29
29
  import { Node as Node_2 } from '@antv/s2';
30
30
  import { Omit as Omit_2 } from 'lodash';
31
+ import type { PaginationProps } from 'ant-design-vue';
31
32
  import { Point } from '@antv/g-canvas';
32
33
  import { PropType } from 'vue';
33
34
  import { Ref } from 'vue';
@@ -163,6 +164,12 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
163
164
  protected drawTextShape(): void;
164
165
  protected drawLinkFieldShape(showLinkFieldShape: boolean, linkFillColor: string): void;
165
166
  updateByState(stateName: InteractionStateName, cell: S2CellType): void;
167
+ protected getInteractiveBorderShapeStyle<T>(style: T & number): {
168
+ x: number;
169
+ y: number;
170
+ width: number;
171
+ height: number;
172
+ };
166
173
  hideInteractionShape(): void;
167
174
  clearUnselectedState(): void;
168
175
  getTextShape(): IShape;
@@ -368,7 +375,11 @@ declare abstract class BaseFacet {
368
375
  clearAllGroup: () => void;
369
376
  scrollWithAnimation: (offsetConfig?: OffsetConfig, duration?: number, cb?: () => void) => void;
370
377
  scrollImmediately: (offsetConfig?: OffsetConfig) => void;
371
- startScroll: (newX: number, newY: number) => void;
378
+ /**
379
+ *
380
+ * @param skipSrollEvent 如为true则不触发S2Event.GLOBAL_SCROLL
381
+ */
382
+ startScroll: (skipSrollEvent?: boolean) => void;
372
383
  getRendererHeight: () => number;
373
384
  private getAdjustedScrollOffset;
374
385
  renderRowScrollBar: (rowScrollX: number) => void;
@@ -377,24 +388,16 @@ declare abstract class BaseFacet {
377
388
  private getScrollbarPosition;
378
389
  renderVScrollBar: (height: number, realHeight: number, scrollY: number) => void;
379
390
  getScrollBarOffset: (offset: number, scrollbar: ScrollBar) => number;
380
- isScrollOverThePanelArea: ({ layerX, layerY }: Partial<S2WheelEvent>) => boolean;
381
- isScrollOverTheCornerArea: ({ layerX, layerY }: Partial<S2WheelEvent>) => boolean;
382
- updateHorizontalRowScrollOffset: ({ offset, layerX, layerY }: {
383
- offset: any;
384
- layerX: any;
385
- layerY: any;
386
- }) => void;
387
- updateHorizontalScrollOffset: ({ offset, layerX, layerY }: {
388
- offset: any;
389
- layerX: any;
390
- layerY: any;
391
- }) => void;
392
- isScrollToLeft: (deltaX: number) => boolean;
393
- isScrollToRight: (deltaX: number) => boolean;
391
+ isScrollOverThePanelArea: ({ offsetX, offsetY }: CellScrollOffset) => boolean;
392
+ isScrollOverTheCornerArea: ({ offsetX, offsetY }: CellScrollOffset) => boolean;
393
+ updateHorizontalRowScrollOffset: ({ offset, offsetX, offsetY, }: CellScrollOffset) => void;
394
+ updateHorizontalScrollOffset: ({ offset, offsetX, offsetY, }: CellScrollOffset) => void;
395
+ isScrollToLeft: ({ deltaX, offsetX, offsetY }: CellScrollOffset) => boolean;
396
+ isScrollToRight: ({ deltaX, offsetX, offsetY }: CellScrollOffset) => boolean;
394
397
  isScrollToTop: (deltaY: number) => boolean;
395
398
  isScrollToBottom: (deltaY: number) => boolean;
396
399
  isVerticalScrollOverTheViewport: (deltaY: number) => boolean;
397
- isHorizontalScrollOverTheViewport: (deltaX: number) => boolean;
400
+ isHorizontalScrollOverTheViewport: (scrollOffset: CellScrollOffset) => boolean;
398
401
  /**
399
402
  在当前表格滚动分两种情况:
400
403
  1. 当前表格无滚动条: 无需阻止外部容器滚动
@@ -402,7 +405,7 @@ declare abstract class BaseFacet {
402
405
  - 未滚动到顶部或底部: 当前表格滚动, 阻止外部容器滚动
403
406
  - 滚动到顶部或底部: 恢复外部容器滚动
404
407
  */
405
- isScrollOverTheViewport: (deltaX: number, deltaY: number, layerY: number) => boolean;
408
+ isScrollOverTheViewport: (scrollOffset: CellScrollOffset) => boolean;
406
409
  cancelScrollFrame: () => boolean;
407
410
  clearScrollFrameIdOnMobile: () => void;
408
411
  /**
@@ -415,7 +418,7 @@ declare abstract class BaseFacet {
415
418
  */
416
419
  private stopScrollChainingIfNeeded;
417
420
  private stopScrollChaining;
418
- onWheel: (event: S2WheelEvent) => void;
421
+ onWheel: (event: WheelEvent) => void;
419
422
  protected clip(scrollX: number, scrollY: number): void;
420
423
  /**
421
424
  * Translate panelGroup, rowHeader, cornerHeader, columnHeader ect
@@ -458,11 +461,12 @@ declare abstract class BaseFacet {
458
461
  };
459
462
  updatePanelScrollGroup(): void;
460
463
  /**
461
- * When scroll behavior happened, only render one time in a period,
462
- * but render immediately in initiate
464
+ *
465
+ * @param skipSrollEvent: 如true则不触发GLOBAL_SCROLL事件
466
+ * During scroll behavior, first call to this method fires immediately and then on interval.
463
467
  * @protected
464
468
  */
465
- protected dynamicRenderCell(): void;
469
+ protected dynamicRenderCell(skipSrollEvent?: boolean): void;
466
470
  private emitScrollEvent;
467
471
  protected onAfterScroll: DebouncedFunc<() => void>;
468
472
  protected saveInitColumnLeafNodes(columnNodes?: Node_2_2[]): void;
@@ -577,14 +581,182 @@ loading: BooleanConstructor;
577
581
  partDrillDown: ObjectConstructor;
578
582
  header: ObjectConstructor;
579
583
  options: {
580
- type: PropType<S2Options<string | Element>>;
581
- default: S2Options<string | Element>;
584
+ type: PropType<S2Options<string | Element, Partial<ExtractPropTypes< {
585
+ total: NumberConstructor;
586
+ defaultCurrent: NumberConstructor;
587
+ disabled: {
588
+ type: BooleanConstructor;
589
+ default: any;
590
+ };
591
+ current: NumberConstructor;
592
+ defaultPageSize: NumberConstructor;
593
+ pageSize: NumberConstructor;
594
+ hideOnSinglePage: {
595
+ type: BooleanConstructor;
596
+ default: any;
597
+ };
598
+ showSizeChanger: {
599
+ type: BooleanConstructor;
600
+ default: any;
601
+ };
602
+ pageSizeOptions: PropType<(string | number)[]>;
603
+ buildOptionText: PropType<(opt: {
604
+ value: any;
605
+ }) => any>;
606
+ showQuickJumper: {
607
+ type: PropType<boolean | {
608
+ goButton?: any;
609
+ }>;
610
+ default: boolean | {
611
+ goButton?: any;
612
+ };
613
+ };
614
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
615
+ size: PropType<"small" | "default">;
616
+ simple: {
617
+ type: BooleanConstructor;
618
+ default: any;
619
+ };
620
+ locale: ObjectConstructor;
621
+ prefixCls: StringConstructor;
622
+ selectPrefixCls: StringConstructor;
623
+ totalBoundaryShowSizeChanger: NumberConstructor;
624
+ selectComponentClass: StringConstructor;
625
+ itemRender: PropType<(opt: {
626
+ page: number;
627
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
628
+ originalElement: any;
629
+ }) => any>;
630
+ role: StringConstructor;
631
+ responsive: BooleanConstructor;
632
+ showLessItems: {
633
+ type: BooleanConstructor;
634
+ default: any;
635
+ };
636
+ onChange: PropType<(page: number, pageSize: number) => void>;
637
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
638
+ 'onUpdate:current': PropType<(current: number) => void>;
639
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
640
+ }>>>>;
641
+ default: S2Options<string | Element, Partial<ExtractPropTypes< {
642
+ total: NumberConstructor;
643
+ defaultCurrent: NumberConstructor;
644
+ disabled: {
645
+ type: BooleanConstructor;
646
+ default: any;
647
+ };
648
+ current: NumberConstructor;
649
+ defaultPageSize: NumberConstructor;
650
+ pageSize: NumberConstructor;
651
+ hideOnSinglePage: {
652
+ type: BooleanConstructor;
653
+ default: any;
654
+ };
655
+ showSizeChanger: {
656
+ type: BooleanConstructor;
657
+ default: any;
658
+ };
659
+ pageSizeOptions: PropType<(string | number)[]>;
660
+ buildOptionText: PropType<(opt: {
661
+ value: any;
662
+ }) => any>;
663
+ showQuickJumper: {
664
+ type: PropType<boolean | {
665
+ goButton?: any;
666
+ }>;
667
+ default: boolean | {
668
+ goButton?: any;
669
+ };
670
+ };
671
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
672
+ size: PropType<"small" | "default">;
673
+ simple: {
674
+ type: BooleanConstructor;
675
+ default: any;
676
+ };
677
+ locale: ObjectConstructor;
678
+ prefixCls: StringConstructor;
679
+ selectPrefixCls: StringConstructor;
680
+ totalBoundaryShowSizeChanger: NumberConstructor;
681
+ selectComponentClass: StringConstructor;
682
+ itemRender: PropType<(opt: {
683
+ page: number;
684
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
685
+ originalElement: any;
686
+ }) => any>;
687
+ role: StringConstructor;
688
+ responsive: BooleanConstructor;
689
+ showLessItems: {
690
+ type: BooleanConstructor;
691
+ default: any;
692
+ };
693
+ onChange: PropType<(page: number, pageSize: number) => void>;
694
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
695
+ 'onUpdate:current': PropType<(current: number) => void>;
696
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
697
+ }>>>;
582
698
  };
583
699
  adaptive: {
584
700
  type: PropType<Adaptive>;
585
701
  default: Adaptive;
586
702
  };
587
- onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element>) => SpreadSheet>;
703
+ onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element, Partial<ExtractPropTypes< {
704
+ total: NumberConstructor;
705
+ defaultCurrent: NumberConstructor;
706
+ disabled: {
707
+ type: BooleanConstructor;
708
+ default: any;
709
+ };
710
+ current: NumberConstructor;
711
+ defaultPageSize: NumberConstructor;
712
+ pageSize: NumberConstructor;
713
+ hideOnSinglePage: {
714
+ type: BooleanConstructor;
715
+ default: any;
716
+ };
717
+ showSizeChanger: {
718
+ type: BooleanConstructor;
719
+ default: any;
720
+ };
721
+ pageSizeOptions: PropType<(string | number)[]>;
722
+ buildOptionText: PropType<(opt: {
723
+ value: any;
724
+ }) => any>;
725
+ showQuickJumper: {
726
+ type: PropType<boolean | {
727
+ goButton?: any;
728
+ }>;
729
+ default: boolean | {
730
+ goButton?: any;
731
+ };
732
+ };
733
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
734
+ size: PropType<"small" | "default">;
735
+ simple: {
736
+ type: BooleanConstructor;
737
+ default: any;
738
+ };
739
+ locale: ObjectConstructor;
740
+ prefixCls: StringConstructor;
741
+ selectPrefixCls: StringConstructor;
742
+ totalBoundaryShowSizeChanger: NumberConstructor;
743
+ selectComponentClass: StringConstructor;
744
+ itemRender: PropType<(opt: {
745
+ page: number;
746
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
747
+ originalElement: any;
748
+ }) => any>;
749
+ role: StringConstructor;
750
+ responsive: BooleanConstructor;
751
+ showLessItems: {
752
+ type: BooleanConstructor;
753
+ default: any;
754
+ };
755
+ onChange: PropType<(page: number, pageSize: number) => void>;
756
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
757
+ 'onUpdate:current': PropType<(current: number) => void>;
758
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
759
+ }>>>) => SpreadSheet>;
588
760
  onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet) => void>;
589
761
  }, {
590
762
  S2_PREFIX_CLS: string;
@@ -603,7 +775,7 @@ showSizeChange: (nextPageSize: number) => void;
603
775
  handlePageChange: (nextCurrent: number) => void;
604
776
  handlePageSizeChange: (nextSize: number) => void;
605
777
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
606
- spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element>) => SpreadSheet;
778
+ spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element, unknown>) => SpreadSheet;
607
779
  getSpreadSheet: (spreadsheet: SpreadSheet) => void;
608
780
  sheetUpdate: SheetUpdateCallback;
609
781
  rowCellHover: (data: TargetCellInfo) => void;
@@ -665,6 +837,7 @@ total: number;
665
837
  current: number;
666
838
  }) => void;
667
839
  layoutCellScroll: (position: CellScrollPosition) => void;
840
+ layoutCollapseRows: (data: CollapsedRowsType) => void;
668
841
  layoutAfterCollapseRows: (data: CollapsedRowsType) => void;
669
842
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
670
843
  layoutColsExpanded: (node: Node_2) => void;
@@ -698,12 +871,16 @@ keyBoardDown: (event: KeyboardEvent) => void;
698
871
  keyBoardUp: (event: KeyboardEvent) => void;
699
872
  copied: (copyData: string) => void;
700
873
  actionIconHover: (event: default_2) => void;
874
+ actionIconHoverOff: (event: default_2) => void;
701
875
  actionIconClick: (event: default_2) => void;
702
876
  contextMenu: (event: default_2) => void;
703
877
  click: (event: default_2) => void;
878
+ hover: (event: default_2) => void;
704
879
  doubleClick: (event: default_2) => void;
705
880
  mouseHover: (event: default_2) => void;
706
881
  mouseUp: (event: MouseEvent) => void;
882
+ mouseDown: (event: MouseEvent) => void;
883
+ mouseMove: (event: MouseEvent) => void;
707
884
  selected: (cells: DataCell[]) => void;
708
885
  reset: (event: KeyboardEvent) => void;
709
886
  linkFieldJump: (data: {
@@ -729,14 +906,182 @@ loading: BooleanConstructor;
729
906
  partDrillDown: ObjectConstructor;
730
907
  header: ObjectConstructor;
731
908
  options: {
732
- type: PropType<S2Options<string | Element>>;
733
- default: S2Options<string | Element>;
909
+ type: PropType<S2Options<string | Element, Partial<ExtractPropTypes< {
910
+ total: NumberConstructor;
911
+ defaultCurrent: NumberConstructor;
912
+ disabled: {
913
+ type: BooleanConstructor;
914
+ default: any;
915
+ };
916
+ current: NumberConstructor;
917
+ defaultPageSize: NumberConstructor;
918
+ pageSize: NumberConstructor;
919
+ hideOnSinglePage: {
920
+ type: BooleanConstructor;
921
+ default: any;
922
+ };
923
+ showSizeChanger: {
924
+ type: BooleanConstructor;
925
+ default: any;
926
+ };
927
+ pageSizeOptions: PropType<(string | number)[]>;
928
+ buildOptionText: PropType<(opt: {
929
+ value: any;
930
+ }) => any>;
931
+ showQuickJumper: {
932
+ type: PropType<boolean | {
933
+ goButton?: any;
934
+ }>;
935
+ default: boolean | {
936
+ goButton?: any;
937
+ };
938
+ };
939
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
940
+ size: PropType<"small" | "default">;
941
+ simple: {
942
+ type: BooleanConstructor;
943
+ default: any;
944
+ };
945
+ locale: ObjectConstructor;
946
+ prefixCls: StringConstructor;
947
+ selectPrefixCls: StringConstructor;
948
+ totalBoundaryShowSizeChanger: NumberConstructor;
949
+ selectComponentClass: StringConstructor;
950
+ itemRender: PropType<(opt: {
951
+ page: number;
952
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
953
+ originalElement: any;
954
+ }) => any>;
955
+ role: StringConstructor;
956
+ responsive: BooleanConstructor;
957
+ showLessItems: {
958
+ type: BooleanConstructor;
959
+ default: any;
960
+ };
961
+ onChange: PropType<(page: number, pageSize: number) => void>;
962
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
963
+ 'onUpdate:current': PropType<(current: number) => void>;
964
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
965
+ }>>>>;
966
+ default: S2Options<string | Element, Partial<ExtractPropTypes< {
967
+ total: NumberConstructor;
968
+ defaultCurrent: NumberConstructor;
969
+ disabled: {
970
+ type: BooleanConstructor;
971
+ default: any;
972
+ };
973
+ current: NumberConstructor;
974
+ defaultPageSize: NumberConstructor;
975
+ pageSize: NumberConstructor;
976
+ hideOnSinglePage: {
977
+ type: BooleanConstructor;
978
+ default: any;
979
+ };
980
+ showSizeChanger: {
981
+ type: BooleanConstructor;
982
+ default: any;
983
+ };
984
+ pageSizeOptions: PropType<(string | number)[]>;
985
+ buildOptionText: PropType<(opt: {
986
+ value: any;
987
+ }) => any>;
988
+ showQuickJumper: {
989
+ type: PropType<boolean | {
990
+ goButton?: any;
991
+ }>;
992
+ default: boolean | {
993
+ goButton?: any;
994
+ };
995
+ };
996
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
997
+ size: PropType<"small" | "default">;
998
+ simple: {
999
+ type: BooleanConstructor;
1000
+ default: any;
1001
+ };
1002
+ locale: ObjectConstructor;
1003
+ prefixCls: StringConstructor;
1004
+ selectPrefixCls: StringConstructor;
1005
+ totalBoundaryShowSizeChanger: NumberConstructor;
1006
+ selectComponentClass: StringConstructor;
1007
+ itemRender: PropType<(opt: {
1008
+ page: number;
1009
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
1010
+ originalElement: any;
1011
+ }) => any>;
1012
+ role: StringConstructor;
1013
+ responsive: BooleanConstructor;
1014
+ showLessItems: {
1015
+ type: BooleanConstructor;
1016
+ default: any;
1017
+ };
1018
+ onChange: PropType<(page: number, pageSize: number) => void>;
1019
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
1020
+ 'onUpdate:current': PropType<(current: number) => void>;
1021
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
1022
+ }>>>;
734
1023
  };
735
1024
  adaptive: {
736
1025
  type: PropType<Adaptive>;
737
1026
  default: Adaptive;
738
1027
  };
739
- onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element>) => SpreadSheet>;
1028
+ onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element, Partial<ExtractPropTypes< {
1029
+ total: NumberConstructor;
1030
+ defaultCurrent: NumberConstructor;
1031
+ disabled: {
1032
+ type: BooleanConstructor;
1033
+ default: any;
1034
+ };
1035
+ current: NumberConstructor;
1036
+ defaultPageSize: NumberConstructor;
1037
+ pageSize: NumberConstructor;
1038
+ hideOnSinglePage: {
1039
+ type: BooleanConstructor;
1040
+ default: any;
1041
+ };
1042
+ showSizeChanger: {
1043
+ type: BooleanConstructor;
1044
+ default: any;
1045
+ };
1046
+ pageSizeOptions: PropType<(string | number)[]>;
1047
+ buildOptionText: PropType<(opt: {
1048
+ value: any;
1049
+ }) => any>;
1050
+ showQuickJumper: {
1051
+ type: PropType<boolean | {
1052
+ goButton?: any;
1053
+ }>;
1054
+ default: boolean | {
1055
+ goButton?: any;
1056
+ };
1057
+ };
1058
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
1059
+ size: PropType<"small" | "default">;
1060
+ simple: {
1061
+ type: BooleanConstructor;
1062
+ default: any;
1063
+ };
1064
+ locale: ObjectConstructor;
1065
+ prefixCls: StringConstructor;
1066
+ selectPrefixCls: StringConstructor;
1067
+ totalBoundaryShowSizeChanger: NumberConstructor;
1068
+ selectComponentClass: StringConstructor;
1069
+ itemRender: PropType<(opt: {
1070
+ page: number;
1071
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
1072
+ originalElement: any;
1073
+ }) => any>;
1074
+ role: StringConstructor;
1075
+ responsive: BooleanConstructor;
1076
+ showLessItems: {
1077
+ type: BooleanConstructor;
1078
+ default: any;
1079
+ };
1080
+ onChange: PropType<(page: number, pageSize: number) => void>;
1081
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
1082
+ 'onUpdate:current': PropType<(current: number) => void>;
1083
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
1084
+ }>>>) => SpreadSheet>;
740
1085
  onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet) => void>;
741
1086
  }>> & {
742
1087
  onSheetUpdate?: (params: S2RenderOptions) => any;
@@ -799,6 +1144,7 @@ total: number;
799
1144
  current: number;
800
1145
  }) => any;
801
1146
  onLayoutCellScroll?: (position: CellScrollPosition) => any;
1147
+ onLayoutCollapseRows?: (data: CollapsedRowsType) => any;
802
1148
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType) => any;
803
1149
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
804
1150
  onLayoutColsExpanded?: (node: Node_2) => any;
@@ -832,12 +1178,16 @@ onKeyBoardDown?: (event: KeyboardEvent) => any;
832
1178
  onKeyBoardUp?: (event: KeyboardEvent) => any;
833
1179
  onCopied?: (copyData: string) => any;
834
1180
  onActionIconHover?: (event: default_2) => any;
1181
+ onActionIconHoverOff?: (event: default_2) => any;
835
1182
  onActionIconClick?: (event: default_2) => any;
836
1183
  onContextMenu?: (event: default_2) => any;
837
1184
  onClick?: (event: default_2) => any;
1185
+ onHover?: (event: default_2) => any;
838
1186
  onDoubleClick?: (event: default_2) => any;
839
1187
  onMouseHover?: (event: default_2) => any;
840
1188
  onMouseUp?: (event: MouseEvent) => any;
1189
+ onMouseDown?: (event: MouseEvent) => any;
1190
+ onMouseMove?: (event: MouseEvent) => any;
841
1191
  onSelected?: (cells: DataCell[]) => any;
842
1192
  onReset?: (event: KeyboardEvent) => any;
843
1193
  onLinkFieldJump?: (data: {
@@ -845,10 +1195,66 @@ key: string;
845
1195
  record: Data;
846
1196
  }) => any;
847
1197
  onScroll?: (position: CellScrollPosition) => any;
848
- onSpreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element>) => any;
1198
+ onSpreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element, unknown>) => any;
849
1199
  onGetSpreadSheet?: (spreadsheet: SpreadSheet) => any;
850
1200
  }, {
851
- options: S2Options<string | Element>;
1201
+ options: S2Options<string | Element, Partial<ExtractPropTypes< {
1202
+ total: NumberConstructor;
1203
+ defaultCurrent: NumberConstructor;
1204
+ disabled: {
1205
+ type: BooleanConstructor;
1206
+ default: any;
1207
+ };
1208
+ current: NumberConstructor;
1209
+ defaultPageSize: NumberConstructor;
1210
+ pageSize: NumberConstructor;
1211
+ hideOnSinglePage: {
1212
+ type: BooleanConstructor;
1213
+ default: any;
1214
+ };
1215
+ showSizeChanger: {
1216
+ type: BooleanConstructor;
1217
+ default: any;
1218
+ };
1219
+ pageSizeOptions: PropType<(string | number)[]>;
1220
+ buildOptionText: PropType<(opt: {
1221
+ value: any;
1222
+ }) => any>;
1223
+ showQuickJumper: {
1224
+ type: PropType<boolean | {
1225
+ goButton?: any;
1226
+ }>;
1227
+ default: boolean | {
1228
+ goButton?: any;
1229
+ };
1230
+ };
1231
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
1232
+ size: PropType<"small" | "default">;
1233
+ simple: {
1234
+ type: BooleanConstructor;
1235
+ default: any;
1236
+ };
1237
+ locale: ObjectConstructor;
1238
+ prefixCls: StringConstructor;
1239
+ selectPrefixCls: StringConstructor;
1240
+ totalBoundaryShowSizeChanger: NumberConstructor;
1241
+ selectComponentClass: StringConstructor;
1242
+ itemRender: PropType<(opt: {
1243
+ page: number;
1244
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
1245
+ originalElement: any;
1246
+ }) => any>;
1247
+ role: StringConstructor;
1248
+ responsive: BooleanConstructor;
1249
+ showLessItems: {
1250
+ type: BooleanConstructor;
1251
+ default: any;
1252
+ };
1253
+ onChange: PropType<(page: number, pageSize: number) => void>;
1254
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
1255
+ 'onUpdate:current': PropType<(current: number) => void>;
1256
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
1257
+ }>>>;
852
1258
  loading: boolean;
853
1259
  adaptive: boolean | {
854
1260
  width?: boolean;
@@ -861,11 +1267,11 @@ onChange?: (current: number) => void;
861
1267
  };
862
1268
  }>;
863
1269
 
864
- declare interface BaseSheetComponentProps<PartialDrillDown = unknown, Header = unknown> {
1270
+ declare interface BaseSheetComponentProps<PartialDrillDown = unknown, Header = unknown, Pagination = unknown> {
865
1271
  sheetType?: SheetType;
866
- spreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options) => SpreadSheet;
1272
+ spreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<Element | string, Pagination>) => SpreadSheet;
867
1273
  dataCfg: S2DataConfig;
868
- options?: S2Options;
1274
+ options?: S2Options<Element | string, Pagination>;
869
1275
  loading?: boolean;
870
1276
  partDrillDown?: PartialDrillDown;
871
1277
  adaptive?: Adaptive;
@@ -938,6 +1344,7 @@ declare interface BaseSheetComponentProps<PartialDrillDown = unknown, Header = u
938
1344
  }) => void;
939
1345
  /** @deprecated 已废弃, 请使用 S2Event.GLOBAL_SCROLL 代替 */
940
1346
  onLayoutCellScroll?: (position: CellScrollPosition) => void;
1347
+ onLayoutCollapseRows?: (data: CollapsedRowsType) => void;
941
1348
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType) => void;
942
1349
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => void;
943
1350
  onLayoutColsExpanded?: (node: Node_2) => void;
@@ -971,12 +1378,16 @@ declare interface BaseSheetComponentProps<PartialDrillDown = unknown, Header = u
971
1378
  onKeyBoardUp?: (event: KeyboardEvent) => void;
972
1379
  onCopied?: (copyData: string) => void;
973
1380
  onActionIconHover?: (event: GEvent) => void;
1381
+ onActionIconHoverOff?: (event: GEvent) => void;
974
1382
  onActionIconClick?: (event: GEvent) => void;
975
1383
  onContextMenu?: (event: GEvent) => void;
976
1384
  onClick?: (event: GEvent) => void;
1385
+ onHover?: (event: GEvent) => void;
977
1386
  onDoubleClick?: (event: GEvent) => void;
978
1387
  onMouseHover?: (event: GEvent) => void;
979
1388
  onMouseUp?: (event: MouseEvent) => void;
1389
+ onMouseDown?: (event: MouseEvent) => void;
1390
+ onMouseMove?: (event: MouseEvent) => void;
980
1391
  onSelected?: (cells: DataCell[]) => void;
981
1392
  onReset?: (event: KeyboardEvent) => void;
982
1393
  onLinkFieldJump?: (data: {
@@ -1018,6 +1429,12 @@ declare interface BaseTooltipConfig<T = TooltipContentType> {
1018
1429
  style?: CSS_2.Properties;
1019
1430
  }
1020
1431
 
1432
+ declare interface BrushSelection {
1433
+ data?: boolean;
1434
+ row?: boolean;
1435
+ col?: boolean;
1436
+ }
1437
+
1021
1438
  declare interface BulletTheme {
1022
1439
  progressBar: {
1023
1440
  widthPercent: number;
@@ -1088,6 +1505,14 @@ declare interface CellMeta_2 {
1088
1505
  [key: string]: unknown;
1089
1506
  }
1090
1507
 
1508
+ declare interface CellScrollOffset {
1509
+ deltaX?: number;
1510
+ deltaY?: number;
1511
+ offset?: number;
1512
+ offsetX: number;
1513
+ offsetY: number;
1514
+ }
1515
+
1091
1516
  declare interface CellScrollPosition_2 {
1092
1517
  scrollX: number;
1093
1518
  scrollY: number;
@@ -1130,6 +1555,10 @@ declare class ColCell extends HeaderCell {
1130
1555
  protected initCell(): void;
1131
1556
  protected drawBackgroundShape(): void;
1132
1557
  protected drawInteractiveBgShape(): void;
1558
+ /**
1559
+ * 绘制hover悬停,刷选的外框
1560
+ */
1561
+ protected drawInteractiveBorderShape(): void;
1133
1562
  protected getTextStyle(): TextTheme;
1134
1563
  protected getMaxTextWidth(): number;
1135
1564
  protected getIconPosition(): Point;
@@ -1416,6 +1845,7 @@ declare interface EmitterType {
1416
1845
  /** ================ Global ================ */
1417
1846
  [S2Event.GLOBAL_ACTION_ICON_CLICK]: CanvasEventHandler;
1418
1847
  [S2Event.GLOBAL_ACTION_ICON_HOVER]: CanvasEventHandler;
1848
+ [S2Event.GLOBAL_ACTION_ICON_HOVER_OFF]: CanvasEventHandler;
1419
1849
  [S2Event.GLOBAL_COPIED]: (data: string) => void;
1420
1850
  [S2Event.GLOBAL_KEYBOARD_DOWN]: KeyboardEventHandler;
1421
1851
  [S2Event.GLOBAL_KEYBOARD_UP]: KeyboardEventHandler;
@@ -1427,7 +1857,7 @@ declare interface EmitterType {
1427
1857
  [S2Event.GLOBAL_CONTEXT_MENU]: CanvasEventHandler;
1428
1858
  [S2Event.GLOBAL_CLICK]: CanvasEventHandler;
1429
1859
  [S2Event.GLOBAL_DOUBLE_CLICK]: CanvasEventHandler;
1430
- [S2Event.GLOBAL_RESET]: EventHandler_3;
1860
+ [S2Event.GLOBAL_RESET]: EventHandler_2;
1431
1861
  [S2Event.GLOBAL_HOVER]: CanvasEventHandler;
1432
1862
  [S2Event.GLOBAL_SELECTED]: SelectedHandler;
1433
1863
  [S2Event.GLOBAL_SCROLL]: (position: CellScrollPosition_2) => void;
@@ -1463,6 +1893,7 @@ declare interface EmitterType {
1463
1893
  [S2Event.ROW_CELL_MOUSE_UP]: CanvasEventHandler;
1464
1894
  [S2Event.ROW_CELL_COLLAPSE_TREE_ROWS]: (data: RowCellCollapseTreeRowsType) => void;
1465
1895
  [S2Event.ROW_CELL_SCROLL]: (position: CellScrollPosition_2) => void;
1896
+ [S2Event.ROW_CELL_BRUSH_SELECTION]: (cells: RowCell[]) => void;
1466
1897
  /** ================ Col Cell ================ */
1467
1898
  [S2Event.COL_CELL_MOUSE_DOWN]: CanvasEventHandler;
1468
1899
  [S2Event.COL_CELL_MOUSE_MOVE]: CanvasEventHandler;
@@ -1471,6 +1902,7 @@ declare interface EmitterType {
1471
1902
  [S2Event.COL_CELL_DOUBLE_CLICK]: CanvasEventHandler;
1472
1903
  [S2Event.COL_CELL_CONTEXT_MENU]: CanvasEventHandler;
1473
1904
  [S2Event.COL_CELL_MOUSE_UP]: CanvasEventHandler;
1905
+ [S2Event.COL_CELL_BRUSH_SELECTION]: (cells: ColCell[]) => void;
1474
1906
  /** ================ Corner Cell ================ */
1475
1907
  [S2Event.CORNER_CELL_MOUSE_MOVE]: CanvasEventHandler;
1476
1908
  [S2Event.CORNER_CELL_MOUSE_DOWN]: CanvasEventHandler;
@@ -1518,7 +1950,7 @@ declare interface EmitterType {
1518
1950
  declare class EventController {
1519
1951
  spreadsheet: SpreadSheet_2;
1520
1952
  private target;
1521
- canvasEventHandlers: EventHandler_2[];
1953
+ canvasEventHandlers: EventHandler[];
1522
1954
  s2EventHandlers: S2EventHandler[];
1523
1955
  domEventListeners: EventListener_2[];
1524
1956
  isCanvasEffect: boolean;
@@ -1538,6 +1970,7 @@ declare class EventController {
1538
1970
  private resetResizeArea;
1539
1971
  private onCanvasMousedown;
1540
1972
  private onCanvasMousemove;
1973
+ private hasBrushSelectionIntercepts;
1541
1974
  private onCanvasMouseup;
1542
1975
  private onCanvasClick;
1543
1976
  private onCanvasDoubleClick;
@@ -1552,17 +1985,17 @@ declare class EventController {
1552
1985
  }
1553
1986
 
1554
1987
  declare interface EventHandler {
1555
- target: IElement;
1556
- type: keyof HTMLElementEventMap;
1557
- handler: (e: MouseEvent | TouchEvent) => void;
1558
- }
1559
-
1560
- declare interface EventHandler_2 {
1561
1988
  type: string;
1562
1989
  handler: (event: Event_2) => void;
1563
1990
  }
1564
1991
 
1565
- declare type EventHandler_3 = (event: Event) => void;
1992
+ declare type EventHandler_2 = (event: Event) => void;
1993
+
1994
+ declare interface EventHandler_3 {
1995
+ target: IElement;
1996
+ type: keyof HTMLElementEventMap;
1997
+ handler: (e: MouseEvent | TouchEvent) => void;
1998
+ }
1566
1999
 
1567
2000
  declare interface EventListener_2 {
1568
2001
  target: EventTarget;
@@ -1706,34 +2139,46 @@ declare class HdAdapter {
1706
2139
  declare interface HeaderActionIcon {
1707
2140
  iconNames: string[];
1708
2141
  belongsCell: Omit<CellTypes, 'dataCell'>;
1709
- defaultHide?: boolean;
1710
- displayCondition?: (mete: Node_2_2) => boolean;
1711
- action?: (headerActionIconProps: HeaderActionIconProps) => void;
2142
+ defaultHide?: boolean | ((meta: Node_2_2, iconName: string) => boolean);
2143
+ displayCondition?: (mete: Node_2_2, iconName: string) => boolean;
2144
+ /**
2145
+ * 点击后的执行函数
2146
+ * @deprecated 使用 onClick 代替
2147
+ */
2148
+ action?: (headerIconClickParams: HeaderIconClickParams) => void;
2149
+ onClick?: (headerIconClickParams: HeaderIconClickParams) => void;
2150
+ onHover?: (headerIconHoverParams: HeaderIconHoverParams) => void;
1712
2151
  }
1713
2152
 
1714
2153
  declare interface HeaderActionIconOptions {
1715
2154
  iconName: string;
1716
2155
  x: number;
1717
2156
  y: number;
1718
- action: (props: HeaderActionIconProps) => void;
2157
+ /** @deprecated 使用 onClick 代替 */
2158
+ action: (props: HeaderIconClickParams) => void;
2159
+ onClick: (headerIconClickParams: HeaderIconClickParams) => void;
2160
+ onHover: (headerIconHoverParams: HeaderIconHoverParams) => void;
1719
2161
  defaultHide?: boolean;
1720
2162
  }
1721
2163
 
1722
- declare interface HeaderActionIconProps {
1723
- iconName: string;
1724
- meta: Node_2_2;
1725
- event?: Event_2;
1726
- }
1727
-
1728
2164
  declare abstract class HeaderCell extends BaseCell<Node_2_2> {
1729
2165
  protected headerConfig: BaseHeaderConfig;
1730
2166
  protected treeIcon: GuiIcon | undefined;
1731
2167
  protected treeLeafNodeAlignDot: IShape | undefined;
1732
2168
  protected actionIcons: GuiIcon[];
2169
+ protected hasDefaultHiddenIcon: boolean;
1733
2170
  protected handleRestOptions(...[headerConfig]: [BaseHeaderConfig]): void;
1734
2171
  protected initCell(): void;
2172
+ protected getInteractiveBorderShapeStyle(border: number): {
2173
+ x: number;
2174
+ y: number;
2175
+ width: number;
2176
+ height: number;
2177
+ };
1735
2178
  protected getFormattedFieldValue(): FormatResult;
1736
- protected showActionIcons(actionIconCfg: HeaderActionIcon): boolean;
2179
+ /**
2180
+ * 获取操作 icons
2181
+ */
1737
2182
  protected getActionIconCfg(): HeaderActionIcon;
1738
2183
  protected showSortIcon(): boolean;
1739
2184
  protected getActionIconsCount(): number;
@@ -1754,6 +2199,16 @@ declare abstract class HeaderCell extends BaseCell<Node_2_2> {
1754
2199
  isMeasureField(): boolean;
1755
2200
  }
1756
2201
 
2202
+ declare interface HeaderIconClickParams {
2203
+ iconName: string;
2204
+ meta: Node_2_2;
2205
+ event?: Event_2;
2206
+ }
2207
+
2208
+ declare interface HeaderIconHoverParams extends HeaderIconClickParams {
2209
+ hovering: boolean;
2210
+ }
2211
+
1757
2212
  declare interface HiddenColumnsInfo_2 {
1758
2213
  hideColumnNodes: Node_2_2[];
1759
2214
  displaySiblingNode: {
@@ -1831,7 +2286,7 @@ declare interface InteractionOptions {
1831
2286
  hiddenColumnFields?: string[];
1832
2287
  scrollSpeedRatio?: ScrollSpeedRatio;
1833
2288
  resize?: boolean | ResizeInteractionOptions;
1834
- brushSelection?: boolean;
2289
+ brushSelection?: boolean | BrushSelection;
1835
2290
  multiSelection?: boolean;
1836
2291
  rangeSelection?: boolean;
1837
2292
  selectedCellMove?: boolean;
@@ -1853,6 +2308,8 @@ declare interface InteractionStateInfo {
1853
2308
  interactedCells?: S2CellType[];
1854
2309
  nodes?: Node_2_2[];
1855
2310
  force?: boolean;
2311
+ /** 交互行为改变后,会被更新和重绘的单元格回调 */
2312
+ onUpdateCells?: OnUpdateCells;
1856
2313
  }
1857
2314
 
1858
2315
  declare enum InteractionStateName {
@@ -1876,12 +2333,14 @@ declare interface InteractionStateTheme {
1876
2333
  opacity?: number;
1877
2334
  }
1878
2335
 
1879
- declare type Intercept = InterceptType.HOVER | InterceptType.CLICK | InterceptType.BRUSH_SELECTION | InterceptType.MULTI_SELECTION | InterceptType.RESIZE;
2336
+ declare type Intercept = InterceptType[keyof InterceptType];
1880
2337
 
1881
2338
  declare enum InterceptType {
1882
2339
  HOVER = "hover",
1883
2340
  CLICK = "click",
1884
2341
  BRUSH_SELECTION = "brushSelection",
2342
+ ROW_BRUSH_SELECTION = "rowBrushSelection",
2343
+ COL_BRUSH_SELECTION = "colBrushSelection",
1885
2344
  MULTI_SELECTION = "multiSelection",
1886
2345
  RESIZE = "resize"
1887
2346
  }
@@ -2136,6 +2595,8 @@ declare interface OffsetConfig {
2136
2595
  };
2137
2596
  }
2138
2597
 
2598
+ declare type OnUpdateCells = (root: RootInteraction, defaultOnUpdateCells: () => void) => void;
2599
+
2139
2600
  declare interface Padding {
2140
2601
  top?: number;
2141
2602
  right?: number;
@@ -2143,11 +2604,11 @@ declare interface Padding {
2143
2604
  left?: number;
2144
2605
  }
2145
2606
 
2146
- declare type Pagination = {
2607
+ declare type Pagination<T = unknown> = {
2147
2608
  pageSize: number;
2148
2609
  current: number;
2149
2610
  total?: number;
2150
- };
2611
+ } & T;
2151
2612
 
2152
2613
  declare interface Palette extends PaletteMeta {
2153
2614
  basicColors: string[];
@@ -2234,20 +2695,188 @@ loading: BooleanConstructor;
2234
2695
  partDrillDown: ObjectConstructor;
2235
2696
  header: ObjectConstructor;
2236
2697
  options: {
2237
- type: PropType<S2Options<string | Element>>;
2238
- default: S2Options<string | Element>;
2698
+ type: PropType<S2Options<string | Element, Partial<ExtractPropTypes< {
2699
+ total: NumberConstructor;
2700
+ defaultCurrent: NumberConstructor;
2701
+ disabled: {
2702
+ type: BooleanConstructor;
2703
+ default: any;
2704
+ };
2705
+ current: NumberConstructor;
2706
+ defaultPageSize: NumberConstructor;
2707
+ pageSize: NumberConstructor;
2708
+ hideOnSinglePage: {
2709
+ type: BooleanConstructor;
2710
+ default: any;
2711
+ };
2712
+ showSizeChanger: {
2713
+ type: BooleanConstructor;
2714
+ default: any;
2715
+ };
2716
+ pageSizeOptions: PropType<(string | number)[]>;
2717
+ buildOptionText: PropType<(opt: {
2718
+ value: any;
2719
+ }) => any>;
2720
+ showQuickJumper: {
2721
+ type: PropType<boolean | {
2722
+ goButton?: any;
2723
+ }>;
2724
+ default: boolean | {
2725
+ goButton?: any;
2726
+ };
2727
+ };
2728
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
2729
+ size: PropType<"small" | "default">;
2730
+ simple: {
2731
+ type: BooleanConstructor;
2732
+ default: any;
2733
+ };
2734
+ locale: ObjectConstructor;
2735
+ prefixCls: StringConstructor;
2736
+ selectPrefixCls: StringConstructor;
2737
+ totalBoundaryShowSizeChanger: NumberConstructor;
2738
+ selectComponentClass: StringConstructor;
2739
+ itemRender: PropType<(opt: {
2740
+ page: number;
2741
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
2742
+ originalElement: any;
2743
+ }) => any>;
2744
+ role: StringConstructor;
2745
+ responsive: BooleanConstructor;
2746
+ showLessItems: {
2747
+ type: BooleanConstructor;
2748
+ default: any;
2749
+ };
2750
+ onChange: PropType<(page: number, pageSize: number) => void>;
2751
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
2752
+ 'onUpdate:current': PropType<(current: number) => void>;
2753
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
2754
+ }>>>>;
2755
+ default: S2Options<string | Element, Partial<ExtractPropTypes< {
2756
+ total: NumberConstructor;
2757
+ defaultCurrent: NumberConstructor;
2758
+ disabled: {
2759
+ type: BooleanConstructor;
2760
+ default: any;
2761
+ };
2762
+ current: NumberConstructor;
2763
+ defaultPageSize: NumberConstructor;
2764
+ pageSize: NumberConstructor;
2765
+ hideOnSinglePage: {
2766
+ type: BooleanConstructor;
2767
+ default: any;
2768
+ };
2769
+ showSizeChanger: {
2770
+ type: BooleanConstructor;
2771
+ default: any;
2772
+ };
2773
+ pageSizeOptions: PropType<(string | number)[]>;
2774
+ buildOptionText: PropType<(opt: {
2775
+ value: any;
2776
+ }) => any>;
2777
+ showQuickJumper: {
2778
+ type: PropType<boolean | {
2779
+ goButton?: any;
2780
+ }>;
2781
+ default: boolean | {
2782
+ goButton?: any;
2783
+ };
2784
+ };
2785
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
2786
+ size: PropType<"small" | "default">;
2787
+ simple: {
2788
+ type: BooleanConstructor;
2789
+ default: any;
2790
+ };
2791
+ locale: ObjectConstructor;
2792
+ prefixCls: StringConstructor;
2793
+ selectPrefixCls: StringConstructor;
2794
+ totalBoundaryShowSizeChanger: NumberConstructor;
2795
+ selectComponentClass: StringConstructor;
2796
+ itemRender: PropType<(opt: {
2797
+ page: number;
2798
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
2799
+ originalElement: any;
2800
+ }) => any>;
2801
+ role: StringConstructor;
2802
+ responsive: BooleanConstructor;
2803
+ showLessItems: {
2804
+ type: BooleanConstructor;
2805
+ default: any;
2806
+ };
2807
+ onChange: PropType<(page: number, pageSize: number) => void>;
2808
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
2809
+ 'onUpdate:current': PropType<(current: number) => void>;
2810
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
2811
+ }>>>;
2239
2812
  };
2240
2813
  adaptive: {
2241
2814
  type: PropType<Adaptive>;
2242
2815
  default: Adaptive;
2243
2816
  };
2244
- onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element>) => SpreadSheet>;
2817
+ onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element, Partial<ExtractPropTypes< {
2818
+ total: NumberConstructor;
2819
+ defaultCurrent: NumberConstructor;
2820
+ disabled: {
2821
+ type: BooleanConstructor;
2822
+ default: any;
2823
+ };
2824
+ current: NumberConstructor;
2825
+ defaultPageSize: NumberConstructor;
2826
+ pageSize: NumberConstructor;
2827
+ hideOnSinglePage: {
2828
+ type: BooleanConstructor;
2829
+ default: any;
2830
+ };
2831
+ showSizeChanger: {
2832
+ type: BooleanConstructor;
2833
+ default: any;
2834
+ };
2835
+ pageSizeOptions: PropType<(string | number)[]>;
2836
+ buildOptionText: PropType<(opt: {
2837
+ value: any;
2838
+ }) => any>;
2839
+ showQuickJumper: {
2840
+ type: PropType<boolean | {
2841
+ goButton?: any;
2842
+ }>;
2843
+ default: boolean | {
2844
+ goButton?: any;
2845
+ };
2846
+ };
2847
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
2848
+ size: PropType<"small" | "default">;
2849
+ simple: {
2850
+ type: BooleanConstructor;
2851
+ default: any;
2852
+ };
2853
+ locale: ObjectConstructor;
2854
+ prefixCls: StringConstructor;
2855
+ selectPrefixCls: StringConstructor;
2856
+ totalBoundaryShowSizeChanger: NumberConstructor;
2857
+ selectComponentClass: StringConstructor;
2858
+ itemRender: PropType<(opt: {
2859
+ page: number;
2860
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
2861
+ originalElement: any;
2862
+ }) => any>;
2863
+ role: StringConstructor;
2864
+ responsive: BooleanConstructor;
2865
+ showLessItems: {
2866
+ type: BooleanConstructor;
2867
+ default: any;
2868
+ };
2869
+ onChange: PropType<(page: number, pageSize: number) => void>;
2870
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
2871
+ 'onUpdate:current': PropType<(current: number) => void>;
2872
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
2873
+ }>>>) => SpreadSheet>;
2245
2874
  onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet) => void>;
2246
2875
  }, {
2247
2876
  s2Ref: ShallowRef<SheetExpose>;
2248
- options: S2Options<string | Element>;
2877
+ options: S2Options<string | Element, unknown>;
2249
2878
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
2250
- spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element>) => SpreadSheet;
2879
+ spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element, unknown>) => SpreadSheet;
2251
2880
  getSpreadSheet: (spreadsheet: SpreadSheet) => void;
2252
2881
  sheetUpdate: SheetUpdateCallback;
2253
2882
  rowCellHover: (data: TargetCellInfo) => void;
@@ -2309,6 +2938,7 @@ total: number;
2309
2938
  current: number;
2310
2939
  }) => void;
2311
2940
  layoutCellScroll: (position: CellScrollPosition) => void;
2941
+ layoutCollapseRows: (data: CollapsedRowsType) => void;
2312
2942
  layoutAfterCollapseRows: (data: CollapsedRowsType) => void;
2313
2943
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
2314
2944
  layoutColsExpanded: (node: Node_2) => void;
@@ -2342,12 +2972,16 @@ keyBoardDown: (event: KeyboardEvent) => void;
2342
2972
  keyBoardUp: (event: KeyboardEvent) => void;
2343
2973
  copied: (copyData: string) => void;
2344
2974
  actionIconHover: (event: default_2) => void;
2975
+ actionIconHoverOff: (event: default_2) => void;
2345
2976
  actionIconClick: (event: default_2) => void;
2346
2977
  contextMenu: (event: default_2) => void;
2347
2978
  click: (event: default_2) => void;
2979
+ hover: (event: default_2) => void;
2348
2980
  doubleClick: (event: default_2) => void;
2349
2981
  mouseHover: (event: default_2) => void;
2350
2982
  mouseUp: (event: MouseEvent) => void;
2983
+ mouseDown: (event: MouseEvent) => void;
2984
+ mouseMove: (event: MouseEvent) => void;
2351
2985
  selected: (cells: DataCell[]) => void;
2352
2986
  reset: (event: KeyboardEvent) => void;
2353
2987
  linkFieldJump: (data: {
@@ -2373,14 +3007,182 @@ loading: BooleanConstructor;
2373
3007
  partDrillDown: ObjectConstructor;
2374
3008
  header: ObjectConstructor;
2375
3009
  options: {
2376
- type: PropType<S2Options<string | Element>>;
2377
- default: S2Options<string | Element>;
3010
+ type: PropType<S2Options<string | Element, Partial<ExtractPropTypes< {
3011
+ total: NumberConstructor;
3012
+ defaultCurrent: NumberConstructor;
3013
+ disabled: {
3014
+ type: BooleanConstructor;
3015
+ default: any;
3016
+ };
3017
+ current: NumberConstructor;
3018
+ defaultPageSize: NumberConstructor;
3019
+ pageSize: NumberConstructor;
3020
+ hideOnSinglePage: {
3021
+ type: BooleanConstructor;
3022
+ default: any;
3023
+ };
3024
+ showSizeChanger: {
3025
+ type: BooleanConstructor;
3026
+ default: any;
3027
+ };
3028
+ pageSizeOptions: PropType<(string | number)[]>;
3029
+ buildOptionText: PropType<(opt: {
3030
+ value: any;
3031
+ }) => any>;
3032
+ showQuickJumper: {
3033
+ type: PropType<boolean | {
3034
+ goButton?: any;
3035
+ }>;
3036
+ default: boolean | {
3037
+ goButton?: any;
3038
+ };
3039
+ };
3040
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
3041
+ size: PropType<"small" | "default">;
3042
+ simple: {
3043
+ type: BooleanConstructor;
3044
+ default: any;
3045
+ };
3046
+ locale: ObjectConstructor;
3047
+ prefixCls: StringConstructor;
3048
+ selectPrefixCls: StringConstructor;
3049
+ totalBoundaryShowSizeChanger: NumberConstructor;
3050
+ selectComponentClass: StringConstructor;
3051
+ itemRender: PropType<(opt: {
3052
+ page: number;
3053
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
3054
+ originalElement: any;
3055
+ }) => any>;
3056
+ role: StringConstructor;
3057
+ responsive: BooleanConstructor;
3058
+ showLessItems: {
3059
+ type: BooleanConstructor;
3060
+ default: any;
3061
+ };
3062
+ onChange: PropType<(page: number, pageSize: number) => void>;
3063
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
3064
+ 'onUpdate:current': PropType<(current: number) => void>;
3065
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
3066
+ }>>>>;
3067
+ default: S2Options<string | Element, Partial<ExtractPropTypes< {
3068
+ total: NumberConstructor;
3069
+ defaultCurrent: NumberConstructor;
3070
+ disabled: {
3071
+ type: BooleanConstructor;
3072
+ default: any;
3073
+ };
3074
+ current: NumberConstructor;
3075
+ defaultPageSize: NumberConstructor;
3076
+ pageSize: NumberConstructor;
3077
+ hideOnSinglePage: {
3078
+ type: BooleanConstructor;
3079
+ default: any;
3080
+ };
3081
+ showSizeChanger: {
3082
+ type: BooleanConstructor;
3083
+ default: any;
3084
+ };
3085
+ pageSizeOptions: PropType<(string | number)[]>;
3086
+ buildOptionText: PropType<(opt: {
3087
+ value: any;
3088
+ }) => any>;
3089
+ showQuickJumper: {
3090
+ type: PropType<boolean | {
3091
+ goButton?: any;
3092
+ }>;
3093
+ default: boolean | {
3094
+ goButton?: any;
3095
+ };
3096
+ };
3097
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
3098
+ size: PropType<"small" | "default">;
3099
+ simple: {
3100
+ type: BooleanConstructor;
3101
+ default: any;
3102
+ };
3103
+ locale: ObjectConstructor;
3104
+ prefixCls: StringConstructor;
3105
+ selectPrefixCls: StringConstructor;
3106
+ totalBoundaryShowSizeChanger: NumberConstructor;
3107
+ selectComponentClass: StringConstructor;
3108
+ itemRender: PropType<(opt: {
3109
+ page: number;
3110
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
3111
+ originalElement: any;
3112
+ }) => any>;
3113
+ role: StringConstructor;
3114
+ responsive: BooleanConstructor;
3115
+ showLessItems: {
3116
+ type: BooleanConstructor;
3117
+ default: any;
3118
+ };
3119
+ onChange: PropType<(page: number, pageSize: number) => void>;
3120
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
3121
+ 'onUpdate:current': PropType<(current: number) => void>;
3122
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
3123
+ }>>>;
2378
3124
  };
2379
3125
  adaptive: {
2380
3126
  type: PropType<Adaptive>;
2381
3127
  default: Adaptive;
2382
3128
  };
2383
- onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element>) => SpreadSheet>;
3129
+ onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element, Partial<ExtractPropTypes< {
3130
+ total: NumberConstructor;
3131
+ defaultCurrent: NumberConstructor;
3132
+ disabled: {
3133
+ type: BooleanConstructor;
3134
+ default: any;
3135
+ };
3136
+ current: NumberConstructor;
3137
+ defaultPageSize: NumberConstructor;
3138
+ pageSize: NumberConstructor;
3139
+ hideOnSinglePage: {
3140
+ type: BooleanConstructor;
3141
+ default: any;
3142
+ };
3143
+ showSizeChanger: {
3144
+ type: BooleanConstructor;
3145
+ default: any;
3146
+ };
3147
+ pageSizeOptions: PropType<(string | number)[]>;
3148
+ buildOptionText: PropType<(opt: {
3149
+ value: any;
3150
+ }) => any>;
3151
+ showQuickJumper: {
3152
+ type: PropType<boolean | {
3153
+ goButton?: any;
3154
+ }>;
3155
+ default: boolean | {
3156
+ goButton?: any;
3157
+ };
3158
+ };
3159
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
3160
+ size: PropType<"small" | "default">;
3161
+ simple: {
3162
+ type: BooleanConstructor;
3163
+ default: any;
3164
+ };
3165
+ locale: ObjectConstructor;
3166
+ prefixCls: StringConstructor;
3167
+ selectPrefixCls: StringConstructor;
3168
+ totalBoundaryShowSizeChanger: NumberConstructor;
3169
+ selectComponentClass: StringConstructor;
3170
+ itemRender: PropType<(opt: {
3171
+ page: number;
3172
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
3173
+ originalElement: any;
3174
+ }) => any>;
3175
+ role: StringConstructor;
3176
+ responsive: BooleanConstructor;
3177
+ showLessItems: {
3178
+ type: BooleanConstructor;
3179
+ default: any;
3180
+ };
3181
+ onChange: PropType<(page: number, pageSize: number) => void>;
3182
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
3183
+ 'onUpdate:current': PropType<(current: number) => void>;
3184
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
3185
+ }>>>) => SpreadSheet>;
2384
3186
  onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet) => void>;
2385
3187
  }>> & {
2386
3188
  onSheetUpdate?: (params: S2RenderOptions) => any;
@@ -2443,6 +3245,7 @@ total: number;
2443
3245
  current: number;
2444
3246
  }) => any;
2445
3247
  onLayoutCellScroll?: (position: CellScrollPosition) => any;
3248
+ onLayoutCollapseRows?: (data: CollapsedRowsType) => any;
2446
3249
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType) => any;
2447
3250
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
2448
3251
  onLayoutColsExpanded?: (node: Node_2) => any;
@@ -2476,12 +3279,16 @@ onKeyBoardDown?: (event: KeyboardEvent) => any;
2476
3279
  onKeyBoardUp?: (event: KeyboardEvent) => any;
2477
3280
  onCopied?: (copyData: string) => any;
2478
3281
  onActionIconHover?: (event: default_2) => any;
3282
+ onActionIconHoverOff?: (event: default_2) => any;
2479
3283
  onActionIconClick?: (event: default_2) => any;
2480
3284
  onContextMenu?: (event: default_2) => any;
2481
3285
  onClick?: (event: default_2) => any;
3286
+ onHover?: (event: default_2) => any;
2482
3287
  onDoubleClick?: (event: default_2) => any;
2483
3288
  onMouseHover?: (event: default_2) => any;
2484
3289
  onMouseUp?: (event: MouseEvent) => any;
3290
+ onMouseDown?: (event: MouseEvent) => any;
3291
+ onMouseMove?: (event: MouseEvent) => any;
2485
3292
  onSelected?: (cells: DataCell[]) => any;
2486
3293
  onReset?: (event: KeyboardEvent) => any;
2487
3294
  onLinkFieldJump?: (data: {
@@ -2489,10 +3296,66 @@ key: string;
2489
3296
  record: Data;
2490
3297
  }) => any;
2491
3298
  onScroll?: (position: CellScrollPosition) => any;
2492
- onSpreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element>) => any;
3299
+ onSpreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<string | Element, unknown>) => any;
2493
3300
  onGetSpreadSheet?: (spreadsheet: SpreadSheet) => any;
2494
3301
  }, {
2495
- options: S2Options<string | Element>;
3302
+ options: S2Options<string | Element, Partial<ExtractPropTypes< {
3303
+ total: NumberConstructor;
3304
+ defaultCurrent: NumberConstructor;
3305
+ disabled: {
3306
+ type: BooleanConstructor;
3307
+ default: any;
3308
+ };
3309
+ current: NumberConstructor;
3310
+ defaultPageSize: NumberConstructor;
3311
+ pageSize: NumberConstructor;
3312
+ hideOnSinglePage: {
3313
+ type: BooleanConstructor;
3314
+ default: any;
3315
+ };
3316
+ showSizeChanger: {
3317
+ type: BooleanConstructor;
3318
+ default: any;
3319
+ };
3320
+ pageSizeOptions: PropType<(string | number)[]>;
3321
+ buildOptionText: PropType<(opt: {
3322
+ value: any;
3323
+ }) => any>;
3324
+ showQuickJumper: {
3325
+ type: PropType<boolean | {
3326
+ goButton?: any;
3327
+ }>;
3328
+ default: boolean | {
3329
+ goButton?: any;
3330
+ };
3331
+ };
3332
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
3333
+ size: PropType<"small" | "default">;
3334
+ simple: {
3335
+ type: BooleanConstructor;
3336
+ default: any;
3337
+ };
3338
+ locale: ObjectConstructor;
3339
+ prefixCls: StringConstructor;
3340
+ selectPrefixCls: StringConstructor;
3341
+ totalBoundaryShowSizeChanger: NumberConstructor;
3342
+ selectComponentClass: StringConstructor;
3343
+ itemRender: PropType<(opt: {
3344
+ page: number;
3345
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
3346
+ originalElement: any;
3347
+ }) => any>;
3348
+ role: StringConstructor;
3349
+ responsive: BooleanConstructor;
3350
+ showLessItems: {
3351
+ type: BooleanConstructor;
3352
+ default: any;
3353
+ };
3354
+ onChange: PropType<(page: number, pageSize: number) => void>;
3355
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
3356
+ 'onUpdate:current': PropType<(current: number) => void>;
3357
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
3358
+ }>>>;
2496
3359
  loading: boolean;
2497
3360
  adaptive: boolean | {
2498
3361
  width?: boolean;
@@ -2636,6 +3499,7 @@ declare class RootInteraction {
2636
3499
  mergeCells: (cellsInfo?: MergedCellInfo[], hideData?: boolean) => void;
2637
3500
  unmergeCell: (removedCells: MergedCell) => void;
2638
3501
  hideColumns(hiddenColumnFields?: string[], forceRender?: boolean): void;
3502
+ private getBrushSelectionInfo;
2639
3503
  private getDefaultInteractions;
2640
3504
  private registerInteractions;
2641
3505
  private registerEventController;
@@ -2659,6 +3523,10 @@ declare class RowCell extends HeaderCell {
2659
3523
  destroy(): void;
2660
3524
  protected initCell(): void;
2661
3525
  protected drawBackgroundShape(): void;
3526
+ /**
3527
+ * 绘制hover悬停,刷选的外框
3528
+ */
3529
+ protected drawInteractiveBorderShape(): void;
2662
3530
  protected drawInteractiveBgShape(): void;
2663
3531
  protected showTreeIcon(): boolean;
2664
3532
  protected showTreeLeafNodeAlignDot(): boolean;
@@ -2723,7 +3591,7 @@ declare interface RowHeaderConfig extends BaseHeaderConfig {
2723
3591
  seriesNumberWidth: number;
2724
3592
  }
2725
3593
 
2726
- declare interface S2BasicOptions<T = Element | string> {
3594
+ declare interface S2BasicOptions<T = Element | string, P = unknown> {
2727
3595
  width?: number;
2728
3596
  height?: number;
2729
3597
  debug?: boolean;
@@ -2732,7 +3600,7 @@ declare interface S2BasicOptions<T = Element | string> {
2732
3600
  totals?: Totals;
2733
3601
  tooltip?: Tooltip<T>;
2734
3602
  interaction?: InteractionOptions;
2735
- pagination?: Pagination;
3603
+ pagination?: Pagination<P>;
2736
3604
  frozenRowHeader?: boolean;
2737
3605
  showSeriesNumber?: boolean;
2738
3606
  showDefaultHeaderActionIcon?: boolean;
@@ -2786,6 +3654,7 @@ declare enum S2Event {
2786
3654
  ROW_CELL_MOUSE_MOVE = "row-cell:mouse-move",
2787
3655
  ROW_CELL_COLLAPSE_TREE_ROWS = "row-cell:collapsed-tree-rows",
2788
3656
  ROW_CELL_SCROLL = "row-cell:scroll",
3657
+ ROW_CELL_BRUSH_SELECTION = "row-cell:brush-selection",
2789
3658
  /** ================ Col Cell ================ */
2790
3659
  COL_CELL_HOVER = "col-cell:hover",
2791
3660
  COL_CELL_CLICK = "col-cell:click",
@@ -2794,6 +3663,7 @@ declare enum S2Event {
2794
3663
  COL_CELL_MOUSE_DOWN = "col-cell:mouse-down",
2795
3664
  COL_CELL_MOUSE_UP = "col-cell:mouse-up",
2796
3665
  COL_CELL_MOUSE_MOVE = "col-cell:mouse-move",
3666
+ COL_CELL_BRUSH_SELECTION = "col-cell:brush-selection",
2797
3667
  /** ================ Data Cell ================ */
2798
3668
  DATA_CELL_HOVER = "data-cell:hover",
2799
3669
  DATA_CELL_CLICK = "data-cell:click",
@@ -2859,6 +3729,7 @@ declare enum S2Event {
2859
3729
  GLOBAL_MOUSE_MOVE = "global:mouse-move",
2860
3730
  GLOBAL_ACTION_ICON_CLICK = "global:action-icon-click",
2861
3731
  GLOBAL_ACTION_ICON_HOVER = "global:action-icon-hover",
3732
+ GLOBAL_ACTION_ICON_HOVER_OFF = "global:action-icon-hover-off",
2862
3733
  GLOBAL_CONTEXT_MENU = "global:context-menu",
2863
3734
  GLOBAL_CLICK = "global:click",
2864
3735
  GLOBAL_DOUBLE_CLICK = "global:double-click",
@@ -2876,7 +3747,7 @@ declare interface S2EventHandler {
2876
3747
 
2877
3748
  declare type S2MountContainer_2 = string | Element;
2878
3749
 
2879
- declare interface S2Options_2<T = Element | string> extends S2BasicOptions<T>, S2TableSheetOptions, S2PivotSheetOptions {
3750
+ declare interface S2Options_2<T = Element | string, P = unknown> extends S2BasicOptions<T, P>, S2TableSheetOptions, S2PivotSheetOptions {
2880
3751
  dataSet?: (spreadsheet: SpreadSheet_2) => BaseDataSet_2;
2881
3752
  }
2882
3753
 
@@ -2904,11 +3775,6 @@ declare interface S2Theme extends CellThemes {
2904
3775
  background?: Background;
2905
3776
  }
2906
3777
 
2907
- declare interface S2WheelEvent extends WheelEvent {
2908
- layerX: number;
2909
- layerY: number;
2910
- }
2911
-
2912
3778
  declare class ScrollBar extends Group {
2913
3779
  isHorizontal: boolean;
2914
3780
  trackLen: number;
@@ -2927,19 +3793,16 @@ declare class ScrollBar extends Group {
2927
3793
  private eventHandlers;
2928
3794
  private scrollFrameId;
2929
3795
  constructor(scrollBarCfg: ScrollBarCfg);
2930
- getCoordinates: () => {
2931
- from: string;
2932
- to: string;
2933
- };
3796
+ private getCoordinatesName;
2934
3797
  /**
2935
- * 当前滑块滑动的位置 0 ~ 1
3798
+ * Antv/g 4.x 版本计算 bbox 有bug, 实际渲染的宽度会比给定的宽度大, 需要对其做修正
3799
+ * 详情: https://github.com/antvis/S2/pull/1566/files#diff-3f08348041906ddf1e4f094bfe2ac32b35ff668918d3fbb952e9227ae462cc08R52
2936
3800
  */
2937
- current: () => number;
3801
+ private getCoordinatesWithBBoxExtraPadding;
2938
3802
  /**
2939
- * 更新滑道长度
2940
- * @param newTrackLen 新的滑块长度
3803
+ * 当前滑块滑动的位置 0 ~ 1
2941
3804
  */
2942
- updateTrackLen: (newTrackLen: number) => void;
3805
+ current: () => number;
2943
3806
  /**
2944
3807
  * 更新滑块长度
2945
3808
  * @param newThumbLen 新的滑道长度
@@ -2957,7 +3820,7 @@ declare class ScrollBar extends Group {
2957
3820
  onlyUpdateThumbOffset: (offset: number) => void;
2958
3821
  emitScrollChange: (offset: number, updateThumbOffset?: boolean) => void;
2959
3822
  protected addEventListener: (target: EventTarget, eventType: keyof HTMLElementEventMap, callback: EventListenerOrEventListenerObject) => EventListenerReturn;
2960
- protected addEvent: (target: EventHandler['target'], type: EventHandler['type'], handler: EventHandler['handler']) => void;
3823
+ protected addEvent: (target: EventHandler_3['target'], type: EventHandler_3['type'], handler: EventHandler_3['handler']) => void;
2961
3824
  private initScrollBar;
2962
3825
  private createScrollBarGroup;
2963
3826
  private createTrackShape;
@@ -3040,7 +3903,7 @@ declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
3040
3903
  private getTextPadding;
3041
3904
  }
3042
3905
 
3043
- export declare const SheetComponent: DefineComponent<GetInitProps<BaseSheetComponentProps<PartDrillDown, unknown>, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconClick" | "onContextMenu" | "onClick" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">, {
3906
+ export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">, {
3044
3907
  s2Ref: ShallowRef<SheetExpose>;
3045
3908
  sheetType: ComputedRef<DefineComponent< {
3046
3909
  sheetType: PropType<SheetType>;
@@ -3060,20 +3923,188 @@ loading: BooleanConstructor;
3060
3923
  partDrillDown: ObjectConstructor;
3061
3924
  header: ObjectConstructor;
3062
3925
  options: {
3063
- type: PropType<S2Options_2<string | Element>>;
3064
- default: S2Options_2<string | Element>;
3926
+ type: PropType<S2Options_2<string | Element, Partial<ExtractPropTypes< {
3927
+ total: NumberConstructor;
3928
+ defaultCurrent: NumberConstructor;
3929
+ disabled: {
3930
+ type: BooleanConstructor;
3931
+ default: any;
3932
+ };
3933
+ current: NumberConstructor;
3934
+ defaultPageSize: NumberConstructor;
3935
+ pageSize: NumberConstructor;
3936
+ hideOnSinglePage: {
3937
+ type: BooleanConstructor;
3938
+ default: any;
3939
+ };
3940
+ showSizeChanger: {
3941
+ type: BooleanConstructor;
3942
+ default: any;
3943
+ };
3944
+ pageSizeOptions: PropType<(string | number)[]>;
3945
+ buildOptionText: PropType<(opt: {
3946
+ value: any;
3947
+ }) => any>;
3948
+ showQuickJumper: {
3949
+ type: PropType<boolean | {
3950
+ goButton?: any;
3951
+ }>;
3952
+ default: boolean | {
3953
+ goButton?: any;
3954
+ };
3955
+ };
3956
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
3957
+ size: PropType<"small" | "default">;
3958
+ simple: {
3959
+ type: BooleanConstructor;
3960
+ default: any;
3961
+ };
3962
+ locale: ObjectConstructor;
3963
+ prefixCls: StringConstructor;
3964
+ selectPrefixCls: StringConstructor;
3965
+ totalBoundaryShowSizeChanger: NumberConstructor;
3966
+ selectComponentClass: StringConstructor;
3967
+ itemRender: PropType<(opt: {
3968
+ page: number;
3969
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
3970
+ originalElement: any;
3971
+ }) => any>;
3972
+ role: StringConstructor;
3973
+ responsive: BooleanConstructor;
3974
+ showLessItems: {
3975
+ type: BooleanConstructor;
3976
+ default: any;
3977
+ };
3978
+ onChange: PropType<(page: number, pageSize: number) => void>;
3979
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
3980
+ 'onUpdate:current': PropType<(current: number) => void>;
3981
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
3982
+ }>>>>;
3983
+ default: S2Options_2<string | Element, Partial<ExtractPropTypes< {
3984
+ total: NumberConstructor;
3985
+ defaultCurrent: NumberConstructor;
3986
+ disabled: {
3987
+ type: BooleanConstructor;
3988
+ default: any;
3989
+ };
3990
+ current: NumberConstructor;
3991
+ defaultPageSize: NumberConstructor;
3992
+ pageSize: NumberConstructor;
3993
+ hideOnSinglePage: {
3994
+ type: BooleanConstructor;
3995
+ default: any;
3996
+ };
3997
+ showSizeChanger: {
3998
+ type: BooleanConstructor;
3999
+ default: any;
4000
+ };
4001
+ pageSizeOptions: PropType<(string | number)[]>;
4002
+ buildOptionText: PropType<(opt: {
4003
+ value: any;
4004
+ }) => any>;
4005
+ showQuickJumper: {
4006
+ type: PropType<boolean | {
4007
+ goButton?: any;
4008
+ }>;
4009
+ default: boolean | {
4010
+ goButton?: any;
4011
+ };
4012
+ };
4013
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
4014
+ size: PropType<"small" | "default">;
4015
+ simple: {
4016
+ type: BooleanConstructor;
4017
+ default: any;
4018
+ };
4019
+ locale: ObjectConstructor;
4020
+ prefixCls: StringConstructor;
4021
+ selectPrefixCls: StringConstructor;
4022
+ totalBoundaryShowSizeChanger: NumberConstructor;
4023
+ selectComponentClass: StringConstructor;
4024
+ itemRender: PropType<(opt: {
4025
+ page: number;
4026
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
4027
+ originalElement: any;
4028
+ }) => any>;
4029
+ role: StringConstructor;
4030
+ responsive: BooleanConstructor;
4031
+ showLessItems: {
4032
+ type: BooleanConstructor;
4033
+ default: any;
4034
+ };
4035
+ onChange: PropType<(page: number, pageSize: number) => void>;
4036
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
4037
+ 'onUpdate:current': PropType<(current: number) => void>;
4038
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
4039
+ }>>>;
3065
4040
  };
3066
4041
  adaptive: {
3067
4042
  type: PropType<Adaptive>;
3068
4043
  default: Adaptive;
3069
4044
  };
3070
- onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element>) => SpreadSheet_2>;
4045
+ onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element, Partial<ExtractPropTypes< {
4046
+ total: NumberConstructor;
4047
+ defaultCurrent: NumberConstructor;
4048
+ disabled: {
4049
+ type: BooleanConstructor;
4050
+ default: any;
4051
+ };
4052
+ current: NumberConstructor;
4053
+ defaultPageSize: NumberConstructor;
4054
+ pageSize: NumberConstructor;
4055
+ hideOnSinglePage: {
4056
+ type: BooleanConstructor;
4057
+ default: any;
4058
+ };
4059
+ showSizeChanger: {
4060
+ type: BooleanConstructor;
4061
+ default: any;
4062
+ };
4063
+ pageSizeOptions: PropType<(string | number)[]>;
4064
+ buildOptionText: PropType<(opt: {
4065
+ value: any;
4066
+ }) => any>;
4067
+ showQuickJumper: {
4068
+ type: PropType<boolean | {
4069
+ goButton?: any;
4070
+ }>;
4071
+ default: boolean | {
4072
+ goButton?: any;
4073
+ };
4074
+ };
4075
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
4076
+ size: PropType<"small" | "default">;
4077
+ simple: {
4078
+ type: BooleanConstructor;
4079
+ default: any;
4080
+ };
4081
+ locale: ObjectConstructor;
4082
+ prefixCls: StringConstructor;
4083
+ selectPrefixCls: StringConstructor;
4084
+ totalBoundaryShowSizeChanger: NumberConstructor;
4085
+ selectComponentClass: StringConstructor;
4086
+ itemRender: PropType<(opt: {
4087
+ page: number;
4088
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
4089
+ originalElement: any;
4090
+ }) => any>;
4091
+ role: StringConstructor;
4092
+ responsive: BooleanConstructor;
4093
+ showLessItems: {
4094
+ type: BooleanConstructor;
4095
+ default: any;
4096
+ };
4097
+ onChange: PropType<(page: number, pageSize: number) => void>;
4098
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
4099
+ 'onUpdate:current': PropType<(current: number) => void>;
4100
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
4101
+ }>>>) => SpreadSheet_2>;
3071
4102
  onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet_2) => void>;
3072
4103
  }, {
3073
4104
  s2Ref: ShallowRef<SheetExpose>;
3074
- options: S2Options_2<string | Element>;
4105
+ options: S2Options_2<string | Element, unknown>;
3075
4106
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3076
- spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element>) => SpreadSheet_2;
4107
+ spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element, unknown>) => SpreadSheet_2;
3077
4108
  getSpreadSheet: (spreadsheet: SpreadSheet_2) => void;
3078
4109
  sheetUpdate: SheetUpdateCallback;
3079
4110
  rowCellHover: (data: TargetCellInfo_2) => void;
@@ -3135,6 +4166,7 @@ total: number;
3135
4166
  current: number;
3136
4167
  }) => void;
3137
4168
  layoutCellScroll: (position: CellScrollPosition_2) => void;
4169
+ layoutCollapseRows: (data: CollapsedRowsType_2) => void;
3138
4170
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
3139
4171
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
3140
4172
  layoutColsExpanded: (node: Node_2_2) => void;
@@ -3168,12 +4200,16 @@ keyBoardDown: (event: KeyboardEvent) => void;
3168
4200
  keyBoardUp: (event: KeyboardEvent) => void;
3169
4201
  copied: (copyData: string) => void;
3170
4202
  actionIconHover: (event: default_2) => void;
4203
+ actionIconHoverOff: (event: default_2) => void;
3171
4204
  actionIconClick: (event: default_2) => void;
3172
4205
  contextMenu: (event: default_2) => void;
3173
4206
  click: (event: default_2) => void;
4207
+ hover: (event: default_2) => void;
3174
4208
  doubleClick: (event: default_2) => void;
3175
4209
  mouseHover: (event: default_2) => void;
3176
4210
  mouseUp: (event: MouseEvent) => void;
4211
+ mouseDown: (event: MouseEvent) => void;
4212
+ mouseMove: (event: MouseEvent) => void;
3177
4213
  selected: (cells: DataCell_2[]) => void;
3178
4214
  reset: (event: KeyboardEvent) => void;
3179
4215
  linkFieldJump: (data: {
@@ -3199,14 +4235,182 @@ loading: BooleanConstructor;
3199
4235
  partDrillDown: ObjectConstructor;
3200
4236
  header: ObjectConstructor;
3201
4237
  options: {
3202
- type: PropType<S2Options_2<string | Element>>;
3203
- default: S2Options_2<string | Element>;
4238
+ type: PropType<S2Options_2<string | Element, Partial<ExtractPropTypes< {
4239
+ total: NumberConstructor;
4240
+ defaultCurrent: NumberConstructor;
4241
+ disabled: {
4242
+ type: BooleanConstructor;
4243
+ default: any;
4244
+ };
4245
+ current: NumberConstructor;
4246
+ defaultPageSize: NumberConstructor;
4247
+ pageSize: NumberConstructor;
4248
+ hideOnSinglePage: {
4249
+ type: BooleanConstructor;
4250
+ default: any;
4251
+ };
4252
+ showSizeChanger: {
4253
+ type: BooleanConstructor;
4254
+ default: any;
4255
+ };
4256
+ pageSizeOptions: PropType<(string | number)[]>;
4257
+ buildOptionText: PropType<(opt: {
4258
+ value: any;
4259
+ }) => any>;
4260
+ showQuickJumper: {
4261
+ type: PropType<boolean | {
4262
+ goButton?: any;
4263
+ }>;
4264
+ default: boolean | {
4265
+ goButton?: any;
4266
+ };
4267
+ };
4268
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
4269
+ size: PropType<"small" | "default">;
4270
+ simple: {
4271
+ type: BooleanConstructor;
4272
+ default: any;
4273
+ };
4274
+ locale: ObjectConstructor;
4275
+ prefixCls: StringConstructor;
4276
+ selectPrefixCls: StringConstructor;
4277
+ totalBoundaryShowSizeChanger: NumberConstructor;
4278
+ selectComponentClass: StringConstructor;
4279
+ itemRender: PropType<(opt: {
4280
+ page: number;
4281
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
4282
+ originalElement: any;
4283
+ }) => any>;
4284
+ role: StringConstructor;
4285
+ responsive: BooleanConstructor;
4286
+ showLessItems: {
4287
+ type: BooleanConstructor;
4288
+ default: any;
4289
+ };
4290
+ onChange: PropType<(page: number, pageSize: number) => void>;
4291
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
4292
+ 'onUpdate:current': PropType<(current: number) => void>;
4293
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
4294
+ }>>>>;
4295
+ default: S2Options_2<string | Element, Partial<ExtractPropTypes< {
4296
+ total: NumberConstructor;
4297
+ defaultCurrent: NumberConstructor;
4298
+ disabled: {
4299
+ type: BooleanConstructor;
4300
+ default: any;
4301
+ };
4302
+ current: NumberConstructor;
4303
+ defaultPageSize: NumberConstructor;
4304
+ pageSize: NumberConstructor;
4305
+ hideOnSinglePage: {
4306
+ type: BooleanConstructor;
4307
+ default: any;
4308
+ };
4309
+ showSizeChanger: {
4310
+ type: BooleanConstructor;
4311
+ default: any;
4312
+ };
4313
+ pageSizeOptions: PropType<(string | number)[]>;
4314
+ buildOptionText: PropType<(opt: {
4315
+ value: any;
4316
+ }) => any>;
4317
+ showQuickJumper: {
4318
+ type: PropType<boolean | {
4319
+ goButton?: any;
4320
+ }>;
4321
+ default: boolean | {
4322
+ goButton?: any;
4323
+ };
4324
+ };
4325
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
4326
+ size: PropType<"small" | "default">;
4327
+ simple: {
4328
+ type: BooleanConstructor;
4329
+ default: any;
4330
+ };
4331
+ locale: ObjectConstructor;
4332
+ prefixCls: StringConstructor;
4333
+ selectPrefixCls: StringConstructor;
4334
+ totalBoundaryShowSizeChanger: NumberConstructor;
4335
+ selectComponentClass: StringConstructor;
4336
+ itemRender: PropType<(opt: {
4337
+ page: number;
4338
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
4339
+ originalElement: any;
4340
+ }) => any>;
4341
+ role: StringConstructor;
4342
+ responsive: BooleanConstructor;
4343
+ showLessItems: {
4344
+ type: BooleanConstructor;
4345
+ default: any;
4346
+ };
4347
+ onChange: PropType<(page: number, pageSize: number) => void>;
4348
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
4349
+ 'onUpdate:current': PropType<(current: number) => void>;
4350
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
4351
+ }>>>;
3204
4352
  };
3205
4353
  adaptive: {
3206
4354
  type: PropType<Adaptive>;
3207
4355
  default: Adaptive;
3208
4356
  };
3209
- onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element>) => SpreadSheet_2>;
4357
+ onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element, Partial<ExtractPropTypes< {
4358
+ total: NumberConstructor;
4359
+ defaultCurrent: NumberConstructor;
4360
+ disabled: {
4361
+ type: BooleanConstructor;
4362
+ default: any;
4363
+ };
4364
+ current: NumberConstructor;
4365
+ defaultPageSize: NumberConstructor;
4366
+ pageSize: NumberConstructor;
4367
+ hideOnSinglePage: {
4368
+ type: BooleanConstructor;
4369
+ default: any;
4370
+ };
4371
+ showSizeChanger: {
4372
+ type: BooleanConstructor;
4373
+ default: any;
4374
+ };
4375
+ pageSizeOptions: PropType<(string | number)[]>;
4376
+ buildOptionText: PropType<(opt: {
4377
+ value: any;
4378
+ }) => any>;
4379
+ showQuickJumper: {
4380
+ type: PropType<boolean | {
4381
+ goButton?: any;
4382
+ }>;
4383
+ default: boolean | {
4384
+ goButton?: any;
4385
+ };
4386
+ };
4387
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
4388
+ size: PropType<"small" | "default">;
4389
+ simple: {
4390
+ type: BooleanConstructor;
4391
+ default: any;
4392
+ };
4393
+ locale: ObjectConstructor;
4394
+ prefixCls: StringConstructor;
4395
+ selectPrefixCls: StringConstructor;
4396
+ totalBoundaryShowSizeChanger: NumberConstructor;
4397
+ selectComponentClass: StringConstructor;
4398
+ itemRender: PropType<(opt: {
4399
+ page: number;
4400
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
4401
+ originalElement: any;
4402
+ }) => any>;
4403
+ role: StringConstructor;
4404
+ responsive: BooleanConstructor;
4405
+ showLessItems: {
4406
+ type: BooleanConstructor;
4407
+ default: any;
4408
+ };
4409
+ onChange: PropType<(page: number, pageSize: number) => void>;
4410
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
4411
+ 'onUpdate:current': PropType<(current: number) => void>;
4412
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
4413
+ }>>>) => SpreadSheet_2>;
3210
4414
  onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet_2) => void>;
3211
4415
  }>> & {
3212
4416
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
@@ -3269,6 +4473,7 @@ total: number;
3269
4473
  current: number;
3270
4474
  }) => any;
3271
4475
  onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
4476
+ onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
3272
4477
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
3273
4478
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
3274
4479
  onLayoutColsExpanded?: (node: Node_2_2) => any;
@@ -3302,12 +4507,16 @@ onKeyBoardDown?: (event: KeyboardEvent) => any;
3302
4507
  onKeyBoardUp?: (event: KeyboardEvent) => any;
3303
4508
  onCopied?: (copyData: string) => any;
3304
4509
  onActionIconHover?: (event: default_2) => any;
4510
+ onActionIconHoverOff?: (event: default_2) => any;
3305
4511
  onActionIconClick?: (event: default_2) => any;
3306
4512
  onContextMenu?: (event: default_2) => any;
3307
4513
  onClick?: (event: default_2) => any;
4514
+ onHover?: (event: default_2) => any;
3308
4515
  onDoubleClick?: (event: default_2) => any;
3309
4516
  onMouseHover?: (event: default_2) => any;
3310
4517
  onMouseUp?: (event: MouseEvent) => any;
4518
+ onMouseDown?: (event: MouseEvent) => any;
4519
+ onMouseMove?: (event: MouseEvent) => any;
3311
4520
  onSelected?: (cells: DataCell_2[]) => any;
3312
4521
  onReset?: (event: KeyboardEvent) => any;
3313
4522
  onLinkFieldJump?: (data: {
@@ -3315,10 +4524,66 @@ key: string;
3315
4524
  record: Data_2;
3316
4525
  }) => any;
3317
4526
  onScroll?: (position: CellScrollPosition_2) => any;
3318
- onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element>) => any;
4527
+ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element, unknown>) => any;
3319
4528
  onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
3320
4529
  }, {
3321
- options: S2Options_2<string | Element>;
4530
+ options: S2Options_2<string | Element, Partial<ExtractPropTypes< {
4531
+ total: NumberConstructor;
4532
+ defaultCurrent: NumberConstructor;
4533
+ disabled: {
4534
+ type: BooleanConstructor;
4535
+ default: any;
4536
+ };
4537
+ current: NumberConstructor;
4538
+ defaultPageSize: NumberConstructor;
4539
+ pageSize: NumberConstructor;
4540
+ hideOnSinglePage: {
4541
+ type: BooleanConstructor;
4542
+ default: any;
4543
+ };
4544
+ showSizeChanger: {
4545
+ type: BooleanConstructor;
4546
+ default: any;
4547
+ };
4548
+ pageSizeOptions: PropType<(string | number)[]>;
4549
+ buildOptionText: PropType<(opt: {
4550
+ value: any;
4551
+ }) => any>;
4552
+ showQuickJumper: {
4553
+ type: PropType<boolean | {
4554
+ goButton?: any;
4555
+ }>;
4556
+ default: boolean | {
4557
+ goButton?: any;
4558
+ };
4559
+ };
4560
+ showTotal: PropType<(total: number, range: [number, number]) => any>;
4561
+ size: PropType<"small" | "default">;
4562
+ simple: {
4563
+ type: BooleanConstructor;
4564
+ default: any;
4565
+ };
4566
+ locale: ObjectConstructor;
4567
+ prefixCls: StringConstructor;
4568
+ selectPrefixCls: StringConstructor;
4569
+ totalBoundaryShowSizeChanger: NumberConstructor;
4570
+ selectComponentClass: StringConstructor;
4571
+ itemRender: PropType<(opt: {
4572
+ page: number;
4573
+ type: "page" | "prev" | "next" | "jump-prev" | "jump-next";
4574
+ originalElement: any;
4575
+ }) => any>;
4576
+ role: StringConstructor;
4577
+ responsive: BooleanConstructor;
4578
+ showLessItems: {
4579
+ type: BooleanConstructor;
4580
+ default: any;
4581
+ };
4582
+ onChange: PropType<(page: number, pageSize: number) => void>;
4583
+ onShowSizeChange: PropType<(current: number, size: number) => void>;
4584
+ 'onUpdate:current': PropType<(current: number) => void>;
4585
+ 'onUpdate:pageSize': PropType<(size: number) => void>;
4586
+ }>>>;
3322
4587
  loading: boolean;
3323
4588
  adaptive: boolean | {
3324
4589
  width?: boolean;
@@ -3329,10 +4594,10 @@ showPagination: boolean | {
3329
4594
  onShowSizeChange?: (pageSize: number) => void;
3330
4595
  onChange?: (current: number) => void;
3331
4596
  };
3332
- }> | DefineComponent<GetInitProps<BaseSheetComponentProps<PartDrillDown, unknown>, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconClick" | "onContextMenu" | "onClick" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">, {
4597
+ }> | DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">, {
3333
4598
  s2Ref: ShallowRef<SheetExpose>;
3334
4599
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3335
- spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element>) => SpreadSheet_2;
4600
+ spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element, unknown>) => SpreadSheet_2;
3336
4601
  getSpreadSheet: (spreadsheet: SpreadSheet_2) => void;
3337
4602
  sheetUpdate: SheetUpdateCallback;
3338
4603
  rowCellHover: (data: TargetCellInfo_2) => void;
@@ -3394,6 +4659,7 @@ total: number;
3394
4659
  current: number;
3395
4660
  }) => void;
3396
4661
  layoutCellScroll: (position: CellScrollPosition_2) => void;
4662
+ layoutCollapseRows: (data: CollapsedRowsType_2) => void;
3397
4663
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
3398
4664
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
3399
4665
  layoutColsExpanded: (node: Node_2_2) => void;
@@ -3427,12 +4693,16 @@ keyBoardDown: (event: KeyboardEvent) => void;
3427
4693
  keyBoardUp: (event: KeyboardEvent) => void;
3428
4694
  copied: (copyData: string) => void;
3429
4695
  actionIconHover: (event: default_2) => void;
4696
+ actionIconHoverOff: (event: default_2) => void;
3430
4697
  actionIconClick: (event: default_2) => void;
3431
4698
  contextMenu: (event: default_2) => void;
3432
4699
  click: (event: default_2) => void;
4700
+ hover: (event: default_2) => void;
3433
4701
  doubleClick: (event: default_2) => void;
3434
4702
  mouseHover: (event: default_2) => void;
3435
4703
  mouseUp: (event: MouseEvent) => void;
4704
+ mouseDown: (event: MouseEvent) => void;
4705
+ mouseMove: (event: MouseEvent) => void;
3436
4706
  selected: (cells: DataCell_2[]) => void;
3437
4707
  reset: (event: KeyboardEvent) => void;
3438
4708
  linkFieldJump: (data: {
@@ -3440,7 +4710,7 @@ key: string;
3440
4710
  record: Data_2;
3441
4711
  }) => void;
3442
4712
  scroll: (position: CellScrollPosition_2) => void;
3443
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<BaseSheetComponentProps<PartDrillDown, unknown>, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconClick" | "onContextMenu" | "onClick" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">>> & {
4713
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">>> & {
3444
4714
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
3445
4715
  onRowCellHover?: (data: TargetCellInfo_2) => any;
3446
4716
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -3501,6 +4771,7 @@ total: number;
3501
4771
  current: number;
3502
4772
  }) => any;
3503
4773
  onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
4774
+ onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
3504
4775
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
3505
4776
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
3506
4777
  onLayoutColsExpanded?: (node: Node_2_2) => any;
@@ -3534,12 +4805,16 @@ onKeyBoardDown?: (event: KeyboardEvent) => any;
3534
4805
  onKeyBoardUp?: (event: KeyboardEvent) => any;
3535
4806
  onCopied?: (copyData: string) => any;
3536
4807
  onActionIconHover?: (event: default_2) => any;
4808
+ onActionIconHoverOff?: (event: default_2) => any;
3537
4809
  onActionIconClick?: (event: default_2) => any;
3538
4810
  onContextMenu?: (event: default_2) => any;
3539
4811
  onClick?: (event: default_2) => any;
4812
+ onHover?: (event: default_2) => any;
3540
4813
  onDoubleClick?: (event: default_2) => any;
3541
4814
  onMouseHover?: (event: default_2) => any;
3542
4815
  onMouseUp?: (event: MouseEvent) => any;
4816
+ onMouseDown?: (event: MouseEvent) => any;
4817
+ onMouseMove?: (event: MouseEvent) => any;
3543
4818
  onSelected?: (cells: DataCell_2[]) => any;
3544
4819
  onReset?: (event: KeyboardEvent) => any;
3545
4820
  onLinkFieldJump?: (data: {
@@ -3547,11 +4822,11 @@ key: string;
3547
4822
  record: Data_2;
3548
4823
  }) => any;
3549
4824
  onScroll?: (position: CellScrollPosition_2) => any;
3550
- onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element>) => any;
4825
+ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element, unknown>) => any;
3551
4826
  onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
3552
4827
  }, {}>>;
3553
4828
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3554
- spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element>) => SpreadSheet_2;
4829
+ spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element, unknown>) => SpreadSheet_2;
3555
4830
  getSpreadSheet: (spreadsheet: SpreadSheet_2) => void;
3556
4831
  sheetUpdate: SheetUpdateCallback;
3557
4832
  rowCellHover: (data: TargetCellInfo_2) => void;
@@ -3613,6 +4888,7 @@ total: number;
3613
4888
  current: number;
3614
4889
  }) => void;
3615
4890
  layoutCellScroll: (position: CellScrollPosition_2) => void;
4891
+ layoutCollapseRows: (data: CollapsedRowsType_2) => void;
3616
4892
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
3617
4893
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
3618
4894
  layoutColsExpanded: (node: Node_2_2) => void;
@@ -3646,12 +4922,16 @@ keyBoardDown: (event: KeyboardEvent) => void;
3646
4922
  keyBoardUp: (event: KeyboardEvent) => void;
3647
4923
  copied: (copyData: string) => void;
3648
4924
  actionIconHover: (event: default_2) => void;
4925
+ actionIconHoverOff: (event: default_2) => void;
3649
4926
  actionIconClick: (event: default_2) => void;
3650
4927
  contextMenu: (event: default_2) => void;
3651
4928
  click: (event: default_2) => void;
4929
+ hover: (event: default_2) => void;
3652
4930
  doubleClick: (event: default_2) => void;
3653
4931
  mouseHover: (event: default_2) => void;
3654
4932
  mouseUp: (event: MouseEvent) => void;
4933
+ mouseDown: (event: MouseEvent) => void;
4934
+ mouseMove: (event: MouseEvent) => void;
3655
4935
  selected: (cells: DataCell_2[]) => void;
3656
4936
  reset: (event: KeyboardEvent) => void;
3657
4937
  linkFieldJump: (data: {
@@ -3659,7 +4939,7 @@ key: string;
3659
4939
  record: Data_2;
3660
4940
  }) => void;
3661
4941
  scroll: (position: CellScrollPosition_2) => void;
3662
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<BaseSheetComponentProps<PartDrillDown, unknown>, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconClick" | "onContextMenu" | "onClick" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">>> & {
4942
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">>> & {
3663
4943
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
3664
4944
  onRowCellHover?: (data: TargetCellInfo_2) => any;
3665
4945
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -3720,6 +5000,7 @@ total: number;
3720
5000
  current: number;
3721
5001
  }) => any;
3722
5002
  onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
5003
+ onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
3723
5004
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
3724
5005
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
3725
5006
  onLayoutColsExpanded?: (node: Node_2_2) => any;
@@ -3753,12 +5034,16 @@ onKeyBoardDown?: (event: KeyboardEvent) => any;
3753
5034
  onKeyBoardUp?: (event: KeyboardEvent) => any;
3754
5035
  onCopied?: (copyData: string) => any;
3755
5036
  onActionIconHover?: (event: default_2) => any;
5037
+ onActionIconHoverOff?: (event: default_2) => any;
3756
5038
  onActionIconClick?: (event: default_2) => any;
3757
5039
  onContextMenu?: (event: default_2) => any;
3758
5040
  onClick?: (event: default_2) => any;
5041
+ onHover?: (event: default_2) => any;
3759
5042
  onDoubleClick?: (event: default_2) => any;
3760
5043
  onMouseHover?: (event: default_2) => any;
3761
5044
  onMouseUp?: (event: MouseEvent) => any;
5045
+ onMouseDown?: (event: MouseEvent) => any;
5046
+ onMouseMove?: (event: MouseEvent) => any;
3762
5047
  onSelected?: (cells: DataCell_2[]) => any;
3763
5048
  onReset?: (event: KeyboardEvent) => any;
3764
5049
  onLinkFieldJump?: (data: {
@@ -3766,10 +5051,12 @@ key: string;
3766
5051
  record: Data_2;
3767
5052
  }) => any;
3768
5053
  onScroll?: (position: CellScrollPosition_2) => any;
3769
- onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element>) => any;
5054
+ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element, unknown>) => any;
3770
5055
  onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
3771
5056
  }, {}>;
3772
5057
 
5058
+ declare type SheetComponentProps = BaseSheetComponentProps<PartDrillDown, unknown, PaginationProps>;
5059
+
3773
5060
  export declare interface SheetExpose {
3774
5061
  instance: SpreadSheet | undefined;
3775
5062
  }
@@ -3985,6 +5272,20 @@ declare abstract class SpreadSheet_2 extends EE {
3985
5272
  clearColumnLeafNodes(): void;
3986
5273
  private initHiddenColumnsDetail;
3987
5274
  private clearCanvasEvent;
5275
+ /**
5276
+ * 计算文本在画布中的宽度
5277
+ * @param text 待计算的文本
5278
+ * @param font 文本 css 样式
5279
+ * @returns 文本宽度
5280
+ */
5281
+ measureTextWidth: ((text: number | string, font: unknown) => number) & MemoizedFunction;
5282
+ /**
5283
+ * 粗略计算文本在画布中的宽度
5284
+ * @param text 待计算的文本
5285
+ * @param font 文本 css 样式
5286
+ * @returns 文本宽度
5287
+ */
5288
+ measureTextWidthRoughly: (text: any, font?: any) => number;
3988
5289
  }
3989
5290
 
3990
5291
  /**
@@ -4046,6 +5347,7 @@ declare interface Style {
4046
5347
  showTreeLeafNodeAlignDot?: boolean;
4047
5348
  treeRowsWidth?: number;
4048
5349
  hierarchyCollapse?: boolean;
5350
+ rowExpandDepth?: number;
4049
5351
  collapsedRows?: Record<string, boolean>;
4050
5352
  collapsedCols?: Record<string, boolean>;
4051
5353
  cellCfg?: CellCfg;
@@ -4054,10 +5356,10 @@ declare interface Style {
4054
5356
  device?: 'pc' | 'mobile';
4055
5357
  }
4056
5358
 
4057
- export declare const TableSheet: DefineComponent<GetInitProps<BaseSheetComponentProps<PartDrillDown, unknown>, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconClick" | "onContextMenu" | "onClick" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">, {
5359
+ export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">, {
4058
5360
  s2Ref: ShallowRef<SheetExpose>;
4059
5361
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
4060
- spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element>) => SpreadSheet_2;
5362
+ spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element, unknown>) => SpreadSheet_2;
4061
5363
  getSpreadSheet: (spreadsheet: SpreadSheet_2) => void;
4062
5364
  sheetUpdate: SheetUpdateCallback;
4063
5365
  rowCellHover: (data: TargetCellInfo_2) => void;
@@ -4119,6 +5421,7 @@ total: number;
4119
5421
  current: number;
4120
5422
  }) => void;
4121
5423
  layoutCellScroll: (position: CellScrollPosition_2) => void;
5424
+ layoutCollapseRows: (data: CollapsedRowsType_2) => void;
4122
5425
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
4123
5426
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
4124
5427
  layoutColsExpanded: (node: Node_2_2) => void;
@@ -4152,12 +5455,16 @@ keyBoardDown: (event: KeyboardEvent) => void;
4152
5455
  keyBoardUp: (event: KeyboardEvent) => void;
4153
5456
  copied: (copyData: string) => void;
4154
5457
  actionIconHover: (event: default_2) => void;
5458
+ actionIconHoverOff: (event: default_2) => void;
4155
5459
  actionIconClick: (event: default_2) => void;
4156
5460
  contextMenu: (event: default_2) => void;
4157
5461
  click: (event: default_2) => void;
5462
+ hover: (event: default_2) => void;
4158
5463
  doubleClick: (event: default_2) => void;
4159
5464
  mouseHover: (event: default_2) => void;
4160
5465
  mouseUp: (event: MouseEvent) => void;
5466
+ mouseDown: (event: MouseEvent) => void;
5467
+ mouseMove: (event: MouseEvent) => void;
4161
5468
  selected: (cells: DataCell_2[]) => void;
4162
5469
  reset: (event: KeyboardEvent) => void;
4163
5470
  linkFieldJump: (data: {
@@ -4165,7 +5472,7 @@ key: string;
4165
5472
  record: Data_2;
4166
5473
  }) => void;
4167
5474
  scroll: (position: CellScrollPosition_2) => void;
4168
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<BaseSheetComponentProps<PartDrillDown, unknown>, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconClick" | "onContextMenu" | "onClick" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">>> & {
5475
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll">>> & {
4169
5476
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
4170
5477
  onRowCellHover?: (data: TargetCellInfo_2) => any;
4171
5478
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -4226,6 +5533,7 @@ total: number;
4226
5533
  current: number;
4227
5534
  }) => any;
4228
5535
  onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
5536
+ onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
4229
5537
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
4230
5538
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
4231
5539
  onLayoutColsExpanded?: (node: Node_2_2) => any;
@@ -4259,12 +5567,16 @@ onKeyBoardDown?: (event: KeyboardEvent) => any;
4259
5567
  onKeyBoardUp?: (event: KeyboardEvent) => any;
4260
5568
  onCopied?: (copyData: string) => any;
4261
5569
  onActionIconHover?: (event: default_2) => any;
5570
+ onActionIconHoverOff?: (event: default_2) => any;
4262
5571
  onActionIconClick?: (event: default_2) => any;
4263
5572
  onContextMenu?: (event: default_2) => any;
4264
5573
  onClick?: (event: default_2) => any;
5574
+ onHover?: (event: default_2) => any;
4265
5575
  onDoubleClick?: (event: default_2) => any;
4266
5576
  onMouseHover?: (event: default_2) => any;
4267
5577
  onMouseUp?: (event: MouseEvent) => any;
5578
+ onMouseDown?: (event: MouseEvent) => any;
5579
+ onMouseMove?: (event: MouseEvent) => any;
4268
5580
  onSelected?: (cells: DataCell_2[]) => any;
4269
5581
  onReset?: (event: KeyboardEvent) => any;
4270
5582
  onLinkFieldJump?: (data: {
@@ -4272,7 +5584,7 @@ key: string;
4272
5584
  record: Data_2;
4273
5585
  }) => any;
4274
5586
  onScroll?: (position: CellScrollPosition_2) => any;
4275
- onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element>) => any;
5587
+ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<string | Element, unknown>) => any;
4276
5588
  onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
4277
5589
  }, {}>;
4278
5590