@antv/s2-vue 2.0.0-next.4 → 2.0.0-next.6

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
@@ -21,14 +21,17 @@ import { ICanvas } from '@antv/g';
21
21
  import { Image as Image_2 } from '@antv/g';
22
22
  import { ImageStyleProps } from '@antv/g';
23
23
  import { LayoutResult } from '@antv/s2';
24
+ import { Line } from '@antv/g';
24
25
  import { LineStyleProps } from '@antv/g';
25
26
  import { MemoizedFunction } from 'lodash';
26
27
  import { Node as Node_2 } from '@antv/s2';
27
28
  import { Pagination } from '@antv/s2';
28
29
  import type { PaginationProps } from 'ant-design-vue';
29
30
  import { PointLike } from '@antv/g';
31
+ import { Polygon } from '@antv/g';
30
32
  import { PropType } from 'vue';
31
33
  import { RawData } from '@antv/s2';
34
+ import { Rect } from '@antv/g';
32
35
  import { Ref } from 'vue';
33
36
  import { ResizeInfo } from '@antv/s2';
34
37
  import { ResizeParams } from '@antv/s2';
@@ -42,6 +45,8 @@ import { ShallowRef } from 'vue';
42
45
  import { SortParams } from '@antv/s2';
43
46
  import { SpreadSheet } from '@antv/s2';
44
47
  import { TargetCellInfo } from '@antv/s2';
48
+ import { Text as Text_2 } from '@antv/g';
49
+ import { TextStyleProps } from '@antv/g';
45
50
  import { ThemeCfg } from '@antv/s2';
46
51
  import { Timer } from 'd3-timer';
47
52
  import { TooltipContentType } from '@antv/s2';
@@ -55,6 +60,11 @@ declare type Adaptive = boolean | {
55
60
  getContainer?: () => HTMLElement;
56
61
  };
57
62
 
63
+ declare interface AdjustLeafNodesParams {
64
+ leafNodes: Node_2_2[];
65
+ hierarchy: Hierarchy;
66
+ }
67
+
58
68
  declare enum Aggregation {
59
69
  SUM = "SUM",
60
70
  MIN = "MIN",
@@ -64,7 +74,7 @@ declare enum Aggregation {
64
74
 
65
75
  declare interface AreaRange {
66
76
  start: number;
67
- width: number;
77
+ size: number;
68
78
  }
69
79
 
70
80
  declare interface Background {
@@ -102,14 +112,14 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
102
112
  protected meta: T;
103
113
  protected spreadsheet: SpreadSheet_2;
104
114
  protected theme: S2Theme;
105
- protected backgroundShape: DisplayObject;
106
- protected textShape: DisplayObject;
107
- protected textShapes: DisplayObject[];
108
- protected linkFieldShape: DisplayObject;
115
+ protected backgroundShape: Rect | Polygon;
116
+ protected textShape: CustomText;
117
+ protected textShapes: CustomText[];
118
+ protected linkFieldShape: Line;
109
119
  protected actualText: string;
110
120
  protected actualTextWidth: number;
111
121
  protected conditions: Conditions;
112
- protected conditionIntervalShape: DisplayObject | undefined;
122
+ protected conditionIntervalShape: Rect | undefined;
113
123
  protected conditionIconShape: GuiIcon;
114
124
  protected conditionIconShapes: GuiIcon[];
115
125
  protected stateShapes: Map<StateShapeLayer, DisplayObject<any, any>>;
@@ -117,7 +127,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
117
127
  getMeta(): T;
118
128
  setMeta(viewMeta: T): void;
119
129
  getIconStyle(): IconTheme | undefined;
120
- getTextAndIconPosition(iconCount?: number): {
130
+ getTextIconPosition(iconCount?: number): {
121
131
  text: {
122
132
  x: number;
123
133
  y: number;
@@ -155,7 +165,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
155
165
  protected abstract mappingValue(condition: Condition): MappingResult | undefined | null;
156
166
  protected shouldInit(): boolean;
157
167
  getStyle<K extends keyof S2Theme = keyof CellThemes>(name?: K): DefaultCellTheme | S2Theme[K];
158
- getLinkFieldShape(): DisplayObject<any, any>;
168
+ getLinkFieldShape(): Line;
159
169
  protected getResizeAreaStyle(): ResizeArea;
160
170
  protected shouldDrawResizeAreaByType(type: keyof ResizeInteractionOptions, cell: S2CellType_2): boolean | ((cell: S2CellType_2<ViewMeta_2>) => boolean) | ResizeType | ((resizeInfo: ResizeInfo_2) => boolean) | undefined;
161
171
  getBBoxByType(type?: CellClipBox): SimpleBBox;
@@ -188,9 +198,9 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
188
198
  };
189
199
  hideInteractionShape(): void;
190
200
  clearUnselectedState(): void;
191
- getTextShape(): DisplayObject;
192
- getTextShapes(): DisplayObject[];
193
- addTextShape(textShape: DisplayObject): void;
201
+ getTextShape(): CustomText;
202
+ getTextShapes(): CustomText[];
203
+ addTextShape(textShape: CustomText | Text_2): void;
194
204
  getConditionIconShape(): GuiIcon;
195
205
  getConditionIconShapes(): GuiIcon[];
196
206
  addConditionIconShape(iconShape: GuiIcon): void;
@@ -228,8 +238,17 @@ declare interface BaseCellStyle {
228
238
  }
229
239
 
230
240
  declare interface BaseChartData {
241
+ /**
242
+ * 类型
243
+ */
231
244
  type: MiniChartTypes;
245
+ /**
246
+ * 数据
247
+ */
232
248
  data: RawData_2[];
249
+ /**
250
+ * 坐标轴数据
251
+ */
233
252
  encode?: {
234
253
  x: keyof RawData_2;
235
254
  y: keyof RawData_2;
@@ -445,7 +464,7 @@ declare abstract class BaseFacet {
445
464
  calculateCellWidthHeight: () => void;
446
465
  /**
447
466
  * The purpose of this rewrite is to take into account that when rowHeader supports scrollbars
448
- the panel viewable area must vary with the horizontal distance of the scroll
467
+ *the panel viewable area must vary with the horizontal distance of the scroll
449
468
  * @param scrollX
450
469
  * @param scrollY
451
470
  * @public
@@ -487,22 +506,31 @@ declare abstract class BaseFacet {
487
506
  isVerticalScrollOverTheViewport: (deltaY: number) => boolean;
488
507
  isHorizontalScrollOverTheViewport: (scrollOffset: CellScrollOffset) => boolean;
489
508
  /**
490
- 在当前表格滚动分两种情况:
491
- 1. 当前表格无滚动条: 无需阻止外部容器滚动
492
- 2. 当前表格有滚动条:
493
- - 未滚动到顶部或底部: 当前表格滚动, 阻止外部容器滚动
494
- - 滚动到顶部或底部: 恢复外部容器滚动
509
+ * 在当前表格滚动分两种情况:
510
+ * 1. 当前表格无滚动条: 无需阻止外部容器滚动
511
+ * 2. 当前表格有滚动条:
512
+ * - 未滚动到顶部或底部: 当前表格滚动, 阻止外部容器滚动
513
+ * - 滚动到顶部或底部: 恢复外部容器滚动
495
514
  */
496
515
  isScrollOverTheViewport: (scrollOffset: CellScrollOffset) => boolean;
497
516
  cancelScrollFrame: () => boolean;
498
517
  clearScrollFrameIdOnMobile: () => void;
499
518
  /**
500
- https://developer.mozilla.org/zh-CN/docs/Web/CSS/overscroll-behavior
501
- 阻止外部容器滚动: 表格是虚拟滚动, 这里按照标准模拟浏览器的 [overscroll-behavior] 实现
502
- 1. auto => 只有在滚动到表格顶部或底部时才触发外部容器滚动
503
- 1. contain => 默认的滚动边界行为不变(“触底”效果或者刷新),但是临近的滚动区域不会被滚动链影响到
504
- 2. none => 临近滚动区域不受到滚动链影响,而且默认的滚动到边界的表现也被阻止
505
- 所以只要不为 `auto`, 或者表格内, 都需要阻止外部容器滚动
519
+ *<<<<<<< HEAD
520
+ *https://developer.mozilla.org/zh-CN/docs/Web/CSS/overscroll-behavior
521
+ *阻止外部容器滚动: 表格是虚拟滚动, 这里按照标准模拟浏览器的 [overscroll-behavior] 实现
522
+ *1. auto => 只有在滚动到表格顶部或底部时才触发外部容器滚动
523
+ *1. contain => 默认的滚动边界行为不变(“触底”效果或者刷新),但是临近的滚动区域不会被滚动链影响到
524
+ *2. none => 临近滚动区域不受到滚动链影响,而且默认的滚动到边界的表现也被阻止
525
+ *所以只要不为 `auto`, 或者表格内, 都需要阻止外部容器滚动
526
+ *=======
527
+ *https://developer.mozilla.org/zh-CN/docs/Web/CSS/overscroll-behavior
528
+ *阻止外部容器滚动: 表格是虚拟滚动, 这里按照标准模拟浏览器的 [overscroll-behavior] 实现
529
+ *1. auto => 只有在滚动到表格顶部或底部时才触发外部容器滚动
530
+ *1. contain => 默认的滚动边界行为不变(“触底”效果或者刷新),但是临近的滚动区域不会被滚动链影响到
531
+ *2. none => 临近滚动区域不受到滚动链影响,而且默认的滚动到边界的表现也被阻止
532
+ *所以只要不为 `auto`, 或者表格内, 都需要阻止外部容器滚动
533
+ *>>>>>>> next
506
534
  */
507
535
  private stopScrollChainingIfNeeded;
508
536
  private stopScrollChaining;
@@ -559,6 +587,27 @@ declare abstract class BaseFacet {
559
587
  protected saveInitColumnLeafNodes(columnNodes?: Node_2_2[]): void;
560
588
  getHiddenColumnsInfo(columnNode: Node_2_2): HiddenColumnsInfo_2 | undefined;
561
589
  getCornerNodes(): Node_2_2[];
590
+ /**
591
+ * @description 自定义行头时, 叶子节点层级不定, 需要自动对齐其宽度, 填充空白
592
+ * -------------------------------------------------
593
+ * | 自定义节点 a-1 | 自定义节点 a-1-1 |
594
+ * |------------- |------------- |------------|
595
+ * | 自定义节点 b-1 | 自定义节点 b-1-1 | 指标 1 |
596
+ * -------------------------------------------------
597
+ */
598
+ adjustRowLeafNodesWidth(params: AdjustLeafNodesParams): void;
599
+ /**
600
+ * @description 自定义列头时, 叶子节点层级不定, 需要自动对齐其高度, 填充空白
601
+ * ------------------------------------------------------------------------
602
+ * | 自定义节点 a-1 |
603
+ * |----------------------------------------------------------------------|
604
+ * | 自定义节点 a-1-1 | |
605
+ * |-------------|-------------|------------------| 自定义节点 a-1-2 |
606
+ * | 指标 1 | 自定义节点 a-1-1-1 | 指标 2 | |
607
+ * ----------------------------------------------------------------------
608
+ */
609
+ adjustColLeafNodesHeight(params: AdjustLeafNodesParams): void;
610
+ adjustLeafNodesSize(type: 'width' | 'height'): ({ leafNodes, hierarchy }: AdjustLeafNodesParams) => void;
562
611
  }
563
612
 
564
613
  declare interface BaseFields {
@@ -624,11 +673,9 @@ declare interface BaseHeaderConfig {
624
673
  viewportWidth: number;
625
674
  viewportHeight: number;
626
675
  position: PointLike;
627
- data: Node_2_2[];
676
+ nodes: Node_2_2[];
628
677
  spreadsheet: SpreadSheet_2;
629
678
  sortParam?: SortParam;
630
- linkFields: string[] | ((meta: Node_2_2 | ViewMeta_2) => boolean);
631
- hierarchyType: S2Options_2['hierarchyType'];
632
679
  }
633
680
 
634
681
  declare interface BaseNodeConfig {
@@ -664,6 +711,7 @@ declare interface BaseNodeConfig {
664
711
  height?: number;
665
712
  padding?: number;
666
713
  children?: Node_2_2[];
714
+ hiddenColumnsInfo?: HiddenColumnsInfo_2 | null;
667
715
  extra?: Record<string, any>;
668
716
  }
669
717
 
@@ -693,7 +741,6 @@ type: PropType<Adaptive>;
693
741
  default: Adaptive;
694
742
  };
695
743
  onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet>;
696
- onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet) => void>;
697
744
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
698
745
  }, {
699
746
  S2_PREFIX_CLS: string;
@@ -713,7 +760,6 @@ handlePageChange: (nextCurrent: number) => void;
713
760
  handlePageSizeChange: (nextSize: number) => void;
714
761
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
715
762
  spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet;
716
- getSpreadSheet: (spreadsheet: SpreadSheet) => void;
717
763
  sheetUpdate: SheetUpdateCallback;
718
764
  rowCellHover: (data: TargetCellInfo) => void;
719
765
  rowCellClick: (data: TargetCellInfo) => void;
@@ -769,7 +815,6 @@ filteredValues: string[];
769
815
  rangeFiltered: (data: ViewMetaData[]) => void;
770
816
  layoutAfterHeaderLayout: (layoutResult: LayoutResult) => void;
771
817
  layoutPagination: (data: LayoutPaginationParams) => void;
772
- layoutCellScroll: (position: CellScrollPosition) => void;
773
818
  layoutCellMounted: (cell: S2CellType<ViewMeta>) => void;
774
819
  beforeRender: () => void;
775
820
  afterRender: () => void;
@@ -848,7 +893,6 @@ type: PropType<Adaptive>;
848
893
  default: Adaptive;
849
894
  };
850
895
  onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet>;
851
- onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet) => void>;
852
896
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
853
897
  }>> & {
854
898
  onSheetUpdate?: (params: S2RenderOptions) => any;
@@ -906,7 +950,6 @@ filteredValues: string[];
906
950
  onRangeFiltered?: (data: ViewMetaData[]) => any;
907
951
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult) => any;
908
952
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
909
- onLayoutCellScroll?: (position: CellScrollPosition) => any;
910
953
  onLayoutCellMounted?: (cell: S2CellType<ViewMeta>) => any;
911
954
  onBeforeRender?: () => any;
912
955
  onAfterRender?: () => any;
@@ -960,7 +1003,6 @@ spreadsheet: SpreadSheet;
960
1003
  onRowCellBrushSelection?: (event: GEvent) => any;
961
1004
  onColCellBrushSelection?: (event: GEvent) => any;
962
1005
  onSpreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => any;
963
- onGetSpreadSheet?: (spreadsheet: SpreadSheet) => any;
964
1006
  }, {
965
1007
  options: S2Options<TooltipContentType, Pagination, string | Element, string>;
966
1008
  loading: boolean;
@@ -990,8 +1032,6 @@ declare interface BaseSheetComponentProps<RenderHandler = unknown, PartialDrillD
990
1032
  };
991
1033
  themeCfg?: ThemeCfg;
992
1034
  header?: Header;
993
- /** @deprecated 1.29.0 已废弃, 请使用 onMounted 代替 */
994
- getSpreadSheet?: (spreadsheet: SpreadSheet) => void;
995
1035
  /** 底表 render callback */
996
1036
  onSheetUpdate?: SheetUpdateCallback;
997
1037
  onRowCellHover?: (data: TargetCellInfo) => void;
@@ -1048,8 +1088,6 @@ declare interface BaseSheetComponentProps<RenderHandler = unknown, PartialDrillD
1048
1088
  onRangeFiltered?: (data: ViewMetaData[]) => void;
1049
1089
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult) => void;
1050
1090
  onLayoutPagination?: (data: LayoutPaginationParams) => void;
1051
- /** @deprecated 已废弃, 请使用 S2Event.GLOBAL_SCROLL 代替 */
1052
- onLayoutCellScroll?: (position: CellScrollPosition) => void;
1053
1091
  onLayoutCellMounted?: (cell: S2CellType) => void;
1054
1092
  onBeforeRender?: () => void;
1055
1093
  onAfterRender?: () => void;
@@ -1163,7 +1201,6 @@ declare interface BulletTheme {
1163
1201
  width: number;
1164
1202
  height: number;
1165
1203
  fill?: string;
1166
- color?: string;
1167
1204
  opacity?: number;
1168
1205
  };
1169
1206
  rangeColors: RangeColors;
@@ -1171,8 +1208,17 @@ declare interface BulletTheme {
1171
1208
  }
1172
1209
 
1173
1210
  declare interface BulletValue {
1211
+ /**
1212
+ * 类型
1213
+ */
1174
1214
  type: MiniChartTypes.Bullet;
1215
+ /**
1216
+ * 当前值
1217
+ */
1175
1218
  measure: number | string;
1219
+ /**
1220
+ * 目标值
1221
+ */
1176
1222
  target: number | string;
1177
1223
  [key: string]: unknown;
1178
1224
  }
@@ -1277,8 +1323,6 @@ declare interface CellTheme {
1277
1323
  verticalBorderWidth?: number;
1278
1324
  padding?: Padding;
1279
1325
  interactionState?: InteractionState;
1280
- miniBarChartHeight?: number;
1281
- miniBarChartFillColor?: string;
1282
1326
  }
1283
1327
 
1284
1328
  declare type CellThemes = {
@@ -1296,15 +1340,16 @@ declare enum CellTypes {
1296
1340
 
1297
1341
  declare class ColCell extends HeaderCell {
1298
1342
  protected headerConfig: ColHeaderConfig;
1299
- /** 文字绘制起始坐标 */
1300
- protected textPosition: PointLike;
1343
+ /** icon 绘制起始坐标 */
1344
+ protected iconPosition: PointLike;
1301
1345
  get cellType(): CellTypes;
1302
1346
  protected getBorderPositions(): CellBorderPosition[];
1303
1347
  protected initCell(): void;
1348
+ protected getFormattedFieldValue(): FormatResult;
1304
1349
  protected getMaxTextWidth(): number;
1305
- protected getIconPosition(): PointLike;
1306
1350
  protected isBolderText(): boolean;
1307
1351
  protected getTextPosition(): PointLike;
1352
+ protected getIconPosition(): PointLike;
1308
1353
  protected getActionIconsWidth(): number;
1309
1354
  protected getColResizeArea(): Group | undefined;
1310
1355
  protected getHorizontalResizeAreaName(): string;
@@ -1360,6 +1405,7 @@ declare class ColHeader extends BaseHeader<ColHeaderConfig> {
1360
1405
  protected scrollGroup: Group;
1361
1406
  protected background: DisplayObject;
1362
1407
  constructor(cfg: ColHeaderConfig);
1408
+ private initScrollGroup;
1363
1409
  /**
1364
1410
  * Make colHeader scroll with hScrollBar
1365
1411
  * @param scrollX horizontal offset
@@ -1369,9 +1415,9 @@ declare class ColHeader extends BaseHeader<ColHeaderConfig> {
1369
1415
  onColScroll(scrollX: number, type: string): void;
1370
1416
  protected clip(): void;
1371
1417
  clear(): void;
1372
- protected getCellInstance(item: Node_2_2, spreadsheet: SpreadSheet_2, headerConfig: ColHeaderConfig): S2CellType_2;
1418
+ protected getCellInstance(node: Node_2_2, spreadsheet: SpreadSheet_2, headerConfig: ColHeaderConfig): S2CellType_2;
1373
1419
  protected getCellGroup(node: Node_2_2): Group;
1374
- protected isColCellInRect(item: Node_2_2): boolean;
1420
+ protected isColCellInRect(node: Node_2_2): boolean;
1375
1421
  protected layout(): void;
1376
1422
  protected offset(): void;
1377
1423
  }
@@ -1395,6 +1441,23 @@ declare interface Conditions {
1395
1441
  icon?: IconCondition[];
1396
1442
  }
1397
1443
 
1444
+ declare type CopyableHTML = {
1445
+ type: CopyMIMEType.HTML;
1446
+ content: string;
1447
+ };
1448
+
1449
+ declare type CopyableList = [CopyablePlain, CopyableHTML];
1450
+
1451
+ declare type CopyablePlain = {
1452
+ type: CopyMIMEType.PLAIN;
1453
+ content: string;
1454
+ };
1455
+
1456
+ declare enum CopyMIMEType {
1457
+ PLAIN = "text/plain",
1458
+ HTML = "text/html"
1459
+ }
1460
+
1398
1461
  declare class CornerBBox extends BaseBBox {
1399
1462
  calculateBBox(): void;
1400
1463
  private getCornerBBoxOriginalHeight;
@@ -1411,10 +1474,6 @@ declare class CornerCell extends HeaderCell {
1411
1474
  protected getBorderPositions(): CellBorderPosition[];
1412
1475
  update(): void;
1413
1476
  protected initCell(): void;
1414
- /**
1415
- * @deprecated 已废弃, 请使用 drawTextShape
1416
- */
1417
- protected drawCellText(): void;
1418
1477
  protected drawTextShape(): void;
1419
1478
  /**
1420
1479
  * 绘制折叠展开的icon
@@ -1499,6 +1558,15 @@ declare interface CustomSVGIcon {
1499
1558
  svg: string;
1500
1559
  }
1501
1560
 
1561
+ /**
1562
+ * 自定义 text 图形
1563
+ * - 有 appendInfo 属性
1564
+ */
1565
+ declare class CustomText<T = Record<string, any>> extends Text_2 {
1566
+ appendInfo: T;
1567
+ constructor(options: DisplayObjectConfig<TextStyleProps>, appendInfo: T);
1568
+ }
1569
+
1502
1570
  export declare class CustomTooltip extends BaseTooltip {
1503
1571
  constructor(spreadsheet: SpreadSheet);
1504
1572
  renderContent(): void;
@@ -1506,11 +1574,26 @@ export declare class CustomTooltip extends BaseTooltip {
1506
1574
  }
1507
1575
 
1508
1576
  declare interface CustomTreeNode {
1577
+ /**
1578
+ * 字段唯一标识
1579
+ */
1509
1580
  field: string;
1581
+ /**
1582
+ * 标题
1583
+ */
1510
1584
  title?: string;
1585
+ /**
1586
+ * 是否收起(默认都展开)
1587
+ */
1511
1588
  collapsed?: boolean;
1589
+ /**
1590
+ * 字段描述
1591
+ */
1512
1592
  description?: string;
1513
- children?: string[] | CustomTreeNode[];
1593
+ /**
1594
+ * 子节点
1595
+ */
1596
+ children?: CustomTreeNode[];
1514
1597
  }
1515
1598
 
1516
1599
  declare type Data = (RawData_2 & ExtraData) | undefined | null;
@@ -1545,7 +1628,7 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
1545
1628
  */
1546
1629
  private getDefaultTextFill;
1547
1630
  protected getTextStyle(): TextTheme;
1548
- getIconStyle(): IconCfg | undefined;
1631
+ getIconStyle(): IconStyle | undefined;
1549
1632
  protected drawConditionIntervalShape(): void;
1550
1633
  protected shouldHideRowSubtotalData(): boolean;
1551
1634
  protected getFormattedFieldValue(): FormatResult;
@@ -1620,14 +1703,14 @@ declare interface EmitterType {
1620
1703
  [S2Event.GLOBAL_ACTION_ICON_CLICK]: CanvasEventHandler;
1621
1704
  [S2Event.GLOBAL_ACTION_ICON_HOVER]: CanvasEventHandler;
1622
1705
  [S2Event.GLOBAL_ACTION_ICON_HOVER_OFF]: CanvasEventHandler;
1623
- [S2Event.GLOBAL_COPIED]: (data: string) => void;
1706
+ [S2Event.GLOBAL_COPIED]: (data: CopyableList | undefined) => void;
1624
1707
  [S2Event.GLOBAL_KEYBOARD_DOWN]: KeyboardEventHandler;
1625
1708
  [S2Event.GLOBAL_KEYBOARD_UP]: KeyboardEventHandler;
1626
1709
  [S2Event.GLOBAL_MOUSE_UP]: MouseEventHandler;
1627
1710
  [S2Event.GLOBAL_MOUSE_MOVE]: MouseEventHandler;
1628
1711
  [S2Event.LAYOUT_RESIZE_MOUSE_DOWN]: CanvasEventHandler;
1629
1712
  [S2Event.LAYOUT_RESIZE_MOUSE_UP]: CanvasEventHandler;
1630
- [S2Event.LAYOUT_RESIZE_MOUSE_MOVE]: CanvasEventHandler;
1713
+ [S2Event.LAYOUT_RESIZE_MOUSE_MOVE]: PointerEventHandler;
1631
1714
  [S2Event.GLOBAL_CONTEXT_MENU]: CanvasEventHandler;
1632
1715
  [S2Event.GLOBAL_CLICK]: CanvasEventHandler;
1633
1716
  [S2Event.GLOBAL_DOUBLE_CLICK]: CanvasEventHandler;
@@ -1711,8 +1794,6 @@ declare interface EmitterType {
1711
1794
  remove: [number, number][];
1712
1795
  spreadsheet: SpreadSheet_2;
1713
1796
  }) => void;
1714
- /** @deprecated 请使用 S2Event.GLOBAL_SCROLL 代替 */
1715
- [S2Event.LAYOUT_CELL_SCROLL]: (position: CellScrollPosition_2) => void;
1716
1797
  [S2Event.LAYOUT_CELL_MOUNTED]: (cell: S2CellType_2) => void;
1717
1798
  [S2Event.LAYOUT_BEFORE_RENDER]: () => void;
1718
1799
  [S2Event.LAYOUT_AFTER_RENDER]: () => void;
@@ -1899,7 +1980,12 @@ declare class GuiIcon extends Group {
1899
1980
  private cfg;
1900
1981
  constructor(cfg: GuiIconCfg);
1901
1982
  private getImage;
1902
- hasSupportSuffix: (image: string) => boolean;
1983
+ /**
1984
+ * 1. https://xxx.svg
1985
+ * 2. http://xxx.svg
1986
+ * 3. //xxx.svg
1987
+ */
1988
+ isOnlineLink: (src: string) => boolean;
1903
1989
  private render;
1904
1990
  }
1905
1991
 
@@ -1912,6 +1998,7 @@ declare class HdAdapter {
1912
1998
  private viewport;
1913
1999
  private devicePixelRatioMedia;
1914
2000
  private spreadsheet;
2001
+ private isDevicePixelRatioChange;
1915
2002
  constructor(spreadsheet: SpreadSheet_2);
1916
2003
  init: () => void;
1917
2004
  destroy: () => void;
@@ -1919,6 +2006,11 @@ declare class HdAdapter {
1919
2006
  private removeDevicePixelRatioListener;
1920
2007
  private initDeviceZoomListener;
1921
2008
  private removeDeviceZoomListener;
2009
+ /**
2010
+ * DPR 改变也会触发 visualViewport 的 resize 事件, 预期是只监听双指缩放, 所以这里规避掉
2011
+ * @see https://github.com/antvis/S2/issues/2072
2012
+ */
2013
+ private renderByZoomScaleWithoutResizeEffect;
1922
2014
  private renderByDevicePixelRatioChanged;
1923
2015
  private renderByDevicePixelRatio;
1924
2016
  private renderByZoomScale;
@@ -1929,11 +2021,6 @@ declare interface HeaderActionIcon {
1929
2021
  belongsCell: Omit<CellTypes, 'dataCell'>;
1930
2022
  defaultHide?: boolean | ((meta: Node_2_2, iconName: string) => boolean);
1931
2023
  displayCondition?: (mete: Node_2_2, iconName: string) => boolean;
1932
- /**
1933
- * 点击后的执行函数
1934
- * @deprecated 使用 onClick 代替
1935
- */
1936
- action?: (headerIconClickParams: HeaderIconClickParams) => void;
1937
2024
  onClick?: (headerIconClickParams: HeaderIconClickParams) => void;
1938
2025
  onHover?: (headerIconHoverParams: HeaderIconHoverParams) => void;
1939
2026
  }
@@ -1942,8 +2029,6 @@ declare interface HeaderActionIconOptions {
1942
2029
  iconName: string;
1943
2030
  x: number;
1944
2031
  y: number;
1945
- /** @deprecated 使用 onClick 代替 */
1946
- action?: (props: HeaderIconClickParams) => void;
1947
2032
  onClick?: (headerIconClickParams: HeaderIconClickParams) => void;
1948
2033
  onHover?: (headerIconHoverParams: HeaderIconHoverParams) => void;
1949
2034
  defaultHide?: boolean;
@@ -2045,14 +2130,14 @@ declare interface HoverFocusOptions {
2045
2130
  duration?: number;
2046
2131
  }
2047
2132
 
2048
- declare type IconCfg = Pick<IconTheme, 'size' | 'margin'> & Pick<IconCondition, 'position'>;
2049
-
2050
2133
  declare interface IconCondition extends Condition {
2051
2134
  position?: IconPosition;
2052
2135
  }
2053
2136
 
2054
2137
  declare type IconPosition = 'left' | 'right';
2055
2138
 
2139
+ declare type IconStyle = Pick<IconTheme, 'size' | 'margin'> & Pick<IconCondition, 'position'>;
2140
+
2056
2141
  declare interface IconTheme {
2057
2142
  fill?: string;
2058
2143
  downIconColor?: string;
@@ -2273,8 +2358,17 @@ declare interface MergedCellInfo {
2273
2358
  }
2274
2359
 
2275
2360
  declare interface Meta {
2361
+ /**
2362
+ * 字段 id
2363
+ */
2276
2364
  field?: string;
2365
+ /**
2366
+ * 字段名称
2367
+ */
2277
2368
  name?: string;
2369
+ /**
2370
+ * 字段描述
2371
+ */
2278
2372
  description?: string;
2279
2373
  formatter?: Formatter;
2280
2374
  }
@@ -2297,15 +2391,16 @@ declare enum MiniChartTypes {
2297
2391
 
2298
2392
  declare type MouseEventHandler = (event: MouseEvent) => void;
2299
2393
 
2300
- /** use for gridAnalysisSheet
2394
+ /**
2395
+ * use for gridAnalysisSheet
2301
2396
  * eg. { label: '余额女',
2302
- values: [
2303
- ['最近7天登端天数', 1, 3423423, 323],
2304
- ['自然月新登用户数', 1, 3423423, 323],
2305
- ['最近7天登端天数', 1, 3423423, 323],
2306
- ['自然月新登用户数', 1, 3423423, 323],
2307
- ],
2308
- }
2397
+ * values: [
2398
+ * ['最近7天登端天数', 1, 3423423, 323],
2399
+ * ['自然月新登用户数', 1, 3423423, 323],
2400
+ * ['最近7天登端天数', 1, 3423423, 323],
2401
+ * ['自然月新登用户数', 1, 3423423, 323],
2402
+ * ],
2403
+ * }
2309
2404
  */
2310
2405
  declare interface MultiData<T = SimpleData[][] | MiniChartData> {
2311
2406
  values: T;
@@ -2346,8 +2441,14 @@ declare class Node_2_2 {
2346
2441
  cornerType?: CornerNodeType;
2347
2442
  isGrandTotals?: boolean;
2348
2443
  isSubTotals?: boolean;
2444
+ hiddenChildNodeInfo?: HiddenColumnsInfo_2 | null;
2445
+ extra?: {
2446
+ description?: string;
2447
+ isCustomNode?: boolean;
2448
+ [key: string]: any;
2449
+ };
2349
2450
  [key: string]: any;
2350
- constructor({ id, field, value, parent, level, rowIndex, isTotals, isGrandTotals, isSubTotals, isCollapsed, hierarchy, isPivotMode, seriesNumberWidth, spreadsheet, query, belongsCell, inCollapseNode, isTotalMeasure, isLeaf, extra, }: BaseNodeConfig);
2451
+ constructor(cfg: BaseNodeConfig);
2351
2452
  /**
2352
2453
  * Get node's field path
2353
2454
  * eg: node.id = root[&]东北[&]黑龙江
@@ -2399,8 +2500,10 @@ declare class Node_2_2 {
2399
2500
  getHeadLeafChild(): Node_2_2 | undefined;
2400
2501
  /**
2401
2502
  * 获取树状模式下,当前节点以及其所有子节点的高度总和
2402
- * */
2503
+ *
2504
+ */
2403
2505
  getTotalHeightForTreeHierarchy(): number;
2506
+ isSeriesNumberNode(): boolean;
2404
2507
  }
2405
2508
 
2406
2509
  declare interface OffsetConfig {
@@ -2451,6 +2554,8 @@ declare interface PaletteMeta {
2451
2554
  [key: string]: string;
2452
2555
  };
2453
2556
  others?: {
2557
+ results: string;
2558
+ highlight: string;
2454
2559
  [key: string]: string;
2455
2560
  };
2456
2561
  }
@@ -2522,14 +2627,12 @@ type: PropType<Adaptive>;
2522
2627
  default: Adaptive;
2523
2628
  };
2524
2629
  onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet>;
2525
- onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet) => void>;
2526
2630
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
2527
2631
  }, {
2528
2632
  s2Ref: ShallowRef<SheetExpose>;
2529
2633
  options: S2Options<TooltipContentType, Pagination, string | Element, string>;
2530
2634
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
2531
2635
  spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet;
2532
- getSpreadSheet: (spreadsheet: SpreadSheet) => void;
2533
2636
  sheetUpdate: SheetUpdateCallback;
2534
2637
  rowCellHover: (data: TargetCellInfo) => void;
2535
2638
  rowCellClick: (data: TargetCellInfo) => void;
@@ -2585,7 +2688,6 @@ filteredValues: string[];
2585
2688
  rangeFiltered: (data: ViewMetaData[]) => void;
2586
2689
  layoutAfterHeaderLayout: (layoutResult: LayoutResult) => void;
2587
2690
  layoutPagination: (data: LayoutPaginationParams) => void;
2588
- layoutCellScroll: (position: CellScrollPosition) => void;
2589
2691
  layoutCellMounted: (cell: S2CellType<ViewMeta>) => void;
2590
2692
  beforeRender: () => void;
2591
2693
  afterRender: () => void;
@@ -2664,7 +2766,6 @@ type: PropType<Adaptive>;
2664
2766
  default: Adaptive;
2665
2767
  };
2666
2768
  onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => SpreadSheet>;
2667
- onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet) => void>;
2668
2769
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
2669
2770
  }>> & {
2670
2771
  onSheetUpdate?: (params: S2RenderOptions) => any;
@@ -2722,7 +2823,6 @@ filteredValues: string[];
2722
2823
  onRangeFiltered?: (data: ViewMetaData[]) => any;
2723
2824
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult) => any;
2724
2825
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
2725
- onLayoutCellScroll?: (position: CellScrollPosition) => any;
2726
2826
  onLayoutCellMounted?: (cell: S2CellType<ViewMeta>) => any;
2727
2827
  onBeforeRender?: () => any;
2728
2828
  onAfterRender?: () => any;
@@ -2776,7 +2876,6 @@ spreadsheet: SpreadSheet;
2776
2876
  onRowCellBrushSelection?: (event: GEvent) => any;
2777
2877
  onColCellBrushSelection?: (event: GEvent) => any;
2778
2878
  onSpreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, string | Element, string>) => any;
2779
- onGetSpreadSheet?: (spreadsheet: SpreadSheet) => any;
2780
2879
  }, {
2781
2880
  options: S2Options<TooltipContentType, Pagination, string | Element, string>;
2782
2881
  loading: boolean;
@@ -2796,6 +2895,8 @@ declare interface Point {
2796
2895
  y: number;
2797
2896
  }
2798
2897
 
2898
+ declare type PointerEventHandler = (event: PointerEvent) => void;
2899
+
2799
2900
  declare interface PointObject {
2800
2901
  x: number;
2801
2902
  y: number;
@@ -2839,7 +2940,9 @@ declare enum ResizeAreaEffect {
2839
2940
  }
2840
2941
 
2841
2942
  declare enum ResizeDirectionType {
2943
+ /** 水平方向 resize */
2842
2944
  Horizontal = "col",
2945
+ /** 垂直方向 resize */
2843
2946
  Vertical = "row"
2844
2947
  }
2845
2948
 
@@ -2870,11 +2973,17 @@ declare interface ResizeInfo_2 {
2870
2973
  }
2871
2974
 
2872
2975
  declare interface ResizeInteractionOptions {
2976
+ /** 行头垂直方向 resize -> 针对行头叶子节点 */
2873
2977
  rowCellVertical?: boolean;
2978
+ /** 角头水平方向 resize -> 针对角头 CornerNodeType 为 Series 和 Row */
2874
2979
  cornerCellHorizontal?: boolean;
2980
+ /** 列头水平方向 resize -> 针对列头叶子节点 */
2875
2981
  colCellHorizontal?: boolean;
2982
+ /** 列头垂直方向 resize -> 针对列头各层级节点 */
2876
2983
  colCellVertical?: boolean;
2984
+ /** 行高调整时,影响当前行还是全部行 */
2877
2985
  rowResizeType?: ResizeType;
2986
+ /** 列高调整时,影响当前列还是全部列 */
2878
2987
  colResizeType?: ResizeType;
2879
2988
  disable?: (resizeInfo: ResizeInfo_2) => boolean;
2880
2989
  visible?: (cell: S2CellType_2) => boolean;
@@ -2951,6 +3060,8 @@ declare class RootInteraction {
2951
3060
 
2952
3061
  declare class RowCell extends HeaderCell {
2953
3062
  protected headerConfig: RowHeaderConfig;
3063
+ /** icon 绘制起始坐标 */
3064
+ protected iconPosition: PointLike;
2954
3065
  get cellType(): CellTypes;
2955
3066
  protected getBorderPositions(): CellBorderPosition[];
2956
3067
  protected initCell(): void;
@@ -2968,10 +3079,7 @@ declare class RowCell extends HeaderCell {
2968
3079
  protected getContentIndent(): number;
2969
3080
  protected getTextIndent(): number;
2970
3081
  protected isTreeLevel(): any;
2971
- protected getIconPosition(): {
2972
- x: number;
2973
- y: number;
2974
- };
3082
+ protected getIconPosition(): PointLike;
2975
3083
  protected getMaxTextWidth(): number;
2976
3084
  protected getTextArea(): {
2977
3085
  x: number;
@@ -2980,7 +3088,6 @@ declare class RowCell extends HeaderCell {
2980
3088
  height: number;
2981
3089
  };
2982
3090
  protected getTextPosition(): PointLike;
2983
- protected getIconYPosition(): number;
2984
3091
  }
2985
3092
 
2986
3093
  declare type RowCellCollapsedParams_2 = {
@@ -3158,10 +3265,25 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
3158
3265
  declare type S2CellType_2<T extends SimpleBBox = ViewMeta_2> = DataCell_2 | HeaderCell | ColCell | CornerCell | RowCell | SeriesNumberCell | MergedCell | TableCornerCell | TableSeriesCell | BaseCell<T>;
3159
3266
 
3160
3267
  declare interface S2DataConfig_2 {
3268
+ /**
3269
+ * 原始明细数据
3270
+ */
3161
3271
  data: RawData_2[];
3272
+ /**
3273
+ * 维度字段
3274
+ */
3162
3275
  fields: Fields;
3276
+ /**
3277
+ * 字段元数据
3278
+ */
3163
3279
  meta?: Meta[];
3280
+ /**
3281
+ * 排序配置
3282
+ */
3164
3283
  sortParams?: SortParams_2;
3284
+ /**
3285
+ * 筛选配置
3286
+ */
3165
3287
  filterParams?: FilterParam[];
3166
3288
  [key: string]: unknown;
3167
3289
  }
@@ -3226,8 +3348,6 @@ declare enum S2Event {
3226
3348
  RANGE_FILTERED = "filter:range-filtered",
3227
3349
  /** ================ Table Layout ================ */
3228
3350
  LAYOUT_AFTER_HEADER_LAYOUT = "layout:after-header-layout",
3229
- /** @deprecated 已废弃, 请使用 S2Event.GLOBAL_SCROLL 代替 */
3230
- LAYOUT_CELL_SCROLL = "layout:cell-scroll",
3231
3351
  LAYOUT_CELL_MOUNTED = "layout:cell-mounted",
3232
3352
  LAYOUT_PAGINATION = "layout:pagination",
3233
3353
  LAYOUT_AFTER_REAL_DATA_CELL_RENDER = "layout:after-real-data-cell-render",
@@ -3277,9 +3397,11 @@ declare interface S2Options_2<T = TooltipContentType_2, P = Pagination_2, Icon =
3277
3397
 
3278
3398
  declare interface S2PivotSheetFrozenOptions {
3279
3399
  /**
3280
- * 是否冻结行头 (含角头区域, 透视表有效)
3400
+ * 是否冻结行头 (含角头区域, 透视表有效),
3401
+ * 当值为 number 时,标识行头冻结的最大区域,取值范围: (0, 1),0 表示不固定行头
3402
+ * 当值为 boolean 时,true 对应冻结最大区域为 0.5, false 对应 0
3281
3403
  */
3282
- rowHeader?: boolean;
3404
+ rowHeader?: boolean | number;
3283
3405
  }
3284
3406
 
3285
3407
  declare interface S2PivotSheetOptions {
@@ -3337,10 +3459,6 @@ declare interface S2Style {
3337
3459
  * 行头单元格配置
3338
3460
  */
3339
3461
  rowCell?: RowCellStyle | null;
3340
- /**
3341
- * @deprecated 设备类型 use options.device instead
3342
- */
3343
- device?: DeviceType;
3344
3462
  }
3345
3463
 
3346
3464
  declare interface S2TableSheetFrozenOptions {
@@ -3382,7 +3500,6 @@ declare class ScrollBar extends Group {
3382
3500
  trackShape: DisplayObject;
3383
3501
  thumbShape: DisplayObject;
3384
3502
  private startPos;
3385
- private isMobile;
3386
3503
  private clearEvents;
3387
3504
  private eventHandlers;
3388
3505
  private scrollFrameId;
@@ -3425,10 +3542,10 @@ declare class ScrollBar extends Group {
3425
3542
  private onStartEvent;
3426
3543
  private bindLaterEvent;
3427
3544
  private onTrackClick;
3428
- private onMouseMove;
3429
- private onMouseUp;
3430
- private onTrackMouseOver;
3431
- private onTrackMouseOut;
3545
+ private onPointerMove;
3546
+ private onPointerUp;
3547
+ private onTrackPointerOver;
3548
+ private onTrackPointerOut;
3432
3549
  private validateRange;
3433
3550
  }
3434
3551
 
@@ -3513,7 +3630,7 @@ declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
3513
3630
  protected offset(): void;
3514
3631
  }
3515
3632
 
3516
- export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
3633
+ export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
3517
3634
  s2Ref: ShallowRef<SheetExpose>;
3518
3635
  sheetType: ComputedRef<DefineComponent< {
3519
3636
  sheetType: PropType<SheetType>;
@@ -3541,14 +3658,12 @@ type: PropType<Adaptive>;
3541
3658
  default: Adaptive;
3542
3659
  };
3543
3660
  onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2>;
3544
- onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet_2) => void>;
3545
3661
  onMounted: PropType<(spreadsheet: SpreadSheet_2) => void>;
3546
3662
  }, {
3547
3663
  s2Ref: ShallowRef<SheetExpose>;
3548
3664
  options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>;
3549
3665
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3550
3666
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
3551
- getSpreadSheet: (spreadsheet: SpreadSheet_2) => void;
3552
3667
  sheetUpdate: SheetUpdateCallback;
3553
3668
  rowCellHover: (data: TargetCellInfo_2) => void;
3554
3669
  rowCellClick: (data: TargetCellInfo_2) => void;
@@ -3604,7 +3719,6 @@ filteredValues: string[];
3604
3719
  rangeFiltered: (data: ViewMetaData_2[]) => void;
3605
3720
  layoutAfterHeaderLayout: (layoutResult: LayoutResult_2) => void;
3606
3721
  layoutPagination: (data: LayoutPaginationParams) => void;
3607
- layoutCellScroll: (position: CellScrollPosition_2) => void;
3608
3722
  layoutCellMounted: (cell: S2CellType_2<ViewMeta_2>) => void;
3609
3723
  beforeRender: () => void;
3610
3724
  afterRender: () => void;
@@ -3683,7 +3797,6 @@ type: PropType<Adaptive>;
3683
3797
  default: Adaptive;
3684
3798
  };
3685
3799
  onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2>;
3686
- onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet_2) => void>;
3687
3800
  onMounted: PropType<(spreadsheet: SpreadSheet_2) => void>;
3688
3801
  }>> & {
3689
3802
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
@@ -3741,7 +3854,6 @@ filteredValues: string[];
3741
3854
  onRangeFiltered?: (data: ViewMetaData_2[]) => any;
3742
3855
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult_2) => any;
3743
3856
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
3744
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
3745
3857
  onLayoutCellMounted?: (cell: S2CellType_2<ViewMeta_2>) => any;
3746
3858
  onBeforeRender?: () => any;
3747
3859
  onAfterRender?: () => any;
@@ -3795,7 +3907,6 @@ spreadsheet: SpreadSheet_2;
3795
3907
  onRowCellBrushSelection?: (event: FederatedPointerEvent) => any;
3796
3908
  onColCellBrushSelection?: (event: FederatedPointerEvent) => any;
3797
3909
  onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
3798
- onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
3799
3910
  }, {
3800
3911
  options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>;
3801
3912
  loading: boolean;
@@ -3808,11 +3919,10 @@ showPagination: boolean | {
3808
3919
  onShowSizeChange?: (pageSize: number) => void;
3809
3920
  onChange?: (current: number) => void;
3810
3921
  };
3811
- }> | DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
3922
+ }> | DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
3812
3923
  s2Ref: ShallowRef<SheetExpose>;
3813
3924
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3814
3925
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
3815
- getSpreadSheet: (spreadsheet: SpreadSheet_2) => void;
3816
3926
  sheetUpdate: SheetUpdateCallback;
3817
3927
  rowCellHover: (data: TargetCellInfo_2) => void;
3818
3928
  rowCellClick: (data: TargetCellInfo_2) => void;
@@ -3868,7 +3978,6 @@ filteredValues: string[];
3868
3978
  rangeFiltered: (data: ViewMetaData_2[]) => void;
3869
3979
  layoutAfterHeaderLayout: (layoutResult: LayoutResult_2) => void;
3870
3980
  layoutPagination: (data: LayoutPaginationParams) => void;
3871
- layoutCellScroll: (position: CellScrollPosition_2) => void;
3872
3981
  layoutCellMounted: (cell: S2CellType_2<ViewMeta_2>) => void;
3873
3982
  beforeRender: () => void;
3874
3983
  afterRender: () => void;
@@ -3921,7 +4030,7 @@ spreadsheet: SpreadSheet_2;
3921
4030
  }) => void;
3922
4031
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
3923
4032
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
3924
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
4033
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
3925
4034
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
3926
4035
  onRowCellHover?: (data: TargetCellInfo_2) => any;
3927
4036
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -3977,7 +4086,6 @@ filteredValues: string[];
3977
4086
  onRangeFiltered?: (data: ViewMetaData_2[]) => any;
3978
4087
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult_2) => any;
3979
4088
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
3980
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
3981
4089
  onLayoutCellMounted?: (cell: S2CellType_2<ViewMeta_2>) => any;
3982
4090
  onBeforeRender?: () => any;
3983
4091
  onAfterRender?: () => any;
@@ -4031,11 +4139,9 @@ spreadsheet: SpreadSheet_2;
4031
4139
  onRowCellBrushSelection?: (event: FederatedPointerEvent) => any;
4032
4140
  onColCellBrushSelection?: (event: FederatedPointerEvent) => any;
4033
4141
  onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
4034
- onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
4035
4142
  }, {}>>;
4036
4143
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
4037
4144
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
4038
- getSpreadSheet: (spreadsheet: SpreadSheet_2) => void;
4039
4145
  sheetUpdate: SheetUpdateCallback;
4040
4146
  rowCellHover: (data: TargetCellInfo_2) => void;
4041
4147
  rowCellClick: (data: TargetCellInfo_2) => void;
@@ -4091,7 +4197,6 @@ filteredValues: string[];
4091
4197
  rangeFiltered: (data: ViewMetaData_2[]) => void;
4092
4198
  layoutAfterHeaderLayout: (layoutResult: LayoutResult_2) => void;
4093
4199
  layoutPagination: (data: LayoutPaginationParams) => void;
4094
- layoutCellScroll: (position: CellScrollPosition_2) => void;
4095
4200
  layoutCellMounted: (cell: S2CellType_2<ViewMeta_2>) => void;
4096
4201
  beforeRender: () => void;
4097
4202
  afterRender: () => void;
@@ -4144,7 +4249,7 @@ spreadsheet: SpreadSheet_2;
4144
4249
  }) => void;
4145
4250
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
4146
4251
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
4147
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
4252
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
4148
4253
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
4149
4254
  onRowCellHover?: (data: TargetCellInfo_2) => any;
4150
4255
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -4200,7 +4305,6 @@ filteredValues: string[];
4200
4305
  onRangeFiltered?: (data: ViewMetaData_2[]) => any;
4201
4306
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult_2) => any;
4202
4307
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
4203
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
4204
4308
  onLayoutCellMounted?: (cell: S2CellType_2<ViewMeta_2>) => any;
4205
4309
  onBeforeRender?: () => any;
4206
4310
  onAfterRender?: () => any;
@@ -4254,7 +4358,6 @@ spreadsheet: SpreadSheet_2;
4254
4358
  onRowCellBrushSelection?: (event: FederatedPointerEvent) => any;
4255
4359
  onColCellBrushSelection?: (event: FederatedPointerEvent) => any;
4256
4360
  onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
4257
- onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
4258
4361
  }, {}>;
4259
4362
 
4260
4363
  declare type SheetComponentOptions = S2Options<TooltipContentType, Pagination & PaginationProps>;
@@ -4342,6 +4445,8 @@ declare abstract class SpreadSheet_2 extends EE {
4342
4445
  on: <K extends keyof EmitterType>(event: K, listener: EmitterType[K]) => this;
4343
4446
  emit: <K extends keyof EmitterType>(event: K, ...args: Parameters<EmitterType[K]>) => boolean;
4344
4447
  constructor(dom: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2 | null);
4448
+ isCustomHeaderFields(fieldType?: keyof Pick<Fields, 'columns' | 'rows'>): boolean;
4449
+ isCustomColumnFields(): boolean;
4345
4450
  private setOverscrollBehavior;
4346
4451
  private restoreOverscrollBehavior;
4347
4452
  private setDebug;
@@ -4361,18 +4466,11 @@ declare abstract class SpreadSheet_2 extends EE {
4361
4466
  * Check if is pivot mode
4362
4467
  */
4363
4468
  abstract isPivotMode(): boolean;
4364
- abstract isCustomHeaderFields(fieldType?: keyof Pick<Fields, 'columns' | 'rows'>): boolean;
4365
4469
  abstract isCustomRowFields(): boolean;
4366
- abstract isCustomColumnFields(): boolean;
4367
4470
  /**
4368
4471
  * tree type must be in strategy mode
4369
4472
  */
4370
4473
  abstract isHierarchyTreeType(): boolean;
4371
- /**
4372
- * Check whether scroll contains row header
4373
- * For now contains row header in ListSheet mode by default
4374
- */
4375
- abstract isScrollContainsRowHeader(): boolean;
4376
4474
  /**
4377
4475
  * Scroll Freeze Row Header
4378
4476
  */
@@ -4415,12 +4513,6 @@ declare abstract class SpreadSheet_2 extends EE {
4415
4513
  * 获取当前表格实际内容高度
4416
4514
  */
4417
4515
  getContentHeight(): number;
4418
- /**
4419
- * @param width
4420
- * @param height
4421
- * @deprecated 该方法将会在2.0被移除, 请使用 changeSheetSize 代替
4422
- */
4423
- changeSize(width?: number, height?: number): void;
4424
4516
  /**
4425
4517
  * 修改表格画布大小,不用重新加载数据
4426
4518
  * @param width
@@ -4584,11 +4676,10 @@ declare class TableSeriesCell extends TableDataCell {
4584
4676
  protected getTextStyle(): TextTheme;
4585
4677
  }
4586
4678
 
4587
- export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
4679
+ export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
4588
4680
  s2Ref: ShallowRef<SheetExpose>;
4589
4681
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
4590
4682
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
4591
- getSpreadSheet: (spreadsheet: SpreadSheet_2) => void;
4592
4683
  sheetUpdate: SheetUpdateCallback;
4593
4684
  rowCellHover: (data: TargetCellInfo_2) => void;
4594
4685
  rowCellClick: (data: TargetCellInfo_2) => void;
@@ -4644,7 +4735,6 @@ filteredValues: string[];
4644
4735
  rangeFiltered: (data: ViewMetaData_2[]) => void;
4645
4736
  layoutAfterHeaderLayout: (layoutResult: LayoutResult_2) => void;
4646
4737
  layoutPagination: (data: LayoutPaginationParams) => void;
4647
- layoutCellScroll: (position: CellScrollPosition_2) => void;
4648
4738
  layoutCellMounted: (cell: S2CellType_2<ViewMeta_2>) => void;
4649
4739
  beforeRender: () => void;
4650
4740
  afterRender: () => void;
@@ -4697,7 +4787,7 @@ spreadsheet: SpreadSheet_2;
4697
4787
  }) => void;
4698
4788
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
4699
4789
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
4700
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
4790
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "renderConfig" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellMounted" | "onBeforeRender" | "onAfterRender" | "onMounted" | "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" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
4701
4791
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
4702
4792
  onRowCellHover?: (data: TargetCellInfo_2) => any;
4703
4793
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -4753,7 +4843,6 @@ filteredValues: string[];
4753
4843
  onRangeFiltered?: (data: ViewMetaData_2[]) => any;
4754
4844
  onLayoutAfterHeaderLayout?: (layoutResult: LayoutResult_2) => any;
4755
4845
  onLayoutPagination?: (data: LayoutPaginationParams) => any;
4756
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
4757
4846
  onLayoutCellMounted?: (cell: S2CellType_2<ViewMeta_2>) => any;
4758
4847
  onBeforeRender?: () => any;
4759
4848
  onAfterRender?: () => any;
@@ -4807,7 +4896,6 @@ spreadsheet: SpreadSheet_2;
4807
4896
  onRowCellBrushSelection?: (event: FederatedPointerEvent) => any;
4808
4897
  onColCellBrushSelection?: (event: FederatedPointerEvent) => any;
4809
4898
  onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
4810
- onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
4811
4899
  }, {}>;
4812
4900
 
4813
4901
  declare interface TargetCellInfo_2 {
@@ -4818,14 +4906,14 @@ declare interface TargetCellInfo_2 {
4818
4906
 
4819
4907
  declare type TextAlign = 'left' | 'center' | 'right';
4820
4908
 
4821
- declare interface TextAlignCfg {
4909
+ declare interface TextAlignStyle {
4822
4910
  textAlign?: TextAlign;
4823
4911
  textBaseline?: TextBaseline;
4824
4912
  }
4825
4913
 
4826
4914
  declare type TextBaseline = 'top' | 'middle' | 'bottom';
4827
4915
 
4828
- declare interface TextTheme extends TextAlignCfg {
4916
+ declare interface TextTheme extends TextAlignStyle {
4829
4917
  fontFamily?: string;
4830
4918
  fontSize?: number;
4831
4919
  fontWeight?: number | 'normal' | 'bold' | 'bolder' | 'lighter';
@@ -4962,10 +5050,13 @@ declare type TooltipShowOptions<T = TooltipContentType_2, Icon = Element | strin
4962
5050
 
4963
5051
  declare interface TooltipSummaryOptions {
4964
5052
  name: string | null;
4965
- value: number | string | undefined | null;
4966
- selectedData: Data[] | CellData[];
5053
+ selectedData: TooltipDataItem[];
5054
+ value: TooltipSummaryOptionsValue;
5055
+ originValue?: TooltipSummaryOptionsValue;
4967
5056
  }
4968
5057
 
5058
+ declare type TooltipSummaryOptionsValue = number | string | undefined | null;
5059
+
4969
5060
  declare interface Total {
4970
5061
  /** 是否显示总计 */
4971
5062
  showGrandTotals: boolean;
@@ -5050,6 +5141,7 @@ declare interface ViewMeta_2 {
5050
5141
  label?: string;
5051
5142
  value?: string | number;
5052
5143
  query?: Query;
5144
+ isLeaf?: boolean;
5053
5145
  [key: string]: unknown;
5054
5146
  }
5055
5147