@antv/s2-vue 2.0.0-next.13 → 2.0.0-next.15

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.
Files changed (11) hide show
  1. package/dist/index.min.js +1 -1
  2. package/dist/index.min.js.map +1 -1
  3. package/dist/style.min.css +1 -1
  4. package/esm/index.d.ts +283 -182
  5. package/esm/index.js +248 -163
  6. package/esm/index.js.map +1 -1
  7. package/esm/style.css +4 -1
  8. package/lib/index.js +246 -161
  9. package/lib/index.js.map +1 -1
  10. package/lib/style.css +4 -1
  11. package/package.json +37 -37
package/esm/index.d.ts CHANGED
@@ -1,11 +1,9 @@
1
- import { AllowedComponentProps } from 'vue';
2
1
  import { BaseTooltip } from '@antv/s2';
3
2
  import { BaseTooltipOperatorMenuOptions } from '@antv/s2';
4
3
  import { Canvas } from '@antv/g';
5
4
  import { CanvasConfig } from '@antv/g';
6
5
  import type { CellScrollPosition } from '@antv/s2';
7
6
  import { ColCell } from '@antv/s2';
8
- import { ComponentCustomProps } from 'vue';
9
7
  import { ComponentOptionsMixin } from 'vue';
10
8
  import { ComputedRef } from 'vue';
11
9
  import { CopyableList } from '@antv/s2';
@@ -22,7 +20,6 @@ import { ExtractPropTypes } from 'vue';
22
20
  import { FederatedPointerEvent } from '@antv/g';
23
21
  import { GEvent } from '@antv/s2';
24
22
  import { Group } from '@antv/g';
25
- import { Group as Group_2 } from '@antv/g-lite';
26
23
  import type { HeaderActionIcon } from '@antv/s2';
27
24
  import { HiddenColumnsInfo } from '@antv/s2';
28
25
  import { ICanvas } from '@antv/g';
@@ -41,6 +38,7 @@ import type { PaginationProps } from 'ant-design-vue';
41
38
  import { PointLike } from '@antv/g';
42
39
  import { Polygon } from '@antv/g';
43
40
  import { PropType } from 'vue';
41
+ import { PublicProps } from 'vue';
44
42
  import { RawData } from '@antv/s2';
45
43
  import { Rect } from '@antv/g';
46
44
  import { Rectangle } from '@antv/g';
@@ -67,7 +65,6 @@ import { Timer } from 'd3-timer';
67
65
  import { TooltipContentType } from '@antv/s2';
68
66
  import { ViewMeta } from '@antv/s2';
69
67
  import { ViewMetaData } from '@antv/s2';
70
- import { VNodeProps } from 'vue';
71
68
 
72
69
  declare type Adaptive = boolean | {
73
70
  width?: boolean;
@@ -92,11 +89,6 @@ declare interface AreaRange {
92
89
  size: number;
93
90
  }
94
91
 
95
- declare interface Background {
96
- opacity?: number;
97
- color?: string;
98
- }
99
-
100
92
  declare type BackgroundCondition = Condition<BackgroundConditionMappingResult>;
101
93
 
102
94
  declare type BackgroundConditionMappingResult = {
@@ -108,6 +100,11 @@ declare type BackgroundConditionMappingResult = {
108
100
  intelligentReverseTextColor?: boolean;
109
101
  };
110
102
 
103
+ declare interface BackgroundTheme {
104
+ opacity?: number;
105
+ color?: string;
106
+ }
107
+
111
108
  /** 柱状图样式配置 */
112
109
  declare interface BarTheme {
113
110
  intervalPadding?: number;
@@ -166,7 +163,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
166
163
  protected abstract getBorderPositions(): CellBorderPosition[];
167
164
  protected abstract getTextStyle(): TextTheme;
168
165
  protected abstract getFormattedFieldValue(): FormatResult;
169
- protected abstract getMaxTextWidth(): number;
166
+ abstract getMaxTextWidth(): number;
170
167
  protected abstract getTextPosition(): PointLike;
171
168
  protected abstract getIconPosition(): PointLike;
172
169
  protected abstract findFieldCondition<Con extends Condition>(conditions?: Con[]): Con | undefined;
@@ -243,7 +240,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
243
240
  getBackgroundShape(): Image_2 | Rect | Polygon;
244
241
  getStateShapes(): Map<StateShapeLayer, DisplayObject<any, any>>;
245
242
  protected getResizeAreaStyle(): ResizeArea;
246
- protected shouldDrawResizeAreaByType(type: keyof ResizeInteractionOptions, cell: S2CellType_2): number | boolean | ((cell: S2CellType_2) => boolean) | ResizeType | ((resizeInfo: ResizeInfo_2) => boolean) | undefined;
243
+ protected shouldDrawResizeAreaByType(type: keyof ResizeInteractionOptions, cell: S2CellType_2): number | boolean | "selected" | "all" | "current" | ((cell: S2CellType_2) => boolean) | ((resizeInfo: ResizeInfo_2) => boolean) | undefined;
247
244
  getBBoxByType(type?: CellClipBox): SimpleBBox;
248
245
  drawBorders(): void;
249
246
  /**
@@ -289,9 +286,9 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
289
286
  opacity?: string | number | undefined;
290
287
  fontFamily?: string | undefined;
291
288
  fontWeight?: number | "bold" | CSSGlobalKeywords | "normal" | "bolder" | "lighter" | undefined;
292
- lineHeight?: string | number | undefined;
293
289
  fontStyle?: CSSGlobalKeywords | "normal" | "italic" | "oblique" | undefined;
294
290
  fontVariant?: string | undefined;
291
+ lineHeight?: string | number | undefined;
295
292
  };
296
293
  /**
297
294
  * 获取默认字体颜色：根据字段标记背景颜色，设置字体颜色
@@ -301,10 +298,12 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
301
298
  protected getDefaultTextFill(textFill: string): string;
302
299
  getBackgroundConditionFill(): {
303
300
  backgroundColor: string;
301
+ backgroundColorOpacity: number;
304
302
  intelligentReverseTextColor: boolean;
305
303
  } | {
306
304
  intelligentReverseTextColor: boolean;
307
305
  backgroundColor?: undefined;
306
+ backgroundColorOpacity?: undefined;
308
307
  };
309
308
  getIconConditionResult(): HeaderActionNameOptions | undefined;
310
309
  protected getActionAndConditionIconWidth(position?: IconPosition): number;
@@ -345,7 +344,7 @@ declare interface BaseChartData {
345
344
  /**
346
345
  * 类型
347
346
  */
348
- type: MiniChartType;
347
+ type: `${MiniChartType}`;
349
348
  /**
350
349
  * 数据
351
350
  */
@@ -414,7 +413,7 @@ declare abstract class BaseDataSet_2 {
414
413
  /**
415
414
  * 获取字段
416
415
  */
417
- private getField;
416
+ getField: (field: CustomHeaderField) => string;
418
417
  /**
419
418
  * 获取字段信息
420
419
  */
@@ -532,12 +531,6 @@ declare abstract class BaseFacet {
532
531
  backgroundGroup: Group;
533
532
  panelGroup: Group;
534
533
  panelScrollGroup: PanelScrollGroup;
535
- frozenRowGroup: FrozenGroup;
536
- frozenColGroup: FrozenGroup;
537
- frozenTrailingRowGroup: FrozenGroup;
538
- frozenTrailingColGroup: FrozenGroup;
539
- frozenTopGroup: FrozenGroup;
540
- frozenBottomGroup: FrozenGroup;
541
534
  foregroundGroup: Group;
542
535
  /**
543
536
  * 当前布局节点信息
@@ -552,11 +545,16 @@ declare abstract class BaseFacet {
552
545
  hRowScrollBar: ScrollBar;
553
546
  vScrollBar: ScrollBar;
554
547
  rowHeader: RowHeader | null;
555
- columnHeader: ColHeader;
548
+ columnHeader: ColHeader | TableColHeader;
556
549
  cornerHeader: CornerHeader;
557
550
  seriesNumberHeader: SeriesNumberHeader | null;
558
551
  centerFrame: Frame;
559
552
  gridInfo: GridInfo;
553
+ protected textWrapNodeHeightCache: Map<string, number>;
554
+ protected textWrapTempRowCell: RowCell | DataCell_2;
555
+ protected textWrapTempColCell: ColCell_2 | TableColCell;
556
+ protected abstract getRowCellInstance(node: Node_2_2 | ViewMeta_2, spreadsheet: SpreadSheet_2, config: Partial<BaseHeaderConfig>): RowCell | DataCell_2;
557
+ protected abstract getColCellInstance(node: Node_2_2, spreadsheet: SpreadSheet_2, config: Partial<BaseHeaderConfig>): ColCell_2;
560
558
  protected abstract doLayout(): LayoutResult_2;
561
559
  protected abstract clip(scrollX: number, scrollY: number): void;
562
560
  abstract calculateXYIndexes(scrollX: number, scrollY: number): PanelIndexes;
@@ -571,7 +569,10 @@ declare abstract class BaseFacet {
571
569
  protected preCellIndexes: PanelIndexes | null;
572
570
  constructor(spreadsheet: SpreadSheet_2);
573
571
  getLayoutResult: () => LayoutResult_2;
572
+ protected initTextWrapTemp(): void;
574
573
  protected initGroups(): void;
574
+ private initForegroundGroup;
575
+ private initBackgroundGroup;
575
576
  protected initPanelGroups(): void;
576
577
  protected getCellCustomSize(node: Node_2_2 | null, size: CellCustomSize): number | null | undefined;
577
578
  protected getRowCellDraggedWidth(node: Node_2_2): number | undefined;
@@ -581,9 +582,9 @@ declare abstract class BaseFacet {
581
582
  protected getRowCellHeight(node: Node_2_2): number | undefined;
582
583
  protected getColCellDraggedWidth(node: Node_2_2): number | undefined;
583
584
  protected getColCellDraggedHeight(node: Node_2_2): number | undefined;
584
- protected getColNodeHeight(colNode: Node_2_2, colsHierarchy: Hierarchy): any;
585
+ protected getColNodeHeight(colNode: Node_2_2, colsHierarchy: Hierarchy, useCache?: boolean): any;
585
586
  protected getDefaultColNodeHeight(colNode: Node_2_2, colsHierarchy: Hierarchy): number;
586
- protected getCellAdaptiveHeight(cell: S2CellType_2, defaultHeight?: number): any;
587
+ protected getNodeAdaptiveHeight(meta: Node_2_2 | ViewMeta_2, cell: S2CellType_2, defaultHeight?: number, useCache?: boolean): any;
587
588
  /**
588
589
  * 将每一层级的采样节点更新为高度最大的节点 (未隐藏, 非汇总节点)
589
590
  */
@@ -629,6 +630,10 @@ declare abstract class BaseFacet {
629
630
  emitPaginationEvent: () => void;
630
631
  private unbindEvents;
631
632
  calculateCellWidthHeight: () => void;
633
+ /**
634
+ * 提供给明细表做 rowOffsets 计算的 hook
635
+ */
636
+ protected abstract calculateRowOffsets(): void;
632
637
  getRealScrollX: (scrollX: number, hRowScroll?: number) => number;
633
638
  protected calculateCornerBBox(): void;
634
639
  protected calculatePanelBBox: () => void;
@@ -651,7 +656,10 @@ declare abstract class BaseFacet {
651
656
  private renderRowScrollBar;
652
657
  getValidScrollBarOffset: (offset: number, maxOffset: number) => number;
653
658
  renderHScrollBar: (width: number, realWidth: number, scrollX: number) => void;
654
- private getScrollbarPosition;
659
+ protected getScrollbarPosition(): {
660
+ maxX: number;
661
+ maxY: number;
662
+ };
655
663
  renderVScrollBar: (height: number, realHeight: number, scrollY: number) => void;
656
664
  getScrollBarOffset: (offset: number, scrollbar: ScrollBar) => number;
657
665
  isScrollOverThePanelArea: ({ offsetX, offsetY }: CellScrollOffset) => boolean;
@@ -746,7 +754,7 @@ declare abstract class BaseFacet {
746
754
  * | 自定义节点 b-1 | 自定义节点 b-1-1 | 指标 1 |
747
755
  * -------------------------------------------------
748
756
  */
749
- adjustRowLeafNodesWidth(params: AdjustLeafNodesParams): void;
757
+ adjustCustomRowLeafNodesWidth(params: AdjustLeafNodesParams): void;
750
758
  /**
751
759
  * @description 自定义列头时, 叶子节点层级不定, 需要自动对齐其高度, 填充空白
752
760
  * ------------------------------------------------------------------------
@@ -757,7 +765,7 @@ declare abstract class BaseFacet {
757
765
  * | 指标 1 | 自定义节点 a-1-1-1 | 指标 2 | |
758
766
  * ----------------------------------------------------------------------
759
767
  */
760
- adjustColLeafNodesHeight(params: AdjustLeafNodesParams): void;
768
+ adjustCustomColLeafNodesHeight(params: AdjustLeafNodesParams): void;
761
769
  adjustLeafNodesSize(type: 'width' | 'height'): ({ leafNodes, hierarchy }: AdjustLeafNodesParams) => void;
762
770
  /**
763
771
  * 获取表头节点 (角头,序号,行头,列头) (含可视区域)
@@ -791,6 +799,11 @@ declare abstract class BaseFacet {
791
799
  * @example facet.getColNodeByIndex(colIndex)
792
800
  */
793
801
  getColNodeByIndex(colIndex: number): Node_2_2 | undefined;
802
+ /**
803
+ * 获取在索引范围内的列头叶子节点
804
+ * @example facet.getColLeafNodesByRange(0,10) 获取索引范围在 0（包括 0） 到 10（包括 10）的列头叶子节点
805
+ */
806
+ getColLeafNodesByRange(minIndex: number, maxIndex: number): Node_2_2[];
794
807
  /**
795
808
  * 根据列头索引获取指定列头叶子节点
796
809
  * @example facet.getColLeafNodes(colIndex)
@@ -845,6 +858,11 @@ declare abstract class BaseFacet {
845
858
  * @example facet.getRowLeafNodeByIndex(rowIndex)
846
859
  */
847
860
  getRowLeafNodeByIndex(rowIndex: number): Node_2_2 | undefined;
861
+ /**
862
+ * 获取在索引范围内的行头叶子节点
863
+ * @example facet.getRowLeafNodesByRange(0,10) 获取索引范围在 0（包括 0） 到 10（包括 10）的行头叶子节点
864
+ */
865
+ getRowLeafNodesByRange(minIndex: number, maxIndex: number): Node_2_2[];
848
866
  /**
849
867
  * 根据 field 获取行头节点
850
868
  * @example facet.getRowNodeByField('number')
@@ -954,21 +972,21 @@ declare interface BaseFields {
954
972
  /**
955
973
  * New Base Header for all headers(cornerHeader, rowHeader, colHeader)
956
974
  * NOTE: Do not use this.cfg(which lays in group) to get header config,
957
- * use {@see headerConfig} instead
975
+ * use @see headerConfig instead
958
976
  */
959
977
  declare abstract class BaseHeader<T extends BaseHeaderConfig> extends Group {
978
+ protected scrollGroup: Group;
979
+ protected frozenGroup: Group;
980
+ protected frozenTrailingGroup: Group;
981
+ protected extraFrozenNodes: Node_2_2[];
982
+ protected abstract initGroups(): void;
960
983
  protected abstract layout(): void;
961
984
  protected abstract offset(): void;
962
985
  protected abstract clip(): void;
963
986
  protected abstract getCellInstance(node: Node_2_2): S2CellType_2;
964
987
  protected headerConfig: T;
965
- protected constructor(config: T);
988
+ constructor(config: T);
966
989
  getHeaderConfig(): T;
967
- /**
968
- * 清空热区，为重绘做准备，防止热区重复渲染
969
- * @param type 当前重绘的header类型
970
- */
971
- protected clearResizeAreaGroup(type: string): void;
972
990
  render(type: string): void;
973
991
  /**
974
992
  * Scroll header group's x,y
@@ -983,6 +1001,11 @@ declare abstract class BaseHeader<T extends BaseHeaderConfig> extends Group {
983
1001
  * @param type
984
1002
  */
985
1003
  onRowScrollX(rowHeaderScrollX: number, type: string): void;
1004
+ /**
1005
+ * 清空热区，为重绘做准备，防止热区重复渲染
1006
+ * @param type 当前重绘的header类型
1007
+ */
1008
+ protected clearResizeAreaGroup(type: string): void;
986
1009
  clear(): void;
987
1010
  /**
988
1011
  * Check whether header cell in viewPort
@@ -993,6 +1016,7 @@ declare abstract class BaseHeader<T extends BaseHeaderConfig> extends Group {
993
1016
  viewportPosition: number;
994
1017
  viewportSize: number;
995
1018
  }) => boolean;
1019
+ getNodes(): Node_2_2[];
996
1020
  }
997
1021
 
998
1022
  /**
@@ -1079,6 +1103,8 @@ default: Adaptive;
1079
1103
  };
1080
1104
  spreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
1081
1105
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
1106
+ onUpdate: PropType<(renderOptions: S2RenderOptions) => S2RenderOptions>;
1107
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions) => void>;
1082
1108
  }, {
1083
1109
  S2_PREFIX_CLS: string;
1084
1110
  wrapperRef: Ref<HTMLDivElement>;
@@ -1154,7 +1180,6 @@ handlePageChange: (nextCurrent: number) => void;
1154
1180
  handlePageSizeChange: (nextSize: number) => void;
1155
1181
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
1156
1182
  spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>) => SpreadSheet;
1157
- sheetUpdate: SheetUpdateCallback;
1158
1183
  rowCellHover: (data: TargetCellInfo) => void;
1159
1184
  rowCellClick: (data: TargetCellInfo) => void;
1160
1185
  rowCellDoubleClick: (data: TargetCellInfo) => void;
@@ -1221,6 +1246,8 @@ layoutCellRender: <T extends S2CellType = S2CellType>(cell: T) => void;
1221
1246
  beforeRender: () => void;
1222
1247
  afterRender: () => void;
1223
1248
  mounted: (spreadsheet: SpreadSheet) => void;
1249
+ update: (renderOptions: S2RenderOptions) => S2RenderOptions;
1250
+ updateAfterRender: (renderOptions: S2RenderOptions) => void;
1224
1251
  destroy: () => void;
1225
1252
  layoutResize: (params: ResizeParams) => void;
1226
1253
  layoutResizeSeriesWidth: (params: ResizeParams) => void;
@@ -1269,7 +1296,7 @@ spreadsheet: SpreadSheet;
1269
1296
  }) => void;
1270
1297
  rowCellBrushSelection: (event: GEvent) => void;
1271
1298
  colCellBrushSelection: (event: GEvent) => void;
1272
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes< {
1299
+ }, string, PublicProps, Readonly<ExtractPropTypes< {
1273
1300
  sheetType: PropType<SheetType>;
1274
1301
  dataCfg: PropType<S2DataConfig>;
1275
1302
  themeCfg: PropType<ThemeCfg>;
@@ -1296,8 +1323,9 @@ default: Adaptive;
1296
1323
  };
1297
1324
  spreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
1298
1325
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
1326
+ onUpdate: PropType<(renderOptions: S2RenderOptions) => S2RenderOptions>;
1327
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions) => void>;
1299
1328
  }>> & {
1300
- onSheetUpdate?: (params: S2RenderOptions) => any;
1301
1329
  onRowCellHover?: (data: TargetCellInfo) => any;
1302
1330
  onRowCellClick?: (data: TargetCellInfo) => any;
1303
1331
  onRowCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -1364,6 +1392,8 @@ onLayoutCellRender?: (cell: S2CellType) => any;
1364
1392
  onBeforeRender?: () => any;
1365
1393
  onAfterRender?: () => any;
1366
1394
  onMounted?: (spreadsheet: SpreadSheet) => any;
1395
+ onUpdate?: (renderOptions: S2RenderOptions) => any;
1396
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions) => any;
1367
1397
  onDestroy?: () => any;
1368
1398
  onLayoutResize?: (params: ResizeParams) => any;
1369
1399
  onLayoutResizeSeriesWidth?: (params: ResizeParams) => any;
@@ -1438,8 +1468,6 @@ declare interface BaseSheetComponentProps<PartialDrillDown = PartDrillDown, Head
1438
1468
  showPagination?: ShowPagination<OverrideShowPagination, Options>;
1439
1469
  themeCfg?: ThemeCfg;
1440
1470
  header?: Header;
1441
- /** 底表 render callback */
1442
- onSheetUpdate?: SheetUpdateCallback;
1443
1471
  onRowCellHover?: (data: TargetCellInfo) => void;
1444
1472
  onRowCellClick?: (data: TargetCellInfo) => void;
1445
1473
  onRowCellDoubleClick?: (data: TargetCellInfo) => void;
@@ -1507,6 +1535,8 @@ declare interface BaseSheetComponentProps<PartialDrillDown = PartDrillDown, Head
1507
1535
  onBeforeRender?: () => void;
1508
1536
  onAfterRender?: () => void;
1509
1537
  onMounted?: (spreadsheet: SpreadSheet) => void;
1538
+ onUpdate?: (renderOptions: S2RenderOptions) => S2RenderOptions;
1539
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions) => void;
1510
1540
  onDestroy?: () => void;
1511
1541
  onLayoutResize?: (params: ResizeParams) => void;
1512
1542
  onLayoutResizeSeriesWidth?: (params: ResizeParams) => void;
@@ -1690,7 +1720,7 @@ declare interface BulletValue {
1690
1720
 
1691
1721
  declare interface CalcTotals {
1692
1722
  /** 聚合方式 */
1693
- aggregation?: Aggregation;
1723
+ aggregation?: `${Aggregation}`;
1694
1724
  /**
1695
1725
  * 自定义计算汇总
1696
1726
  * @see https://s2.antv.antgroup.com/examples/analysis/totals/#custom
@@ -1712,7 +1742,7 @@ declare enum CellBorderPosition {
1712
1742
  RIGHT = "RIGHT"
1713
1743
  }
1714
1744
 
1715
- declare type CellCallback<T extends BaseHeaderConfig, K extends S2CellType_2> = (node: Node_2_2, spreadsheet: SpreadSheet_2, headerConfig: T) => K;
1745
+ declare type CellCallback<T extends Partial<BaseHeaderConfig>, K extends S2CellType_2> = (node: Node_2_2, spreadsheet: SpreadSheet_2, headerConfig: T) => K;
1716
1746
 
1717
1747
  /**
1718
1748
  * 类似 background-clip 属性: https://developer.mozilla.org/en-US/docs/Web/CSS/background-clip
@@ -1823,7 +1853,7 @@ declare class ColCell_2 extends HeaderCell<ColHeaderConfig> {
1823
1853
  protected getBorderPositions(): CellBorderPosition[];
1824
1854
  protected initCell(): void;
1825
1855
  protected getFormattedFieldValue(): FormatResult;
1826
- protected getMaxTextWidth(): number;
1856
+ getMaxTextWidth(): number;
1827
1857
  protected isBolderText(): boolean;
1828
1858
  /**
1829
1859
  * 计算文本位置时候需要，留给后代根据情况（固定列）覆盖
@@ -1879,10 +1909,11 @@ declare interface ColCellStyle extends BaseCellStyle, CellTextWordWrapStyle {
1879
1909
  * Column Header for SpreadSheet
1880
1910
  */
1881
1911
  declare class ColHeader extends BaseHeader<ColHeaderConfig> {
1882
- protected scrollGroup: Group;
1883
- constructor(config: ColHeaderConfig);
1884
- protected getCellInstance(node: Node_2_2): S2CellType_2;
1885
- private initScrollGroup;
1912
+ protected initGroups(): void;
1913
+ protected getCellGroup(node: Node_2_2): Group;
1914
+ protected getCellInstance(node: Node_2_2): ColCell_2;
1915
+ protected appendNode(node: Node_2_2): void;
1916
+ protected layout(): void;
1886
1917
  /**
1887
1918
  * Make colHeader scroll with hScrollBar
1888
1919
  * @param scrollX horizontal offset
@@ -1891,10 +1922,7 @@ declare class ColHeader extends BaseHeader<ColHeaderConfig> {
1891
1922
  */
1892
1923
  onColScroll(scrollX: number, type: string): void;
1893
1924
  protected clip(): void;
1894
- clear(): void;
1895
- protected getCellGroup(node: Node_2_2): Group;
1896
1925
  protected isColCellInRect(node: Node_2_2): boolean;
1897
- protected layout(): void;
1898
1926
  protected offset(): void;
1899
1927
  }
1900
1928
 
@@ -1922,14 +1950,14 @@ declare interface Conditions {
1922
1950
  }
1923
1951
 
1924
1952
  declare type CopyableHTML = {
1925
- type: CopyMIMEType.HTML;
1953
+ type: `${CopyMIMEType.HTML}`;
1926
1954
  content: string;
1927
1955
  };
1928
1956
 
1929
1957
  declare type CopyableList_2 = [CopyablePlain, CopyableHTML];
1930
1958
 
1931
1959
  declare type CopyablePlain = {
1932
- type: CopyMIMEType.PLAIN;
1960
+ type: `${CopyMIMEType.PLAIN}`;
1933
1961
  content: string;
1934
1962
  };
1935
1963
 
@@ -1960,7 +1988,7 @@ declare class CornerCell_2 extends HeaderCell<CornerHeaderConfig> {
1960
1988
  protected drawResizeArea(): void;
1961
1989
  protected showTreeIcon(): boolean;
1962
1990
  protected getTreeIconWidth(): number;
1963
- protected getMaxTextWidth(): number;
1991
+ getMaxTextWidth(): number;
1964
1992
  protected getTextPosition(): PointLike;
1965
1993
  protected getFormattedFieldValue(): FormatResult;
1966
1994
  }
@@ -1972,7 +2000,7 @@ declare interface CornerCellStyle extends CellTextWordWrapStyle {
1972
2000
  * Corner Header for SpreadSheet
1973
2001
  */
1974
2002
  declare class CornerHeader extends BaseHeader<CornerHeaderConfig> {
1975
- constructor(config: CornerHeaderConfig);
2003
+ protected initGroups(): void;
1976
2004
  protected getCellInstance(node: Node_2_2): CornerCell_2;
1977
2005
  /**
1978
2006
  * Get corner Header by config
@@ -1988,19 +2016,16 @@ declare class CornerHeader extends BaseHeader<CornerHeaderConfig> {
1988
2016
  height: number;
1989
2017
  }): Node_2_2[];
1990
2018
  /**
1991
- * Make cornerHeader scroll with hScrollBar
2019
+ * Make cornerHeader scroll with hScrollBar
1992
2020
  * @param scrollX
1993
2021
  */
1994
2022
  onCorScroll(scrollX: number, type: string): void;
1995
- destroy(): void;
1996
2023
  protected layout(): void;
1997
- protected renderCells(): void;
1998
2024
  protected offset(): void;
1999
2025
  protected clip(): void;
2000
- getNodes(): Node_2_2[];
2001
2026
  }
2002
2027
 
2003
- declare type CornerHeaderCallback = (parent: S2CellType_2, spreadsheet: SpreadSheet_2, ...restOptions: unknown[]) => void;
2028
+ declare type CornerHeaderCallback = (cornerHeader: CornerHeader, spreadsheet: SpreadSheet_2, ...restOptions: unknown[]) => void;
2004
2029
 
2005
2030
  declare interface CornerHeaderConfig extends BaseHeaderConfig {
2006
2031
  seriesNumberWidth: number;
@@ -2041,14 +2066,14 @@ declare interface CustomSVGIcon {
2041
2066
 
2042
2067
  import Icon from 'path/to/xxx.svg'
2043
2068
 
2044
- => { name: 'iconA', svg: Icon }
2045
- => { name: 'iconB', svg: '<svg>...</svg>' }
2069
+ => { name: 'iconA', src: Icon }
2070
+ => { name: 'iconB', src: '<svg>...</svg>' }
2046
2071
 
2047
- * @example 3. 线上支持的图片地址
2072
+ * @example 3. 线上支持的图片地址 (不支持改颜色)
2048
2073
  带后缀: https://gw.alipayobjects.com/zos/antfincdn/gu1Fsz3fw0/filter%26sort_filter.svg
2049
2074
  无后缀: https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*5nsESLuvc_EAAAAAAAAAAAAADmJ7AQ/original
2050
2075
  */
2051
- svg: string;
2076
+ src: string;
2052
2077
  }
2053
2078
 
2054
2079
  /**
@@ -2111,11 +2136,12 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
2111
2136
  position: [rowIndex: number, colIndex: number];
2112
2137
  iconPosition: PointLike;
2113
2138
  get cellType(): CellType;
2139
+ isShallowRender(): boolean;
2114
2140
  isMultiData(): boolean;
2115
2141
  isChartData(): boolean;
2116
2142
  getRenderChartData(): BaseChartData;
2117
2143
  getRenderChartOptions(): {
2118
- type: MiniChartType;
2144
+ type: "line" | "bar" | "bullet";
2119
2145
  data: RawData_2[];
2120
2146
  encode?: {
2121
2147
  x: string;
@@ -2146,7 +2172,7 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
2146
2172
  protected drawConditionIntervalShape(): void;
2147
2173
  protected shouldHideRowSubtotalData(): boolean | undefined;
2148
2174
  protected getFormattedFieldValue(): FormatResult;
2149
- protected getMaxTextWidth(): number;
2175
+ getMaxTextWidth(): number;
2150
2176
  protected getTextPosition(): PointLike;
2151
2177
  protected getIconPosition(): PointLike;
2152
2178
  getBackgroundColor(): {
@@ -2155,9 +2181,6 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
2155
2181
  intelligentReverseTextColor: boolean;
2156
2182
  };
2157
2183
  protected changeRowColSelectState(indexType: ViewMetaIndexType): void;
2158
- /**
2159
- * 预留给明细表使用，透视表数据格不需要绘制 border， 已经交由 grid 处理
2160
- */
2161
2184
  drawBorders(): void;
2162
2185
  /**
2163
2186
  * Find current field related condition
@@ -2174,7 +2197,7 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
2174
2197
  private toggleConditionIntervalShapeOpacity;
2175
2198
  }
2176
2199
 
2177
- declare type DataCellCallback = (viewMeta: ViewMeta_2) => DataCell_2;
2200
+ declare type DataCellCallback = (viewMeta: ViewMeta_2, spreadsheet: SpreadSheet_2) => DataCell_2 | TableDataCell_2;
2178
2201
 
2179
2202
  declare interface DataCellStyle extends CellTextWordWrapStyle {
2180
2203
  /**
@@ -2214,13 +2237,19 @@ declare type DeepRequired<T extends Record<string, any>> = {
2214
2237
  };
2215
2238
 
2216
2239
  declare interface DefaultCellTheme extends GridAnalysisCellTheme {
2217
- /** 粗体文本样式 */
2240
+ /**
2241
+ * 粗体文本样式 (如: 总计, 小计, 行列头非叶子节点文本)
2242
+ * @see https://s2.antv.antgroup.com/manual/advanced/custom/cell-align#%E8%A1%8C%E5%A4%B4%E5%AF%B9%E9%BD%90%E6%96%B9%E5%BC%8F
2243
+ */
2218
2244
  bolderText?: TextTheme;
2219
- /** 文本样式 */
2245
+ /** 文本样式 (如: 数值, 行列头叶子节点文本) */
2220
2246
  text?: TextTheme;
2221
- /** 序号样式 */
2247
+ /** 序号文本样式 */
2222
2248
  seriesText?: TextTheme;
2223
- /** 度量值文本样式 */
2249
+ /**
2250
+ * 度量值文本样式 (如: 数值挂行/列头时, 行列头所对应的虚拟数值单元格文本)
2251
+ * @see https://s2.antv.antgroup.com/manual/advanced/custom/cell-align#%E5%88%97%E5%A4%B4%E5%AF%B9%E9%BD%90%E6%96%B9%E5%BC%8F
2252
+ */
2224
2253
  measureText?: TextTheme;
2225
2254
  /** 单元格样式 */
2226
2255
  cell?: CellTheme;
@@ -2354,6 +2383,16 @@ declare interface EmitterType {
2354
2383
  [S2Event.LAYOUT_RESIZE_TREE_WIDTH]: ResizeHandler;
2355
2384
  }
2356
2385
 
2386
+ declare interface EmptyTheme {
2387
+ /** 空状态图标 */
2388
+ icon?: Omit_2<IconTheme, 'size'> & {
2389
+ width?: number;
2390
+ height?: number;
2391
+ };
2392
+ /** 空状态文案 */
2393
+ description?: Pick<TextStyleProps, 'fontFamily' | 'fontSize' | 'fontWeight' | 'fill' | 'opacity' | 'fontStyle' | 'fontVariant'>;
2394
+ }
2395
+
2357
2396
  declare class EventController {
2358
2397
  spreadsheet: SpreadSheet_2;
2359
2398
  private target;
@@ -2490,7 +2529,11 @@ declare interface FrameConfig {
2490
2529
  spreadsheet: SpreadSheet_2;
2491
2530
  }
2492
2531
 
2493
- declare class FrozenGroup extends GridGroup {
2532
+ declare enum FrozenGroupArea {
2533
+ Row = "frozenRow",
2534
+ Col = "frozenCol",
2535
+ TrailingRow = "frozenTrailingRow",
2536
+ TrailingCol = "frozenTrailingCol"
2494
2537
  }
2495
2538
 
2496
2539
  declare interface GetCellDataParams {
@@ -2583,7 +2626,7 @@ declare class GuiIcon extends Group {
2583
2626
  private cfg;
2584
2627
  constructor(cfg: GuiIconCfg);
2585
2628
  getCfg(): GuiIconCfg;
2586
- getImage(name: string, cacheKey: string, fill?: string): Promise<HTMLImageElement>;
2629
+ getImage(name: string, cacheKey: string, fill?: string | null): Promise<HTMLImageElement>;
2587
2630
  /**
2588
2631
  * 1. https://xxx.svg
2589
2632
  * 2. http://xxx.svg
@@ -2593,13 +2636,19 @@ declare class GuiIcon extends Group {
2593
2636
  private render;
2594
2637
  setImageAttrs(attrs: Partial<{
2595
2638
  name: string;
2596
- fill: string;
2639
+ fill: string | null;
2597
2640
  }>): void;
2641
+ /**
2642
+ * https://github.com/antvis/S2/issues/2772
2643
+ * G 6.0 如果是多图层, 需要手动全部隐藏, 直接隐藏父容器 Group 还不行, 或者使用 icon.show()
2644
+ * https://github.com/antvis/G/blob/277abff24936ef6f7c43407a16c5bc9260992511/packages/g-lite/src/display-objects/DisplayObject.ts#L853
2645
+ */
2646
+ toggleVisibility(visible: boolean): void;
2598
2647
  }
2599
2648
 
2600
2649
  declare interface GuiIconCfg extends Omit<ImageStyleProps, 'fill'> {
2601
2650
  readonly name: string;
2602
- readonly fill?: string;
2651
+ readonly fill?: string | null;
2603
2652
  }
2604
2653
 
2605
2654
  declare class HdAdapter {
@@ -2637,7 +2686,7 @@ declare interface HeaderActionIcon_2 extends HeaderActionIconBaseOptions {
2637
2686
  * 所属的 cell 类型, 即当前 icon 展示在哪种类型单元格中
2638
2687
  * @example belongsCell: 'rowCell'
2639
2688
  */
2640
- belongsCell: Omit<CellType, 'dataCell' | 'mergedCell' | 'seriesNumberCell'>;
2689
+ belongsCell: Exclude<`${CellType}`, 'dataCell' | 'mergedCell' | 'seriesNumberCell'>;
2641
2690
  }
2642
2691
 
2643
2692
  declare interface HeaderActionIconBaseOptions {
@@ -2663,7 +2712,7 @@ declare interface HeaderActionIconBaseOptions {
2663
2712
  }
2664
2713
 
2665
2714
  declare interface HeaderActionIconOptions extends HeaderActionIconBaseOptions {
2666
- fill?: string;
2715
+ fill?: string | null;
2667
2716
  name: string;
2668
2717
  x: number;
2669
2718
  y: number;
@@ -2675,9 +2724,9 @@ declare type HeaderActionName = string | Omit<HeaderActionNameOptions, 'isCondit
2675
2724
  declare type HeaderActionNameOptions = HeaderActionIconBaseOptions & {
2676
2725
  /**
2677
2726
  * icon 颜色配置
2678
- * @description 优先级: 单个 icon > 主题 icon 配置 > 文本颜色
2727
+ * @description 优先级: 单个 icon > 主题 icon 配置 > 文本颜色，null 则使用图标原有颜色
2679
2728
  */
2680
- fill?: string;
2729
+ fill?: string | null;
2681
2730
  /**
2682
2731
  * icon 名称
2683
2732
  */
@@ -2729,6 +2778,7 @@ declare abstract class HeaderCell<T extends BaseHeaderConfig = BaseHeaderConfig>
2729
2778
  backgroundColorOpacity: number;
2730
2779
  } & {
2731
2780
  backgroundColor: string;
2781
+ backgroundColorOpacity: number;
2732
2782
  intelligentReverseTextColor: boolean;
2733
2783
  };
2734
2784
  toggleActionIcon(id: string): void;
@@ -2929,7 +2979,7 @@ declare interface InteractionOptions {
2929
2979
  * 滚动条位置 (可用于表格内容未撑满 Canvas 的场景)
2930
2980
  * @example scrollbarPosition: 'content'
2931
2981
  */
2932
- scrollbarPosition?: ScrollbarPositionType;
2982
+ scrollbarPosition?: `${ScrollbarPositionType}`;
2933
2983
  /**
2934
2984
  * 透传 listener 属性的可选参数对象
2935
2985
  * @see https://developer.mozilla.org/zh-CN/docs/Web/API/EventTarget/addEventListener
@@ -3290,6 +3340,10 @@ declare class Node_2_2 {
3290
3340
  hierarchy: Hierarchy;
3291
3341
  isPivotMode: boolean;
3292
3342
  seriesNumberWidth: number;
3343
+ /**
3344
+ * 给序号列单元格用，标识该序号单元格对应了行头节点，有了关联关系后，就可以在行头冻结时做区分
3345
+ */
3346
+ relatedNode: Node_2_2;
3293
3347
  spreadsheet: SpreadSheet_2;
3294
3348
  query?: Query;
3295
3349
  belongsCell?: S2CellType_2 | null | undefined;
@@ -3298,7 +3352,9 @@ declare class Node_2_2 {
3298
3352
  isGrandTotals?: boolean;
3299
3353
  isSubTotals?: boolean;
3300
3354
  isTotalRoot?: boolean;
3301
- isFrozen?: boolean;
3355
+ isFrozenHead?: boolean;
3356
+ isFrozenTrailing?: boolean;
3357
+ shallowRender?: boolean;
3302
3358
  extra?: {
3303
3359
  description?: string;
3304
3360
  isCustomNode?: boolean;
@@ -3360,6 +3416,8 @@ declare class Node_2_2 {
3360
3416
  */
3361
3417
  getTotalHeightForTreeHierarchy(): number;
3362
3418
  isSeriesNumberNode(): boolean;
3419
+ clone(): Node_2_2;
3420
+ get isFrozen(): boolean | undefined;
3363
3421
  }
3364
3422
 
3365
3423
  declare interface OffsetConfig {
@@ -3459,11 +3517,7 @@ declare class PanelBBox extends BaseBBox {
3459
3517
 
3460
3518
  declare type PanelIndexes = {
3461
3519
  center: Indexes;
3462
- frozenRow?: Indexes;
3463
- frozenCol?: Indexes;
3464
- frozenTrailingRow?: Indexes;
3465
- frozenTrailingCol?: Indexes;
3466
- };
3520
+ } & Partial<Record<FrozenGroupArea, Indexes>>;
3467
3521
 
3468
3522
  declare class PanelScrollGroup extends GridGroup {
3469
3523
  protected mergedCellsGroup: Group;
@@ -3521,12 +3575,13 @@ default: Adaptive;
3521
3575
  };
3522
3576
  spreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
3523
3577
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
3578
+ onUpdate: PropType<(renderOptions: S2RenderOptions) => S2RenderOptions>;
3579
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions) => void>;
3524
3580
  }, {
3525
3581
  s2Ref: ShallowRef<SheetExpose>;
3526
3582
  options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>;
3527
3583
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3528
3584
  spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>) => SpreadSheet;
3529
- sheetUpdate: SheetUpdateCallback;
3530
3585
  rowCellHover: (data: TargetCellInfo) => void;
3531
3586
  rowCellClick: (data: TargetCellInfo) => void;
3532
3587
  rowCellDoubleClick: (data: TargetCellInfo) => void;
@@ -3593,6 +3648,8 @@ layoutCellRender: <T extends S2CellType = S2CellType>(cell: T) => void;
3593
3648
  beforeRender: () => void;
3594
3649
  afterRender: () => void;
3595
3650
  mounted: (spreadsheet: SpreadSheet) => void;
3651
+ update: (renderOptions: S2RenderOptions) => S2RenderOptions;
3652
+ updateAfterRender: (renderOptions: S2RenderOptions) => void;
3596
3653
  destroy: () => void;
3597
3654
  layoutResize: (params: ResizeParams) => void;
3598
3655
  layoutResizeSeriesWidth: (params: ResizeParams) => void;
@@ -3641,7 +3698,7 @@ spreadsheet: SpreadSheet;
3641
3698
  }) => void;
3642
3699
  rowCellBrushSelection: (event: GEvent) => void;
3643
3700
  colCellBrushSelection: (event: GEvent) => void;
3644
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes< {
3701
+ }, string, PublicProps, Readonly<ExtractPropTypes< {
3645
3702
  sheetType: PropType<SheetType>;
3646
3703
  dataCfg: PropType<S2DataConfig>;
3647
3704
  themeCfg: PropType<ThemeCfg>;
@@ -3668,8 +3725,9 @@ default: Adaptive;
3668
3725
  };
3669
3726
  spreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
3670
3727
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
3728
+ onUpdate: PropType<(renderOptions: S2RenderOptions) => S2RenderOptions>;
3729
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions) => void>;
3671
3730
  }>> & {
3672
- onSheetUpdate?: (params: S2RenderOptions) => any;
3673
3731
  onRowCellHover?: (data: TargetCellInfo) => any;
3674
3732
  onRowCellClick?: (data: TargetCellInfo) => any;
3675
3733
  onRowCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -3736,6 +3794,8 @@ onLayoutCellRender?: (cell: S2CellType) => any;
3736
3794
  onBeforeRender?: () => any;
3737
3795
  onAfterRender?: () => any;
3738
3796
  onMounted?: (spreadsheet: SpreadSheet) => any;
3797
+ onUpdate?: (renderOptions: S2RenderOptions) => any;
3798
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions) => any;
3739
3799
  onDestroy?: () => any;
3740
3800
  onLayoutResize?: (params: ResizeParams) => any;
3741
3801
  onLayoutResizeSeriesWidth?: (params: ResizeParams) => any;
@@ -3885,7 +3945,7 @@ declare type ResizeHandler = (data: {
3885
3945
 
3886
3946
  declare interface ResizeInfo_2 {
3887
3947
  theme: ResizeArea;
3888
- type: ResizeDirectionType;
3948
+ type: `${ResizeDirectionType}`;
3889
3949
  offsetX: number;
3890
3950
  offsetY: number;
3891
3951
  width: number;
@@ -3913,9 +3973,9 @@ declare interface ResizeInteractionOptions {
3913
3973
  /** 列头垂直方向 resize -> 针对列头各层级节点 */
3914
3974
  colCellVertical?: boolean;
3915
3975
  /** 行高调整时，影响当前行还是全部行 */
3916
- rowResizeType?: ResizeType;
3976
+ rowResizeType?: `${ResizeType}`;
3917
3977
  /** 列高调整时，影响当前列还是全部列 */
3918
- colResizeType?: ResizeType;
3978
+ colResizeType?: `${ResizeType}`;
3919
3979
  /** 是否允许调整, 返回 false 时拖拽的宽高无效 */
3920
3980
  disable?: (resizeInfo: ResizeInfo_2) => boolean;
3921
3981
  /** 是否显示热区 */
@@ -4017,6 +4077,7 @@ declare class RowCell extends HeaderCell<RowHeaderConfig> {
4017
4077
  backgroundColorOpacity: number;
4018
4078
  } & {
4019
4079
  backgroundColor: string;
4080
+ backgroundColorOpacity: number;
4020
4081
  intelligentReverseTextColor: boolean;
4021
4082
  };
4022
4083
  protected showTreeIcon(): boolean;
@@ -4029,10 +4090,14 @@ declare class RowCell extends HeaderCell<RowHeaderConfig> {
4029
4090
  protected isBolderText(): boolean;
4030
4091
  drawTextShape(): void;
4031
4092
  protected drawResizeAreaInLeaf(): void;
4093
+ protected getHorizontalResizeAreaOffset(): {
4094
+ offsetX: number;
4095
+ offsetY: number;
4096
+ };
4032
4097
  protected getContentIndent(): number;
4033
4098
  protected getTextIndent(): number;
4034
4099
  protected isTreeLevel(): any;
4035
- protected getMaxTextWidth(): number;
4100
+ getMaxTextWidth(): number;
4036
4101
  protected getTextArea(): {
4037
4102
  x: number;
4038
4103
  width: number;
@@ -4075,22 +4140,37 @@ declare interface RowCellStyle extends BaseCellStyle, CellTextWordWrapStyle {
4075
4140
  * Row Header for SpreadSheet
4076
4141
  */
4077
4142
  declare class RowHeader extends BaseHeader<RowHeaderConfig> {
4078
- scrollGroup: Group;
4079
- frozenRowGroup: Group;
4080
- constructor(config: RowHeaderConfig);
4081
- private initGroups;
4082
- getCellInstance(node: Node_2_2): RowCell;
4083
- protected isRowCellInRect(node: Node_2_2): boolean;
4084
- isFrozenRow(node: Node_2_2): boolean;
4143
+ protected initGroups(): void;
4144
+ getCellInstance(node: Node_2_2): RowCell | SeriesNumberCell_2;
4145
+ protected isCellInRect(node: Node_2_2): boolean;
4085
4146
  protected getCellGroup(item: Node_2_2): Group;
4086
4147
  protected layout(): void;
4148
+ protected emitRenderEvent(cell: RowCell | SeriesNumberCell_2): void;
4087
4149
  protected offset(): void;
4088
4150
  protected clip(): void;
4089
- clear(): void;
4090
4151
  }
4091
4152
 
4092
4153
  declare type RowHeaderConfig = BaseHeaderConfig;
4093
4154
 
4155
+ declare interface S2BaseFrozenOptions {
4156
+ /**
4157
+ * 行头冻结数量
4158
+ */
4159
+ rowCount?: number;
4160
+ /**
4161
+ * 行尾冻结数量
4162
+ */
4163
+ trailingRowCount?: number;
4164
+ /**
4165
+ * 列头冻结数量
4166
+ */
4167
+ colCount?: number;
4168
+ /**
4169
+ * 列尾冻结数量
4170
+ */
4171
+ trailingColCount?: number;
4172
+ }
4173
+
4094
4174
  declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Menu = BaseTooltipOperatorMenuOptions_2> {
4095
4175
  /**
4096
4176
  * 表格宽度
@@ -4163,10 +4243,33 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Men
4163
4243
  */
4164
4244
  hd?: boolean;
4165
4245
  /**
4166
- * 空值单元格占位符
4167
- * @see https://s2.antv.antgroup.com/zh/examples/custom/custom-cell/#data-cell-placeholder
4246
+ * 占位符
4168
4247
  */
4169
- placeholder?: ((meta: Record<string, any>) => string | undefined | null) | string | undefined | null;
4248
+ placeholder?: {
4249
+ /**
4250
+ * 空值单元格占位符
4251
+ * @default '-'
4252
+ * @see https://s2.antv.antgroup.com/examples/custom/custom-cell/#data-cell-placeholder
4253
+ */
4254
+ cell?: ((meta: Record<string, any>) => string | undefined | null) | string | null;
4255
+ /**
4256
+ * 空数据占位符 (明细表有效)
4257
+ * @see https://s2.antv.antgroup.com/examples/custom/custom-cell/#empty-placeholder
4258
+ */
4259
+ empty?: {
4260
+ /**
4261
+ * 自定义 Icon, 支持 customSVGIcons 自定义注册和内置的 Icon
4262
+ * @default "Empty"
4263
+ * @see https://s2.antv.antgroup.com/manual/advanced/custom/custom-icon
4264
+ */
4265
+ icon?: string;
4266
+ /**
4267
+ * 自定义描述内容
4268
+ * @default "暂无数据"
4269
+ */
4270
+ description?: string;
4271
+ };
4272
+ };
4170
4273
  /**
4171
4274
  * 设备类型: pc / mobile
4172
4275
  */
@@ -4214,7 +4317,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Men
4214
4317
  * 自定义列头单元格
4215
4318
  * @see https://s2.antv.antgroup.com/examples/custom/custom-cell#col-cell
4216
4319
  */
4217
- colCell?: CellCallback<ColHeaderConfig, S2CellType_2>;
4320
+ colCell?: CellCallback<ColHeaderConfig, ColCell_2>;
4218
4321
  /**
4219
4322
  * 自定义合并单元格
4220
4323
  * @see https://s2.antv.antgroup.com/examples/custom/custom-cell/#custom-merged-cell
@@ -4399,30 +4502,29 @@ declare enum S2Event {
4399
4502
  }
4400
4503
 
4401
4504
  declare interface S2EventHandler {
4402
- type: keyof EmitterType;
4505
+ type: `${keyof EmitterType}`;
4403
4506
  handler: EmitterType[keyof EmitterType];
4404
4507
  }
4405
4508
 
4406
- declare type S2MountContainer_2 = string | Element;
4407
-
4408
- declare interface S2Options_2<T = TooltipContentType_2, P = Pagination_2, Menu = BaseTooltipOperatorMenuOptions_2> extends S2BasicOptions<T, P, Menu>, S2PivotSheetOptions {
4509
+ declare interface S2FrozenOptions {
4409
4510
  /**
4410
4511
  * 行列冻结
4411
4512
  */
4412
- frozen?: S2PivotSheetFrozenOptions & S2TableSheetFrozenOptions;
4513
+ frozen?: S2PivotSheetFrozenOptions & S2BaseFrozenOptions;
4514
+ }
4515
+
4516
+ declare type S2MountContainer_2 = string | Element;
4517
+
4518
+ declare interface S2Options_2<T = TooltipContentType_2, P = Pagination_2, Menu = BaseTooltipOperatorMenuOptions_2> extends S2BasicOptions<T, P, Menu>, S2PivotSheetOptions, S2FrozenOptions {
4413
4519
  }
4414
4520
 
4415
- declare interface S2PivotSheetFrozenOptions {
4521
+ declare interface S2PivotSheetFrozenOptions extends S2BaseFrozenOptions {
4416
4522
  /**
4417
4523
  * 是否冻结行头 (含角头区域, 透视表有效),
4418
4524
  * 当值为 number 时，标识行头冻结的最大区域，取值范围： (0, 1)，0 表示不固定行头
4419
4525
  * 当值为 boolean 时，true 对应冻结最大区域为 0.5, false 对应 0
4420
4526
  */
4421
4527
  rowHeader?: boolean | number;
4422
- /**
4423
- * 是否冻结首行 (适用于总计置于顶部, 树状模式等场景)
4424
- */
4425
- firstRow?: boolean;
4426
4528
  }
4427
4529
 
4428
4530
  declare interface S2PivotSheetOptions {
@@ -4450,6 +4552,9 @@ declare interface S2PivotSheetOptions {
4450
4552
  cornerExtraFieldText?: string;
4451
4553
  }
4452
4554
 
4555
+ /**
4556
+ * 自定义渲染模式
4557
+ */
4453
4558
  declare interface S2RenderOptions_2 {
4454
4559
  /**
4455
4560
  * 是否重新加载数据
@@ -4458,7 +4563,7 @@ declare interface S2RenderOptions_2 {
4458
4563
  /**
4459
4564
  * 是否重新生成数据集
4460
4565
  */
4461
- reBuildDataSet?: boolean;
4566
+ rebuildDataSet?: boolean;
4462
4567
  /**
4463
4568
  * 是否重新生成列头隐藏信息
4464
4569
  */
@@ -4469,7 +4574,7 @@ declare interface S2Style {
4469
4574
  /**
4470
4575
  * 布局类型
4471
4576
  */
4472
- layoutWidthType?: LayoutWidthType;
4577
+ layoutWidthType?: `${LayoutWidthType}`;
4473
4578
  /**
4474
4579
  * 数值单元格配置
4475
4580
  */
@@ -4496,25 +4601,6 @@ declare interface S2Style {
4496
4601
  seriesNumberCell?: SeriesNumberCellStyle | null;
4497
4602
  }
4498
4603
 
4499
- declare interface S2TableSheetFrozenOptions {
4500
- /**
4501
- * 行头冻结数量 (明细表有效)
4502
- */
4503
- rowCount?: number;
4504
- /**
4505
- * 列头冻结数量 (明细表有效)
4506
- */
4507
- colCount?: number;
4508
- /**
4509
- * 行尾冻结数量 (明细表有效)
4510
- */
4511
- trailingRowCount?: number;
4512
- /**
4513
- * 列尾冻结数量 (明细表有效)
4514
- */
4515
- trailingColCount?: number;
4516
- }
4517
-
4518
4604
  declare interface S2Theme extends CellThemes {
4519
4605
  /** 列宽行高调整热区 */
4520
4606
  resizeArea?: ResizeArea;
@@ -4525,7 +4611,9 @@ declare interface S2Theme extends CellThemes {
4525
4611
  /** 刷选遮罩 */
4526
4612
  prepareSelectMask?: InteractionStateTheme;
4527
4613
  /** 画布背景底色 */
4528
- background?: Background;
4614
+ background?: BackgroundTheme;
4615
+ /** 空数据占位符 */
4616
+ empty?: EmptyTheme;
4529
4617
  }
4530
4618
 
4531
4619
  declare class ScrollBar extends Group {
@@ -4625,7 +4713,9 @@ declare interface ScrollBarTheme {
4625
4713
 
4626
4714
  declare enum ScrollDirection {
4627
4715
  SCROLL_UP = "scrollUp",
4628
- SCROLL_DOWN = "scrollDown"
4716
+ SCROLL_DOWN = "scrollDown",
4717
+ SCROLL_LEFT = "scrollLeft",
4718
+ SCROLL_RIGHT = "scrollRight"
4629
4719
  }
4630
4720
 
4631
4721
  declare interface ScrollOffset_2 {
@@ -4646,7 +4736,7 @@ declare interface SelectHeaderCellInfo {
4646
4736
  isMultiSelection?: boolean;
4647
4737
  }
4648
4738
 
4649
- declare class SeriesNumberCell_2 extends HeaderCell {
4739
+ declare class SeriesNumberCell_2 extends RowCell {
4650
4740
  get cellType(): CellType;
4651
4741
  protected getBorderPositions(): CellBorderPosition[];
4652
4742
  protected initCell(): void;
@@ -4664,16 +4754,15 @@ declare class SeriesNumberCell_2 extends HeaderCell {
4664
4754
  opacity: NonNullable<string | number | undefined>;
4665
4755
  fontFamily: string;
4666
4756
  fontWeight: NonNullable<number | "bold" | CSSGlobalKeywords | "normal" | "bolder" | "lighter" | undefined>;
4667
- lineHeight: NonNullable<string | number | undefined>;
4668
4757
  fontStyle: NonNullable<CSSGlobalKeywords | "normal" | "italic" | "oblique" | undefined>;
4669
4758
  fontVariant: string;
4759
+ lineHeight: NonNullable<string | number | undefined>;
4670
4760
  textOverflow?: string | undefined;
4671
4761
  maxLines?: number | undefined;
4672
4762
  wordWrap?: boolean | undefined;
4673
4763
  };
4674
4764
  protected getFormattedFieldValue(): FormatResult;
4675
- protected getMaxTextWidth(): number;
4676
- protected getTextPosition(): PointLike;
4765
+ getMaxTextWidth(): number;
4677
4766
  protected isBolderText(): boolean;
4678
4767
  findFieldCondition(): undefined;
4679
4768
  mappingValue(): undefined;
@@ -4683,9 +4772,7 @@ declare class SeriesNumberCell_2 extends HeaderCell {
4683
4772
  declare interface SeriesNumberCellStyle extends CellTextWordWrapStyle {
4684
4773
  }
4685
4774
 
4686
- declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
4687
- constructor(config: BaseHeaderConfig);
4688
- protected getCellInstance(node: Node_2_2): SeriesNumberCell_2;
4775
+ declare class SeriesNumberHeader extends RowHeader {
4689
4776
  /**
4690
4777
  * Get seriesNumber header by config
4691
4778
  */
@@ -4696,13 +4783,12 @@ declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
4696
4783
  spreadsheet: SpreadSheet_2;
4697
4784
  cornerWidth: number;
4698
4785
  }): SeriesNumberHeader;
4699
- clip(): void;
4700
- layout(): void;
4701
- protected offset(): void;
4702
- getNodes(): Node_2_2[];
4786
+ protected initGroups(): void;
4787
+ getCellInstance(node: Node_2_2): SeriesNumberCell_2;
4788
+ protected emitRenderEvent(cell: SeriesNumberCell_2): void;
4703
4789
  }
4704
4790
 
4705
- export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "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">, {
4791
+ export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "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">, {
4706
4792
  s2Ref: ShallowRef<SheetExpose>;
4707
4793
  sheetType: ComputedRef<DefineComponent< {
4708
4794
  sheetType: PropType<SheetType>;
@@ -4731,12 +4817,13 @@ default: Adaptive;
4731
4817
  };
4732
4818
  spreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: SheetComponentOptions) => SpreadSheet_2>;
4733
4819
  onMounted: PropType<(spreadsheet: SpreadSheet_2) => void>;
4820
+ onUpdate: PropType<(renderOptions: S2RenderOptions_2) => S2RenderOptions_2>;
4821
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions_2) => void>;
4734
4822
  }, {
4735
4823
  s2Ref: ShallowRef<SheetExpose>;
4736
4824
  options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>;
4737
4825
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
4738
4826
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
4739
- sheetUpdate: SheetUpdateCallback;
4740
4827
  rowCellHover: (data: TargetCellInfo_2) => void;
4741
4828
  rowCellClick: (data: TargetCellInfo_2) => void;
4742
4829
  rowCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4803,6 +4890,8 @@ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
4803
4890
  beforeRender: () => void;
4804
4891
  afterRender: () => void;
4805
4892
  mounted: (spreadsheet: SpreadSheet_2) => void;
4893
+ update: (renderOptions: S2RenderOptions_2) => S2RenderOptions_2;
4894
+ updateAfterRender: (renderOptions: S2RenderOptions_2) => void;
4806
4895
  destroy: () => void;
4807
4896
  layoutResize: (params: ResizeParams_2) => void;
4808
4897
  layoutResizeSeriesWidth: (params: ResizeParams_2) => void;
@@ -4851,7 +4940,7 @@ spreadsheet: SpreadSheet_2;
4851
4940
  }) => void;
4852
4941
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
4853
4942
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
4854
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes< {
4943
+ }, string, PublicProps, Readonly<ExtractPropTypes< {
4855
4944
  sheetType: PropType<SheetType>;
4856
4945
  dataCfg: PropType<S2DataConfig_2>;
4857
4946
  themeCfg: PropType<ThemeCfg_2>;
@@ -4878,8 +4967,9 @@ default: Adaptive;
4878
4967
  };
4879
4968
  spreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: SheetComponentOptions) => SpreadSheet_2>;
4880
4969
  onMounted: PropType<(spreadsheet: SpreadSheet_2) => void>;
4970
+ onUpdate: PropType<(renderOptions: S2RenderOptions_2) => S2RenderOptions_2>;
4971
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions_2) => void>;
4881
4972
  }>> & {
4882
- onSheetUpdate?: (params: S2RenderOptions_2) => any;
4883
4973
  onRowCellHover?: (data: TargetCellInfo_2) => any;
4884
4974
  onRowCellClick?: (data: TargetCellInfo_2) => any;
4885
4975
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4946,6 +5036,8 @@ onLayoutCellRender?: (cell: S2CellType_2) => any;
4946
5036
  onBeforeRender?: () => any;
4947
5037
  onAfterRender?: () => any;
4948
5038
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
5039
+ onUpdate?: (renderOptions: S2RenderOptions_2) => any;
5040
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions_2) => any;
4949
5041
  onDestroy?: () => any;
4950
5042
  onLayoutResize?: (params: ResizeParams_2) => any;
4951
5043
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -5007,11 +5099,10 @@ showPagination: boolean | {
5007
5099
  onShowSizeChange?: (pageSize: number) => void;
5008
5100
  onChange?: (current: number) => void;
5009
5101
  };
5010
- }, {}> | DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "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">, {
5102
+ }, {}> | DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "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">, {
5011
5103
  s2Ref: ShallowRef<SheetExpose>;
5012
5104
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
5013
5105
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
5014
- sheetUpdate: SheetUpdateCallback;
5015
5106
  rowCellHover: (data: TargetCellInfo_2) => void;
5016
5107
  rowCellClick: (data: TargetCellInfo_2) => void;
5017
5108
  rowCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5078,6 +5169,8 @@ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
5078
5169
  beforeRender: () => void;
5079
5170
  afterRender: () => void;
5080
5171
  mounted: (spreadsheet: SpreadSheet_2) => void;
5172
+ update: (renderOptions: S2RenderOptions_2) => S2RenderOptions_2;
5173
+ updateAfterRender: (renderOptions: S2RenderOptions_2) => void;
5081
5174
  destroy: () => void;
5082
5175
  layoutResize: (params: ResizeParams_2) => void;
5083
5176
  layoutResizeSeriesWidth: (params: ResizeParams_2) => void;
@@ -5126,8 +5219,7 @@ spreadsheet: SpreadSheet_2;
5126
5219
  }) => void;
5127
5220
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
5128
5221
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
5129
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "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">>> & {
5130
- onSheetUpdate?: (params: S2RenderOptions_2) => any;
5222
+ }, string, PublicProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "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">>> & {
5131
5223
  onRowCellHover?: (data: TargetCellInfo_2) => any;
5132
5224
  onRowCellClick?: (data: TargetCellInfo_2) => any;
5133
5225
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5194,6 +5286,8 @@ onLayoutCellRender?: (cell: S2CellType_2) => any;
5194
5286
  onBeforeRender?: () => any;
5195
5287
  onAfterRender?: () => any;
5196
5288
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
5289
+ onUpdate?: (renderOptions: S2RenderOptions_2) => any;
5290
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions_2) => any;
5197
5291
  onDestroy?: () => any;
5198
5292
  onLayoutResize?: (params: ResizeParams_2) => any;
5199
5293
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -5246,7 +5340,6 @@ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options
5246
5340
  }, {}, {}>>;
5247
5341
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
5248
5342
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
5249
- sheetUpdate: SheetUpdateCallback;
5250
5343
  rowCellHover: (data: TargetCellInfo_2) => void;
5251
5344
  rowCellClick: (data: TargetCellInfo_2) => void;
5252
5345
  rowCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5313,6 +5406,8 @@ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
5313
5406
  beforeRender: () => void;
5314
5407
  afterRender: () => void;
5315
5408
  mounted: (spreadsheet: SpreadSheet_2) => void;
5409
+ update: (renderOptions: S2RenderOptions_2) => S2RenderOptions_2;
5410
+ updateAfterRender: (renderOptions: S2RenderOptions_2) => void;
5316
5411
  destroy: () => void;
5317
5412
  layoutResize: (params: ResizeParams_2) => void;
5318
5413
  layoutResizeSeriesWidth: (params: ResizeParams_2) => void;
@@ -5361,8 +5456,7 @@ spreadsheet: SpreadSheet_2;
5361
5456
  }) => void;
5362
5457
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
5363
5458
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
5364
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "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">>> & {
5365
- onSheetUpdate?: (params: S2RenderOptions_2) => any;
5459
+ }, string, PublicProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "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">>> & {
5366
5460
  onRowCellHover?: (data: TargetCellInfo_2) => any;
5367
5461
  onRowCellClick?: (data: TargetCellInfo_2) => any;
5368
5462
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5429,6 +5523,8 @@ onLayoutCellRender?: (cell: S2CellType_2) => any;
5429
5523
  onBeforeRender?: () => any;
5430
5524
  onAfterRender?: () => any;
5431
5525
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
5526
+ onUpdate?: (renderOptions: S2RenderOptions_2) => any;
5527
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions_2) => any;
5432
5528
  onDestroy?: () => any;
5433
5529
  onLayoutResize?: (params: ResizeParams_2) => any;
5434
5530
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -5490,9 +5586,6 @@ export declare interface SheetExpose {
5490
5586
 
5491
5587
  declare type SheetType = 'pivot' | 'table' | 'chart' | 'gridAnalysis' | 'strategy' | 'editable';
5492
5588
 
5493
- /** render callback */
5494
- declare type SheetUpdateCallback = (params: S2RenderOptions) => S2RenderOptions;
5495
-
5496
5589
  declare type ShowPagination<OverrideShowPagination, Options> = OverrideShowPagination extends true ? Options extends {
5497
5590
  pagination?: {
5498
5591
  onShowSizeChange?: unknown;
@@ -5535,7 +5628,7 @@ declare interface SortFuncParam extends Sort {
5535
5628
  data: Array<string | Record<string, any>> | undefined;
5536
5629
  }
5537
5630
 
5538
- declare type SortMethod = 'ASC' | 'DESC' | 'asc' | 'desc';
5631
+ declare type SortMethod = 'ASC' | 'DESC' | 'NONE' | 'asc' | 'desc' | 'none';
5539
5632
 
5540
5633
  declare interface SortParam extends Sort {
5541
5634
  /** 自定义排序 */
@@ -5590,7 +5683,6 @@ declare abstract class SpreadSheet_2 extends EE {
5590
5683
  private destroyed;
5591
5684
  protected abstract bindEvents(): void;
5592
5685
  abstract getDataSet(): BaseDataSet_2;
5593
- abstract enableFrozenHeaders(): boolean;
5594
5686
  abstract isPivotMode(): boolean;
5595
5687
  abstract isCustomRowFields(): boolean;
5596
5688
  abstract isHierarchyTreeType(): boolean;
@@ -5598,8 +5690,8 @@ declare abstract class SpreadSheet_2 extends EE {
5598
5690
  abstract isTableMode(): boolean;
5599
5691
  abstract isValueInCols(): boolean;
5600
5692
  protected abstract buildFacet(): void;
5601
- abstract clearDrillDownData(rowNodeId?: string, preventRender?: boolean): void;
5602
- abstract groupSortByMethod(sortMethod: SortMethod, meta: Node_2_2): void;
5693
+ abstract clearDrillDownData(rowNodeId?: string, preventRender?: boolean): Promise<void>;
5694
+ abstract groupSortByMethod(sortMethod: SortMethod, meta: Node_2_2): Promise<void> | void;
5603
5695
  constructor(dom: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2 | null);
5604
5696
  isCustomHeaderFields(fieldType?: keyof Pick<Fields, 'columns' | 'rows'>): boolean;
5605
5697
  isCustomColumnFields(): boolean;
@@ -5612,6 +5704,7 @@ declare abstract class SpreadSheet_2 extends EE {
5612
5704
  private initInteraction;
5613
5705
  private initTooltip;
5614
5706
  private renderTooltip;
5707
+ private getTargetCell;
5615
5708
  /**
5616
5709
  * 展示 Tooltip 提示
5617
5710
  * @alias s2.tooltip.show()
@@ -5667,7 +5760,7 @@ declare abstract class SpreadSheet_2 extends EE {
5667
5760
  s2.render(false)
5668
5761
  s2.render({
5669
5762
  reloadData: true;
5670
- reBuildDataSet: true;
5763
+ rebuildDataSet: true;
5671
5764
  reBuildHiddenColumnsDetail: true;
5672
5765
  })
5673
5766
  */
@@ -5699,8 +5792,8 @@ declare abstract class SpreadSheet_2 extends EE {
5699
5792
  * @param height
5700
5793
  */
5701
5794
  changeSheetSize(width?: number, height?: number): void;
5702
- on<K extends keyof EmitterType>(event: K, listener: EmitterType[K]): this;
5703
- emit<K extends keyof EmitterType>(event: K, ...args: Parameters<EmitterType[K]>): void;
5795
+ on<K extends keyof EmitterType>(event: `${K}`, listener: EmitterType[K]): this;
5796
+ emit<K extends keyof EmitterType>(event: `${K}`, ...args: Parameters<EmitterType[K]>): void;
5704
5797
  /**
5705
5798
  * 获取 G Canvas 实例
5706
5799
  * @see https://g.antv.antgroup.com/api/renderer/canvas
@@ -5717,7 +5810,7 @@ declare abstract class SpreadSheet_2 extends EE {
5717
5810
  getCanvasElement(): HTMLCanvasElement & {
5718
5811
  __s2_instance__: SpreadSheet_2;
5719
5812
  };
5720
- getLayoutWidthType(): LayoutWidthType;
5813
+ getLayoutWidthType(): "adaptive" | "colAdaptive" | "compact";
5721
5814
  /**
5722
5815
  * Update scroll's offset, the value can be undefined,
5723
5816
  * indicate not update current value
@@ -5777,6 +5870,7 @@ declare abstract class SpreadSheet_2 extends EE {
5777
5870
  updateSortMethodMap(nodeId: string, sortMethod: SortMethod, replace?: boolean): void;
5778
5871
  getMenuDefaultSelectedKeys(nodeId: string): string[];
5779
5872
  handleGroupSort(event: FederatedPointerEvent, meta: Node_2_2): void;
5873
+ getSeriesNumberText(): string;
5780
5874
  }
5781
5875
 
5782
5876
  declare type StateShapeLayer = 'interactiveBgShape' | 'interactiveBorderShape';
@@ -5890,7 +5984,6 @@ declare class TableColCell extends ColCell_2 {
5890
5984
  x: number;
5891
5985
  y: number;
5892
5986
  };
5893
- protected getColResizeArea(): Group_2 | undefined;
5894
5987
  protected isSortCell(): boolean;
5895
5988
  protected showSortIcon(): boolean | undefined;
5896
5989
  protected getTextStyle(): {
@@ -5902,16 +5995,22 @@ declare class TableColCell extends ColCell_2 {
5902
5995
  opacity: NonNullable<string | number | undefined>;
5903
5996
  fontFamily: string;
5904
5997
  fontWeight: NonNullable<number | "bold" | CSSGlobalKeywords | "normal" | "bolder" | "lighter" | undefined>;
5905
- lineHeight: NonNullable<string | number | undefined>;
5906
5998
  fontStyle: NonNullable<CSSGlobalKeywords | "normal" | "italic" | "oblique" | undefined>;
5907
5999
  fontVariant: string;
6000
+ lineHeight: NonNullable<string | number | undefined>;
5908
6001
  textOverflow?: string | undefined;
5909
6002
  maxLines?: number | undefined;
5910
6003
  wordWrap?: boolean | undefined;
5911
6004
  };
5912
6005
  protected getHorizontalResizeAreaName(): string;
5913
6006
  protected drawBackgroundShape(): void;
5914
- protected handleViewport(): AreaRange;
6007
+ }
6008
+
6009
+ /**
6010
+ * Column Header for SpreadSheet
6011
+ */
6012
+ declare class TableColHeader extends ColHeader {
6013
+ protected getCellInstance(node: Node_2_2): ColCell_2;
5915
6014
  }
5916
6015
 
5917
6016
  declare class TableCornerCell extends TableColCell {
@@ -5921,7 +6020,6 @@ declare class TableCornerCell extends TableColCell {
5921
6020
 
5922
6021
  declare class TableDataCell_2 extends DataCell_2 {
5923
6022
  protected getLinkFieldStyle(): string;
5924
- drawBorders(): void;
5925
6023
  protected shouldDrawResizeArea(): boolean;
5926
6024
  drawResizeArea(): void;
5927
6025
  protected isDisableHover(cellMeta: CellMeta): boolean;
@@ -5932,11 +6030,10 @@ declare class TableSeriesNumberCell extends TableDataCell_2 {
5932
6030
  protected getTextStyle(): TextTheme;
5933
6031
  }
5934
6032
 
5935
- export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "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">, {
6033
+ export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "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">, {
5936
6034
  s2Ref: ShallowRef<SheetExpose>;
5937
6035
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
5938
6036
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
5939
- sheetUpdate: SheetUpdateCallback;
5940
6037
  rowCellHover: (data: TargetCellInfo_2) => void;
5941
6038
  rowCellClick: (data: TargetCellInfo_2) => void;
5942
6039
  rowCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -6003,6 +6100,8 @@ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
6003
6100
  beforeRender: () => void;
6004
6101
  afterRender: () => void;
6005
6102
  mounted: (spreadsheet: SpreadSheet_2) => void;
6103
+ update: (renderOptions: S2RenderOptions_2) => S2RenderOptions_2;
6104
+ updateAfterRender: (renderOptions: S2RenderOptions_2) => void;
6006
6105
  destroy: () => void;
6007
6106
  layoutResize: (params: ResizeParams_2) => void;
6008
6107
  layoutResizeSeriesWidth: (params: ResizeParams_2) => void;
@@ -6051,8 +6150,7 @@ spreadsheet: SpreadSheet_2;
6051
6150
  }) => void;
6052
6151
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
6053
6152
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
6054
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "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">>> & {
6055
- onSheetUpdate?: (params: S2RenderOptions_2) => any;
6153
+ }, string, PublicProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "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">>> & {
6056
6154
  onRowCellHover?: (data: TargetCellInfo_2) => any;
6057
6155
  onRowCellClick?: (data: TargetCellInfo_2) => any;
6058
6156
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -6119,6 +6217,8 @@ onLayoutCellRender?: (cell: S2CellType_2) => any;
6119
6217
  onBeforeRender?: () => any;
6120
6218
  onAfterRender?: () => any;
6121
6219
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
6220
+ onUpdate?: (renderOptions: S2RenderOptions_2) => any;
6221
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions_2) => any;
6122
6222
  onDestroy?: () => any;
6123
6223
  onLayoutResize?: (params: ResizeParams_2) => any;
6124
6224
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -6312,9 +6412,9 @@ declare interface TooltipOperatorMenuOptions<Icon, Text> {
6312
6412
  */
6313
6413
  onClick?: TooltipOperatorClickHandler;
6314
6414
  /**
6315
- * 默认选中的菜单项 key
6415
+ * 选中的菜单项 key
6316
6416
  */
6317
- defaultSelectedKeys?: string[];
6417
+ selectedKeys?: string[];
6318
6418
  }
6319
6419
 
6320
6420
  declare interface TooltipOperatorOptions<Menu = BaseTooltipOperatorMenuOptions_2> {
@@ -6484,7 +6584,7 @@ declare interface ValueRange {
6484
6584
 
6485
6585
  declare type ValueRanges = Record<string, ValueRange>;
6486
6586
 
6487
- export declare const version = "@antv/s2-vue-v2.0.0-next.13";
6587
+ export declare const version = "@antv/s2-vue-v2.0.0-next.15";
6488
6588
 
6489
6589
  declare interface ViewCellHeights {
6490
6590
  getCellOffsetY: (index: number) => number;
@@ -6519,6 +6619,7 @@ declare interface ViewMeta_2 {
6519
6619
  value?: string | number;
6520
6620
  query?: Query;
6521
6621
  isLeaf?: boolean;
6622
+ shallowRender?: boolean;
6522
6623
  [key: string]: unknown;
6523
6624
  }
6524
6625