@antv/s2-vue 2.0.0-next.14 → 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.
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,10 +38,10 @@ 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';
47
- import { RectStyleProps } from '@antv/g';
48
45
  import { Ref } from 'vue';
49
46
  import { ResizeInfo } from '@antv/s2';
50
47
  import { ResizeParams } from '@antv/s2';
@@ -68,7 +65,6 @@ import { Timer } from 'd3-timer';
68
65
  import { TooltipContentType } from '@antv/s2';
69
66
  import { ViewMeta } from '@antv/s2';
70
67
  import { ViewMetaData } from '@antv/s2';
71
- import { VNodeProps } from 'vue';
72
68
 
73
69
  declare type Adaptive = boolean | {
74
70
  width?: boolean;
@@ -244,7 +240,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
244
240
  getBackgroundShape(): Image_2 | Rect | Polygon;
245
241
  getStateShapes(): Map<StateShapeLayer, DisplayObject<any, any>>;
246
242
  protected getResizeAreaStyle(): ResizeArea;
247
- 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;
248
244
  getBBoxByType(type?: CellClipBox): SimpleBBox;
249
245
  drawBorders(): void;
250
246
  /**
@@ -302,10 +298,12 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
302
298
  protected getDefaultTextFill(textFill: string): string;
303
299
  getBackgroundConditionFill(): {
304
300
  backgroundColor: string;
301
+ backgroundColorOpacity: number;
305
302
  intelligentReverseTextColor: boolean;
306
303
  } | {
307
304
  intelligentReverseTextColor: boolean;
308
305
  backgroundColor?: undefined;
306
+ backgroundColorOpacity?: undefined;
309
307
  };
310
308
  getIconConditionResult(): HeaderActionNameOptions | undefined;
311
309
  protected getActionAndConditionIconWidth(position?: IconPosition): number;
@@ -346,7 +344,7 @@ declare interface BaseChartData {
346
344
  /**
347
345
  * 类型
348
346
  */
349
- type: MiniChartType;
347
+ type: `${MiniChartType}`;
350
348
  /**
351
349
  * 数据
352
350
  */
@@ -533,12 +531,6 @@ declare abstract class BaseFacet {
533
531
  backgroundGroup: Group;
534
532
  panelGroup: Group;
535
533
  panelScrollGroup: PanelScrollGroup;
536
- frozenRowGroup: FrozenGroup;
537
- frozenColGroup: FrozenGroup;
538
- frozenTrailingRowGroup: FrozenGroup;
539
- frozenTrailingColGroup: FrozenGroup;
540
- frozenTopGroup: FrozenGroup;
541
- frozenBottomGroup: FrozenGroup;
542
534
  foregroundGroup: Group;
543
535
  /**
544
536
  * 当前布局节点信息
@@ -638,6 +630,10 @@ declare abstract class BaseFacet {
638
630
  emitPaginationEvent: () => void;
639
631
  private unbindEvents;
640
632
  calculateCellWidthHeight: () => void;
633
+ /**
634
+ * 提供给明细表做 rowOffsets 计算的 hook
635
+ */
636
+ protected abstract calculateRowOffsets(): void;
641
637
  getRealScrollX: (scrollX: number, hRowScroll?: number) => number;
642
638
  protected calculateCornerBBox(): void;
643
639
  protected calculatePanelBBox: () => void;
@@ -803,6 +799,11 @@ declare abstract class BaseFacet {
803
799
  * @example facet.getColNodeByIndex(colIndex)
804
800
  */
805
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[];
806
807
  /**
807
808
  * 根据列头索引获取指定列头叶子节点
808
809
  * @example facet.getColLeafNodes(colIndex)
@@ -857,6 +858,11 @@ declare abstract class BaseFacet {
857
858
  * @example facet.getRowLeafNodeByIndex(rowIndex)
858
859
  */
859
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[];
860
866
  /**
861
867
  * 根据 field 获取行头节点
862
868
  * @example facet.getRowNodeByField('number')
@@ -966,21 +972,21 @@ declare interface BaseFields {
966
972
  /**
967
973
  * New Base Header for all headers(cornerHeader, rowHeader, colHeader)
968
974
  * NOTE: Do not use this.cfg(which lays in group) to get header config,
969
- * use {@see headerConfig} instead
975
+ * use @see headerConfig instead
970
976
  */
971
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;
972
983
  protected abstract layout(): void;
973
984
  protected abstract offset(): void;
974
985
  protected abstract clip(): void;
975
986
  protected abstract getCellInstance(node: Node_2_2): S2CellType_2;
976
987
  protected headerConfig: T;
977
- protected constructor(config: T);
988
+ constructor(config: T);
978
989
  getHeaderConfig(): T;
979
- /**
980
- * 清空热区,为重绘做准备,防止热区重复渲染
981
- * @param type 当前重绘的header类型
982
- */
983
- protected clearResizeAreaGroup(type: string): void;
984
990
  render(type: string): void;
985
991
  /**
986
992
  * Scroll header group's x,y
@@ -995,6 +1001,11 @@ declare abstract class BaseHeader<T extends BaseHeaderConfig> extends Group {
995
1001
  * @param type
996
1002
  */
997
1003
  onRowScrollX(rowHeaderScrollX: number, type: string): void;
1004
+ /**
1005
+ * 清空热区,为重绘做准备,防止热区重复渲染
1006
+ * @param type 当前重绘的header类型
1007
+ */
1008
+ protected clearResizeAreaGroup(type: string): void;
998
1009
  clear(): void;
999
1010
  /**
1000
1011
  * Check whether header cell in viewPort
@@ -1005,6 +1016,7 @@ declare abstract class BaseHeader<T extends BaseHeaderConfig> extends Group {
1005
1016
  viewportPosition: number;
1006
1017
  viewportSize: number;
1007
1018
  }) => boolean;
1019
+ getNodes(): Node_2_2[];
1008
1020
  }
1009
1021
 
1010
1022
  /**
@@ -1091,6 +1103,8 @@ default: Adaptive;
1091
1103
  };
1092
1104
  spreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
1093
1105
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
1106
+ onUpdate: PropType<(renderOptions: S2RenderOptions) => S2RenderOptions>;
1107
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions) => void>;
1094
1108
  }, {
1095
1109
  S2_PREFIX_CLS: string;
1096
1110
  wrapperRef: Ref<HTMLDivElement>;
@@ -1166,7 +1180,6 @@ handlePageChange: (nextCurrent: number) => void;
1166
1180
  handlePageSizeChange: (nextSize: number) => void;
1167
1181
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
1168
1182
  spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>) => SpreadSheet;
1169
- sheetUpdate: SheetUpdateCallback;
1170
1183
  rowCellHover: (data: TargetCellInfo) => void;
1171
1184
  rowCellClick: (data: TargetCellInfo) => void;
1172
1185
  rowCellDoubleClick: (data: TargetCellInfo) => void;
@@ -1233,6 +1246,8 @@ layoutCellRender: <T extends S2CellType = S2CellType>(cell: T) => void;
1233
1246
  beforeRender: () => void;
1234
1247
  afterRender: () => void;
1235
1248
  mounted: (spreadsheet: SpreadSheet) => void;
1249
+ update: (renderOptions: S2RenderOptions) => S2RenderOptions;
1250
+ updateAfterRender: (renderOptions: S2RenderOptions) => void;
1236
1251
  destroy: () => void;
1237
1252
  layoutResize: (params: ResizeParams) => void;
1238
1253
  layoutResizeSeriesWidth: (params: ResizeParams) => void;
@@ -1281,7 +1296,7 @@ spreadsheet: SpreadSheet;
1281
1296
  }) => void;
1282
1297
  rowCellBrushSelection: (event: GEvent) => void;
1283
1298
  colCellBrushSelection: (event: GEvent) => void;
1284
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes< {
1299
+ }, string, PublicProps, Readonly<ExtractPropTypes< {
1285
1300
  sheetType: PropType<SheetType>;
1286
1301
  dataCfg: PropType<S2DataConfig>;
1287
1302
  themeCfg: PropType<ThemeCfg>;
@@ -1308,8 +1323,9 @@ default: Adaptive;
1308
1323
  };
1309
1324
  spreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
1310
1325
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
1326
+ onUpdate: PropType<(renderOptions: S2RenderOptions) => S2RenderOptions>;
1327
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions) => void>;
1311
1328
  }>> & {
1312
- onSheetUpdate?: (params: S2RenderOptions) => any;
1313
1329
  onRowCellHover?: (data: TargetCellInfo) => any;
1314
1330
  onRowCellClick?: (data: TargetCellInfo) => any;
1315
1331
  onRowCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -1376,6 +1392,8 @@ onLayoutCellRender?: (cell: S2CellType) => any;
1376
1392
  onBeforeRender?: () => any;
1377
1393
  onAfterRender?: () => any;
1378
1394
  onMounted?: (spreadsheet: SpreadSheet) => any;
1395
+ onUpdate?: (renderOptions: S2RenderOptions) => any;
1396
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions) => any;
1379
1397
  onDestroy?: () => any;
1380
1398
  onLayoutResize?: (params: ResizeParams) => any;
1381
1399
  onLayoutResizeSeriesWidth?: (params: ResizeParams) => any;
@@ -1450,8 +1468,6 @@ declare interface BaseSheetComponentProps<PartialDrillDown = PartDrillDown, Head
1450
1468
  showPagination?: ShowPagination<OverrideShowPagination, Options>;
1451
1469
  themeCfg?: ThemeCfg;
1452
1470
  header?: Header;
1453
- /** 底表 render callback */
1454
- onSheetUpdate?: SheetUpdateCallback;
1455
1471
  onRowCellHover?: (data: TargetCellInfo) => void;
1456
1472
  onRowCellClick?: (data: TargetCellInfo) => void;
1457
1473
  onRowCellDoubleClick?: (data: TargetCellInfo) => void;
@@ -1519,6 +1535,8 @@ declare interface BaseSheetComponentProps<PartialDrillDown = PartDrillDown, Head
1519
1535
  onBeforeRender?: () => void;
1520
1536
  onAfterRender?: () => void;
1521
1537
  onMounted?: (spreadsheet: SpreadSheet) => void;
1538
+ onUpdate?: (renderOptions: S2RenderOptions) => S2RenderOptions;
1539
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions) => void;
1522
1540
  onDestroy?: () => void;
1523
1541
  onLayoutResize?: (params: ResizeParams) => void;
1524
1542
  onLayoutResizeSeriesWidth?: (params: ResizeParams) => void;
@@ -1702,7 +1720,7 @@ declare interface BulletValue {
1702
1720
 
1703
1721
  declare interface CalcTotals {
1704
1722
  /** 聚合方式 */
1705
- aggregation?: Aggregation;
1723
+ aggregation?: `${Aggregation}`;
1706
1724
  /**
1707
1725
  * 自定义计算汇总
1708
1726
  * @see https://s2.antv.antgroup.com/examples/analysis/totals/#custom
@@ -1891,10 +1909,11 @@ declare interface ColCellStyle extends BaseCellStyle, CellTextWordWrapStyle {
1891
1909
  * Column Header for SpreadSheet
1892
1910
  */
1893
1911
  declare class ColHeader extends BaseHeader<ColHeaderConfig> {
1894
- protected scrollGroup: Group;
1895
- constructor(config: ColHeaderConfig);
1912
+ protected initGroups(): void;
1913
+ protected getCellGroup(node: Node_2_2): Group;
1896
1914
  protected getCellInstance(node: Node_2_2): ColCell_2;
1897
- private initScrollGroup;
1915
+ protected appendNode(node: Node_2_2): void;
1916
+ protected layout(): void;
1898
1917
  /**
1899
1918
  * Make colHeader scroll with hScrollBar
1900
1919
  * @param scrollX horizontal offset
@@ -1903,10 +1922,7 @@ declare class ColHeader extends BaseHeader<ColHeaderConfig> {
1903
1922
  */
1904
1923
  onColScroll(scrollX: number, type: string): void;
1905
1924
  protected clip(): void;
1906
- clear(): void;
1907
- protected getCellGroup(node: Node_2_2): Group;
1908
1925
  protected isColCellInRect(node: Node_2_2): boolean;
1909
- protected layout(): void;
1910
1926
  protected offset(): void;
1911
1927
  }
1912
1928
 
@@ -1934,14 +1950,14 @@ declare interface Conditions {
1934
1950
  }
1935
1951
 
1936
1952
  declare type CopyableHTML = {
1937
- type: CopyMIMEType.HTML;
1953
+ type: `${CopyMIMEType.HTML}`;
1938
1954
  content: string;
1939
1955
  };
1940
1956
 
1941
1957
  declare type CopyableList_2 = [CopyablePlain, CopyableHTML];
1942
1958
 
1943
1959
  declare type CopyablePlain = {
1944
- type: CopyMIMEType.PLAIN;
1960
+ type: `${CopyMIMEType.PLAIN}`;
1945
1961
  content: string;
1946
1962
  };
1947
1963
 
@@ -1984,7 +2000,7 @@ declare interface CornerCellStyle extends CellTextWordWrapStyle {
1984
2000
  * Corner Header for SpreadSheet
1985
2001
  */
1986
2002
  declare class CornerHeader extends BaseHeader<CornerHeaderConfig> {
1987
- constructor(config: CornerHeaderConfig);
2003
+ protected initGroups(): void;
1988
2004
  protected getCellInstance(node: Node_2_2): CornerCell_2;
1989
2005
  /**
1990
2006
  * Get corner Header by config
@@ -2000,19 +2016,16 @@ declare class CornerHeader extends BaseHeader<CornerHeaderConfig> {
2000
2016
  height: number;
2001
2017
  }): Node_2_2[];
2002
2018
  /**
2003
- * Make cornerHeader scroll with hScrollBar
2019
+ * Make cornerHeader scroll with hScrollBar
2004
2020
  * @param scrollX
2005
2021
  */
2006
2022
  onCorScroll(scrollX: number, type: string): void;
2007
- destroy(): void;
2008
2023
  protected layout(): void;
2009
- protected renderCells(): void;
2010
2024
  protected offset(): void;
2011
2025
  protected clip(): void;
2012
- getNodes(): Node_2_2[];
2013
2026
  }
2014
2027
 
2015
- declare type CornerHeaderCallback = (parent: S2CellType_2, spreadsheet: SpreadSheet_2, ...restOptions: unknown[]) => void;
2028
+ declare type CornerHeaderCallback = (cornerHeader: CornerHeader, spreadsheet: SpreadSheet_2, ...restOptions: unknown[]) => void;
2016
2029
 
2017
2030
  declare interface CornerHeaderConfig extends BaseHeaderConfig {
2018
2031
  seriesNumberWidth: number;
@@ -2128,7 +2141,7 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
2128
2141
  isChartData(): boolean;
2129
2142
  getRenderChartData(): BaseChartData;
2130
2143
  getRenderChartOptions(): {
2131
- type: MiniChartType;
2144
+ type: "line" | "bar" | "bullet";
2132
2145
  data: RawData_2[];
2133
2146
  encode?: {
2134
2147
  x: string;
@@ -2168,9 +2181,6 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
2168
2181
  intelligentReverseTextColor: boolean;
2169
2182
  };
2170
2183
  protected changeRowColSelectState(indexType: ViewMetaIndexType): void;
2171
- /**
2172
- * 预留给明细表使用,透视表数据格不需要绘制 border, 已经交由 grid 处理
2173
- */
2174
2184
  drawBorders(): void;
2175
2185
  /**
2176
2186
  * Find current field related condition
@@ -2227,13 +2237,19 @@ declare type DeepRequired<T extends Record<string, any>> = {
2227
2237
  };
2228
2238
 
2229
2239
  declare interface DefaultCellTheme extends GridAnalysisCellTheme {
2230
- /** 粗体文本样式 */
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
+ */
2231
2244
  bolderText?: TextTheme;
2232
- /** 文本样式 */
2245
+ /** 文本样式 (如: 数值, 行列头叶子节点文本) */
2233
2246
  text?: TextTheme;
2234
- /** 序号样式 */
2247
+ /** 序号文本样式 */
2235
2248
  seriesText?: TextTheme;
2236
- /** 度量值文本样式 */
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
+ */
2237
2253
  measureText?: TextTheme;
2238
2254
  /** 单元格样式 */
2239
2255
  cell?: CellTheme;
@@ -2513,7 +2529,11 @@ declare interface FrameConfig {
2513
2529
  spreadsheet: SpreadSheet_2;
2514
2530
  }
2515
2531
 
2516
- declare class FrozenGroup extends GridGroup {
2532
+ declare enum FrozenGroupArea {
2533
+ Row = "frozenRow",
2534
+ Col = "frozenCol",
2535
+ TrailingRow = "frozenTrailingRow",
2536
+ TrailingCol = "frozenTrailingCol"
2517
2537
  }
2518
2538
 
2519
2539
  declare interface GetCellDataParams {
@@ -2618,6 +2638,12 @@ declare class GuiIcon extends Group {
2618
2638
  name: string;
2619
2639
  fill: string | null;
2620
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;
2621
2647
  }
2622
2648
 
2623
2649
  declare interface GuiIconCfg extends Omit<ImageStyleProps, 'fill'> {
@@ -2660,7 +2686,7 @@ declare interface HeaderActionIcon_2 extends HeaderActionIconBaseOptions {
2660
2686
  * 所属的 cell 类型, 即当前 icon 展示在哪种类型单元格中
2661
2687
  * @example belongsCell: 'rowCell'
2662
2688
  */
2663
- belongsCell: Omit<CellType, 'dataCell' | 'mergedCell' | 'seriesNumberCell'>;
2689
+ belongsCell: Exclude<`${CellType}`, 'dataCell' | 'mergedCell' | 'seriesNumberCell'>;
2664
2690
  }
2665
2691
 
2666
2692
  declare interface HeaderActionIconBaseOptions {
@@ -2752,6 +2778,7 @@ declare abstract class HeaderCell<T extends BaseHeaderConfig = BaseHeaderConfig>
2752
2778
  backgroundColorOpacity: number;
2753
2779
  } & {
2754
2780
  backgroundColor: string;
2781
+ backgroundColorOpacity: number;
2755
2782
  intelligentReverseTextColor: boolean;
2756
2783
  };
2757
2784
  toggleActionIcon(id: string): void;
@@ -2952,7 +2979,7 @@ declare interface InteractionOptions {
2952
2979
  * 滚动条位置 (可用于表格内容未撑满 Canvas 的场景)
2953
2980
  * @example scrollbarPosition: 'content'
2954
2981
  */
2955
- scrollbarPosition?: ScrollbarPositionType;
2982
+ scrollbarPosition?: `${ScrollbarPositionType}`;
2956
2983
  /**
2957
2984
  * 透传 listener 属性的可选参数对象
2958
2985
  * @see https://developer.mozilla.org/zh-CN/docs/Web/API/EventTarget/addEventListener
@@ -3313,6 +3340,10 @@ declare class Node_2_2 {
3313
3340
  hierarchy: Hierarchy;
3314
3341
  isPivotMode: boolean;
3315
3342
  seriesNumberWidth: number;
3343
+ /**
3344
+ * 给序号列单元格用,标识该序号单元格对应了行头节点,有了关联关系后,就可以在行头冻结时做区分
3345
+ */
3346
+ relatedNode: Node_2_2;
3316
3347
  spreadsheet: SpreadSheet_2;
3317
3348
  query?: Query;
3318
3349
  belongsCell?: S2CellType_2 | null | undefined;
@@ -3321,7 +3352,8 @@ declare class Node_2_2 {
3321
3352
  isGrandTotals?: boolean;
3322
3353
  isSubTotals?: boolean;
3323
3354
  isTotalRoot?: boolean;
3324
- isFrozen?: boolean;
3355
+ isFrozenHead?: boolean;
3356
+ isFrozenTrailing?: boolean;
3325
3357
  shallowRender?: boolean;
3326
3358
  extra?: {
3327
3359
  description?: string;
@@ -3384,6 +3416,8 @@ declare class Node_2_2 {
3384
3416
  */
3385
3417
  getTotalHeightForTreeHierarchy(): number;
3386
3418
  isSeriesNumberNode(): boolean;
3419
+ clone(): Node_2_2;
3420
+ get isFrozen(): boolean | undefined;
3387
3421
  }
3388
3422
 
3389
3423
  declare interface OffsetConfig {
@@ -3483,11 +3517,7 @@ declare class PanelBBox extends BaseBBox {
3483
3517
 
3484
3518
  declare type PanelIndexes = {
3485
3519
  center: Indexes;
3486
- frozenRow?: Indexes;
3487
- frozenCol?: Indexes;
3488
- frozenTrailingRow?: Indexes;
3489
- frozenTrailingCol?: Indexes;
3490
- };
3520
+ } & Partial<Record<FrozenGroupArea, Indexes>>;
3491
3521
 
3492
3522
  declare class PanelScrollGroup extends GridGroup {
3493
3523
  protected mergedCellsGroup: Group;
@@ -3545,12 +3575,13 @@ default: Adaptive;
3545
3575
  };
3546
3576
  spreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
3547
3577
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
3578
+ onUpdate: PropType<(renderOptions: S2RenderOptions) => S2RenderOptions>;
3579
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions) => void>;
3548
3580
  }, {
3549
3581
  s2Ref: ShallowRef<SheetExpose>;
3550
3582
  options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>;
3551
3583
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3552
3584
  spreadsheet: (container: S2MountContainer, dataCfg: S2DataConfig, options: S2Options<TooltipContentType, Pagination, BaseTooltipOperatorMenuOptions>) => SpreadSheet;
3553
- sheetUpdate: SheetUpdateCallback;
3554
3585
  rowCellHover: (data: TargetCellInfo) => void;
3555
3586
  rowCellClick: (data: TargetCellInfo) => void;
3556
3587
  rowCellDoubleClick: (data: TargetCellInfo) => void;
@@ -3617,6 +3648,8 @@ layoutCellRender: <T extends S2CellType = S2CellType>(cell: T) => void;
3617
3648
  beforeRender: () => void;
3618
3649
  afterRender: () => void;
3619
3650
  mounted: (spreadsheet: SpreadSheet) => void;
3651
+ update: (renderOptions: S2RenderOptions) => S2RenderOptions;
3652
+ updateAfterRender: (renderOptions: S2RenderOptions) => void;
3620
3653
  destroy: () => void;
3621
3654
  layoutResize: (params: ResizeParams) => void;
3622
3655
  layoutResizeSeriesWidth: (params: ResizeParams) => void;
@@ -3665,7 +3698,7 @@ spreadsheet: SpreadSheet;
3665
3698
  }) => void;
3666
3699
  rowCellBrushSelection: (event: GEvent) => void;
3667
3700
  colCellBrushSelection: (event: GEvent) => void;
3668
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes< {
3701
+ }, string, PublicProps, Readonly<ExtractPropTypes< {
3669
3702
  sheetType: PropType<SheetType>;
3670
3703
  dataCfg: PropType<S2DataConfig>;
3671
3704
  themeCfg: PropType<ThemeCfg>;
@@ -3692,8 +3725,9 @@ default: Adaptive;
3692
3725
  };
3693
3726
  spreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, options: SheetComponentOptions) => SpreadSheet>;
3694
3727
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
3728
+ onUpdate: PropType<(renderOptions: S2RenderOptions) => S2RenderOptions>;
3729
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions) => void>;
3695
3730
  }>> & {
3696
- onSheetUpdate?: (params: S2RenderOptions) => any;
3697
3731
  onRowCellHover?: (data: TargetCellInfo) => any;
3698
3732
  onRowCellClick?: (data: TargetCellInfo) => any;
3699
3733
  onRowCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -3760,6 +3794,8 @@ onLayoutCellRender?: (cell: S2CellType) => any;
3760
3794
  onBeforeRender?: () => any;
3761
3795
  onAfterRender?: () => any;
3762
3796
  onMounted?: (spreadsheet: SpreadSheet) => any;
3797
+ onUpdate?: (renderOptions: S2RenderOptions) => any;
3798
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions) => any;
3763
3799
  onDestroy?: () => any;
3764
3800
  onLayoutResize?: (params: ResizeParams) => any;
3765
3801
  onLayoutResizeSeriesWidth?: (params: ResizeParams) => any;
@@ -3909,7 +3945,7 @@ declare type ResizeHandler = (data: {
3909
3945
 
3910
3946
  declare interface ResizeInfo_2 {
3911
3947
  theme: ResizeArea;
3912
- type: ResizeDirectionType;
3948
+ type: `${ResizeDirectionType}`;
3913
3949
  offsetX: number;
3914
3950
  offsetY: number;
3915
3951
  width: number;
@@ -3937,9 +3973,9 @@ declare interface ResizeInteractionOptions {
3937
3973
  /** 列头垂直方向 resize -> 针对列头各层级节点 */
3938
3974
  colCellVertical?: boolean;
3939
3975
  /** 行高调整时,影响当前行还是全部行 */
3940
- rowResizeType?: ResizeType;
3976
+ rowResizeType?: `${ResizeType}`;
3941
3977
  /** 列高调整时,影响当前列还是全部列 */
3942
- colResizeType?: ResizeType;
3978
+ colResizeType?: `${ResizeType}`;
3943
3979
  /** 是否允许调整, 返回 false 时拖拽的宽高无效 */
3944
3980
  disable?: (resizeInfo: ResizeInfo_2) => boolean;
3945
3981
  /** 是否显示热区 */
@@ -4041,6 +4077,7 @@ declare class RowCell extends HeaderCell<RowHeaderConfig> {
4041
4077
  backgroundColorOpacity: number;
4042
4078
  } & {
4043
4079
  backgroundColor: string;
4080
+ backgroundColorOpacity: number;
4044
4081
  intelligentReverseTextColor: boolean;
4045
4082
  };
4046
4083
  protected showTreeIcon(): boolean;
@@ -4053,6 +4090,10 @@ declare class RowCell extends HeaderCell<RowHeaderConfig> {
4053
4090
  protected isBolderText(): boolean;
4054
4091
  drawTextShape(): void;
4055
4092
  protected drawResizeAreaInLeaf(): void;
4093
+ protected getHorizontalResizeAreaOffset(): {
4094
+ offsetX: number;
4095
+ offsetY: number;
4096
+ };
4056
4097
  protected getContentIndent(): number;
4057
4098
  protected getTextIndent(): number;
4058
4099
  protected isTreeLevel(): any;
@@ -4099,22 +4140,37 @@ declare interface RowCellStyle extends BaseCellStyle, CellTextWordWrapStyle {
4099
4140
  * Row Header for SpreadSheet
4100
4141
  */
4101
4142
  declare class RowHeader extends BaseHeader<RowHeaderConfig> {
4102
- scrollGroup: Group;
4103
- frozenRowGroup: Group;
4104
- constructor(config: RowHeaderConfig);
4105
- private initGroups;
4106
- getCellInstance(node: Node_2_2): RowCell;
4107
- protected isRowCellInRect(node: Node_2_2): boolean;
4108
- 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;
4109
4146
  protected getCellGroup(item: Node_2_2): Group;
4110
4147
  protected layout(): void;
4148
+ protected emitRenderEvent(cell: RowCell | SeriesNumberCell_2): void;
4111
4149
  protected offset(): void;
4112
4150
  protected clip(): void;
4113
- clear(): void;
4114
4151
  }
4115
4152
 
4116
4153
  declare type RowHeaderConfig = BaseHeaderConfig;
4117
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
+
4118
4174
  declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Menu = BaseTooltipOperatorMenuOptions_2> {
4119
4175
  /**
4120
4176
  * 表格宽度
@@ -4446,30 +4502,29 @@ declare enum S2Event {
4446
4502
  }
4447
4503
 
4448
4504
  declare interface S2EventHandler {
4449
- type: keyof EmitterType;
4505
+ type: `${keyof EmitterType}`;
4450
4506
  handler: EmitterType[keyof EmitterType];
4451
4507
  }
4452
4508
 
4453
- declare type S2MountContainer_2 = string | Element;
4454
-
4455
- declare interface S2Options_2<T = TooltipContentType_2, P = Pagination_2, Menu = BaseTooltipOperatorMenuOptions_2> extends S2BasicOptions<T, P, Menu>, S2PivotSheetOptions {
4509
+ declare interface S2FrozenOptions {
4456
4510
  /**
4457
4511
  * 行列冻结
4458
4512
  */
4459
- 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 {
4460
4519
  }
4461
4520
 
4462
- declare interface S2PivotSheetFrozenOptions {
4521
+ declare interface S2PivotSheetFrozenOptions extends S2BaseFrozenOptions {
4463
4522
  /**
4464
4523
  * 是否冻结行头 (含角头区域, 透视表有效),
4465
4524
  * 当值为 number 时,标识行头冻结的最大区域,取值范围: (0, 1),0 表示不固定行头
4466
4525
  * 当值为 boolean 时,true 对应冻结最大区域为 0.5, false 对应 0
4467
4526
  */
4468
4527
  rowHeader?: boolean | number;
4469
- /**
4470
- * 是否冻结首行 (适用于总计置于顶部, 树状模式等场景)
4471
- */
4472
- firstRow?: boolean;
4473
4528
  }
4474
4529
 
4475
4530
  declare interface S2PivotSheetOptions {
@@ -4497,6 +4552,9 @@ declare interface S2PivotSheetOptions {
4497
4552
  cornerExtraFieldText?: string;
4498
4553
  }
4499
4554
 
4555
+ /**
4556
+ * 自定义渲染模式
4557
+ */
4500
4558
  declare interface S2RenderOptions_2 {
4501
4559
  /**
4502
4560
  * 是否重新加载数据
@@ -4505,7 +4563,7 @@ declare interface S2RenderOptions_2 {
4505
4563
  /**
4506
4564
  * 是否重新生成数据集
4507
4565
  */
4508
- reBuildDataSet?: boolean;
4566
+ rebuildDataSet?: boolean;
4509
4567
  /**
4510
4568
  * 是否重新生成列头隐藏信息
4511
4569
  */
@@ -4516,7 +4574,7 @@ declare interface S2Style {
4516
4574
  /**
4517
4575
  * 布局类型
4518
4576
  */
4519
- layoutWidthType?: LayoutWidthType;
4577
+ layoutWidthType?: `${LayoutWidthType}`;
4520
4578
  /**
4521
4579
  * 数值单元格配置
4522
4580
  */
@@ -4543,25 +4601,6 @@ declare interface S2Style {
4543
4601
  seriesNumberCell?: SeriesNumberCellStyle | null;
4544
4602
  }
4545
4603
 
4546
- declare interface S2TableSheetFrozenOptions {
4547
- /**
4548
- * 行头冻结数量 (明细表有效)
4549
- */
4550
- rowCount?: number;
4551
- /**
4552
- * 列头冻结数量 (明细表有效)
4553
- */
4554
- colCount?: number;
4555
- /**
4556
- * 行尾冻结数量 (明细表有效)
4557
- */
4558
- trailingRowCount?: number;
4559
- /**
4560
- * 列尾冻结数量 (明细表有效)
4561
- */
4562
- trailingColCount?: number;
4563
- }
4564
-
4565
4604
  declare interface S2Theme extends CellThemes {
4566
4605
  /** 列宽行高调整热区 */
4567
4606
  resizeArea?: ResizeArea;
@@ -4674,7 +4713,9 @@ declare interface ScrollBarTheme {
4674
4713
 
4675
4714
  declare enum ScrollDirection {
4676
4715
  SCROLL_UP = "scrollUp",
4677
- SCROLL_DOWN = "scrollDown"
4716
+ SCROLL_DOWN = "scrollDown",
4717
+ SCROLL_LEFT = "scrollLeft",
4718
+ SCROLL_RIGHT = "scrollRight"
4678
4719
  }
4679
4720
 
4680
4721
  declare interface ScrollOffset_2 {
@@ -4695,7 +4736,7 @@ declare interface SelectHeaderCellInfo {
4695
4736
  isMultiSelection?: boolean;
4696
4737
  }
4697
4738
 
4698
- declare class SeriesNumberCell_2 extends HeaderCell {
4739
+ declare class SeriesNumberCell_2 extends RowCell {
4699
4740
  get cellType(): CellType;
4700
4741
  protected getBorderPositions(): CellBorderPosition[];
4701
4742
  protected initCell(): void;
@@ -4722,7 +4763,6 @@ declare class SeriesNumberCell_2 extends HeaderCell {
4722
4763
  };
4723
4764
  protected getFormattedFieldValue(): FormatResult;
4724
4765
  getMaxTextWidth(): number;
4725
- protected getTextPosition(): PointLike;
4726
4766
  protected isBolderText(): boolean;
4727
4767
  findFieldCondition(): undefined;
4728
4768
  mappingValue(): undefined;
@@ -4732,9 +4772,7 @@ declare class SeriesNumberCell_2 extends HeaderCell {
4732
4772
  declare interface SeriesNumberCellStyle extends CellTextWordWrapStyle {
4733
4773
  }
4734
4774
 
4735
- declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
4736
- constructor(config: BaseHeaderConfig);
4737
- protected getCellInstance(node: Node_2_2): SeriesNumberCell_2;
4775
+ declare class SeriesNumberHeader extends RowHeader {
4738
4776
  /**
4739
4777
  * Get seriesNumber header by config
4740
4778
  */
@@ -4745,13 +4783,12 @@ declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
4745
4783
  spreadsheet: SpreadSheet_2;
4746
4784
  cornerWidth: number;
4747
4785
  }): SeriesNumberHeader;
4748
- clip(): void;
4749
- layout(): void;
4750
- protected offset(): void;
4751
- getNodes(): Node_2_2[];
4786
+ protected initGroups(): void;
4787
+ getCellInstance(node: Node_2_2): SeriesNumberCell_2;
4788
+ protected emitRenderEvent(cell: SeriesNumberCell_2): void;
4752
4789
  }
4753
4790
 
4754
- 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">, {
4755
4792
  s2Ref: ShallowRef<SheetExpose>;
4756
4793
  sheetType: ComputedRef<DefineComponent< {
4757
4794
  sheetType: PropType<SheetType>;
@@ -4780,12 +4817,13 @@ default: Adaptive;
4780
4817
  };
4781
4818
  spreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: SheetComponentOptions) => SpreadSheet_2>;
4782
4819
  onMounted: PropType<(spreadsheet: SpreadSheet_2) => void>;
4820
+ onUpdate: PropType<(renderOptions: S2RenderOptions_2) => S2RenderOptions_2>;
4821
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions_2) => void>;
4783
4822
  }, {
4784
4823
  s2Ref: ShallowRef<SheetExpose>;
4785
4824
  options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>;
4786
4825
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
4787
4826
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
4788
- sheetUpdate: SheetUpdateCallback;
4789
4827
  rowCellHover: (data: TargetCellInfo_2) => void;
4790
4828
  rowCellClick: (data: TargetCellInfo_2) => void;
4791
4829
  rowCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4852,6 +4890,8 @@ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
4852
4890
  beforeRender: () => void;
4853
4891
  afterRender: () => void;
4854
4892
  mounted: (spreadsheet: SpreadSheet_2) => void;
4893
+ update: (renderOptions: S2RenderOptions_2) => S2RenderOptions_2;
4894
+ updateAfterRender: (renderOptions: S2RenderOptions_2) => void;
4855
4895
  destroy: () => void;
4856
4896
  layoutResize: (params: ResizeParams_2) => void;
4857
4897
  layoutResizeSeriesWidth: (params: ResizeParams_2) => void;
@@ -4900,7 +4940,7 @@ spreadsheet: SpreadSheet_2;
4900
4940
  }) => void;
4901
4941
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
4902
4942
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
4903
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes< {
4943
+ }, string, PublicProps, Readonly<ExtractPropTypes< {
4904
4944
  sheetType: PropType<SheetType>;
4905
4945
  dataCfg: PropType<S2DataConfig_2>;
4906
4946
  themeCfg: PropType<ThemeCfg_2>;
@@ -4927,8 +4967,9 @@ default: Adaptive;
4927
4967
  };
4928
4968
  spreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: SheetComponentOptions) => SpreadSheet_2>;
4929
4969
  onMounted: PropType<(spreadsheet: SpreadSheet_2) => void>;
4970
+ onUpdate: PropType<(renderOptions: S2RenderOptions_2) => S2RenderOptions_2>;
4971
+ onUpdateAfterRender: PropType<(renderOptions: S2RenderOptions_2) => void>;
4930
4972
  }>> & {
4931
- onSheetUpdate?: (params: S2RenderOptions_2) => any;
4932
4973
  onRowCellHover?: (data: TargetCellInfo_2) => any;
4933
4974
  onRowCellClick?: (data: TargetCellInfo_2) => any;
4934
4975
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4995,6 +5036,8 @@ onLayoutCellRender?: (cell: S2CellType_2) => any;
4995
5036
  onBeforeRender?: () => any;
4996
5037
  onAfterRender?: () => any;
4997
5038
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
5039
+ onUpdate?: (renderOptions: S2RenderOptions_2) => any;
5040
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions_2) => any;
4998
5041
  onDestroy?: () => any;
4999
5042
  onLayoutResize?: (params: ResizeParams_2) => any;
5000
5043
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -5056,11 +5099,10 @@ showPagination: boolean | {
5056
5099
  onShowSizeChange?: (pageSize: number) => void;
5057
5100
  onChange?: (current: number) => void;
5058
5101
  };
5059
- }, {}> | 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">, {
5060
5103
  s2Ref: ShallowRef<SheetExpose>;
5061
5104
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
5062
5105
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
5063
- sheetUpdate: SheetUpdateCallback;
5064
5106
  rowCellHover: (data: TargetCellInfo_2) => void;
5065
5107
  rowCellClick: (data: TargetCellInfo_2) => void;
5066
5108
  rowCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5127,6 +5169,8 @@ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
5127
5169
  beforeRender: () => void;
5128
5170
  afterRender: () => void;
5129
5171
  mounted: (spreadsheet: SpreadSheet_2) => void;
5172
+ update: (renderOptions: S2RenderOptions_2) => S2RenderOptions_2;
5173
+ updateAfterRender: (renderOptions: S2RenderOptions_2) => void;
5130
5174
  destroy: () => void;
5131
5175
  layoutResize: (params: ResizeParams_2) => void;
5132
5176
  layoutResizeSeriesWidth: (params: ResizeParams_2) => void;
@@ -5175,8 +5219,7 @@ spreadsheet: SpreadSheet_2;
5175
5219
  }) => void;
5176
5220
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
5177
5221
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
5178
- }, 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">>> & {
5179
- 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">>> & {
5180
5223
  onRowCellHover?: (data: TargetCellInfo_2) => any;
5181
5224
  onRowCellClick?: (data: TargetCellInfo_2) => any;
5182
5225
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5243,6 +5286,8 @@ onLayoutCellRender?: (cell: S2CellType_2) => any;
5243
5286
  onBeforeRender?: () => any;
5244
5287
  onAfterRender?: () => any;
5245
5288
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
5289
+ onUpdate?: (renderOptions: S2RenderOptions_2) => any;
5290
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions_2) => any;
5246
5291
  onDestroy?: () => any;
5247
5292
  onLayoutResize?: (params: ResizeParams_2) => any;
5248
5293
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -5295,7 +5340,6 @@ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options
5295
5340
  }, {}, {}>>;
5296
5341
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
5297
5342
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
5298
- sheetUpdate: SheetUpdateCallback;
5299
5343
  rowCellHover: (data: TargetCellInfo_2) => void;
5300
5344
  rowCellClick: (data: TargetCellInfo_2) => void;
5301
5345
  rowCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5362,6 +5406,8 @@ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
5362
5406
  beforeRender: () => void;
5363
5407
  afterRender: () => void;
5364
5408
  mounted: (spreadsheet: SpreadSheet_2) => void;
5409
+ update: (renderOptions: S2RenderOptions_2) => S2RenderOptions_2;
5410
+ updateAfterRender: (renderOptions: S2RenderOptions_2) => void;
5365
5411
  destroy: () => void;
5366
5412
  layoutResize: (params: ResizeParams_2) => void;
5367
5413
  layoutResizeSeriesWidth: (params: ResizeParams_2) => void;
@@ -5410,8 +5456,7 @@ spreadsheet: SpreadSheet_2;
5410
5456
  }) => void;
5411
5457
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
5412
5458
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
5413
- }, 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">>> & {
5414
- 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">>> & {
5415
5460
  onRowCellHover?: (data: TargetCellInfo_2) => any;
5416
5461
  onRowCellClick?: (data: TargetCellInfo_2) => any;
5417
5462
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5478,6 +5523,8 @@ onLayoutCellRender?: (cell: S2CellType_2) => any;
5478
5523
  onBeforeRender?: () => any;
5479
5524
  onAfterRender?: () => any;
5480
5525
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
5526
+ onUpdate?: (renderOptions: S2RenderOptions_2) => any;
5527
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions_2) => any;
5481
5528
  onDestroy?: () => any;
5482
5529
  onLayoutResize?: (params: ResizeParams_2) => any;
5483
5530
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -5539,9 +5586,6 @@ export declare interface SheetExpose {
5539
5586
 
5540
5587
  declare type SheetType = 'pivot' | 'table' | 'chart' | 'gridAnalysis' | 'strategy' | 'editable';
5541
5588
 
5542
- /** render callback */
5543
- declare type SheetUpdateCallback = (params: S2RenderOptions) => S2RenderOptions;
5544
-
5545
5589
  declare type ShowPagination<OverrideShowPagination, Options> = OverrideShowPagination extends true ? Options extends {
5546
5590
  pagination?: {
5547
5591
  onShowSizeChange?: unknown;
@@ -5639,7 +5683,6 @@ declare abstract class SpreadSheet_2 extends EE {
5639
5683
  private destroyed;
5640
5684
  protected abstract bindEvents(): void;
5641
5685
  abstract getDataSet(): BaseDataSet_2;
5642
- abstract enableFrozenHeaders(): boolean;
5643
5686
  abstract isPivotMode(): boolean;
5644
5687
  abstract isCustomRowFields(): boolean;
5645
5688
  abstract isHierarchyTreeType(): boolean;
@@ -5647,8 +5690,8 @@ declare abstract class SpreadSheet_2 extends EE {
5647
5690
  abstract isTableMode(): boolean;
5648
5691
  abstract isValueInCols(): boolean;
5649
5692
  protected abstract buildFacet(): void;
5650
- abstract clearDrillDownData(rowNodeId?: string, preventRender?: boolean): void;
5651
- 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;
5652
5695
  constructor(dom: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2 | null);
5653
5696
  isCustomHeaderFields(fieldType?: keyof Pick<Fields, 'columns' | 'rows'>): boolean;
5654
5697
  isCustomColumnFields(): boolean;
@@ -5717,7 +5760,7 @@ declare abstract class SpreadSheet_2 extends EE {
5717
5760
  s2.render(false)
5718
5761
  s2.render({
5719
5762
  reloadData: true;
5720
- reBuildDataSet: true;
5763
+ rebuildDataSet: true;
5721
5764
  reBuildHiddenColumnsDetail: true;
5722
5765
  })
5723
5766
  */
@@ -5749,8 +5792,8 @@ declare abstract class SpreadSheet_2 extends EE {
5749
5792
  * @param height
5750
5793
  */
5751
5794
  changeSheetSize(width?: number, height?: number): void;
5752
- on<K extends keyof EmitterType>(event: K, listener: EmitterType[K]): this;
5753
- 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;
5754
5797
  /**
5755
5798
  * 获取 G Canvas 实例
5756
5799
  * @see https://g.antv.antgroup.com/api/renderer/canvas
@@ -5767,7 +5810,7 @@ declare abstract class SpreadSheet_2 extends EE {
5767
5810
  getCanvasElement(): HTMLCanvasElement & {
5768
5811
  __s2_instance__: SpreadSheet_2;
5769
5812
  };
5770
- getLayoutWidthType(): LayoutWidthType;
5813
+ getLayoutWidthType(): "adaptive" | "colAdaptive" | "compact";
5771
5814
  /**
5772
5815
  * Update scroll's offset, the value can be undefined,
5773
5816
  * indicate not update current value
@@ -5827,6 +5870,7 @@ declare abstract class SpreadSheet_2 extends EE {
5827
5870
  updateSortMethodMap(nodeId: string, sortMethod: SortMethod, replace?: boolean): void;
5828
5871
  getMenuDefaultSelectedKeys(nodeId: string): string[];
5829
5872
  handleGroupSort(event: FederatedPointerEvent, meta: Node_2_2): void;
5873
+ getSeriesNumberText(): string;
5830
5874
  }
5831
5875
 
5832
5876
  declare type StateShapeLayer = 'interactiveBgShape' | 'interactiveBorderShape';
@@ -5940,7 +5984,6 @@ declare class TableColCell extends ColCell_2 {
5940
5984
  x: number;
5941
5985
  y: number;
5942
5986
  };
5943
- protected getColResizeArea(): Group_2 | undefined;
5944
5987
  protected isSortCell(): boolean;
5945
5988
  protected showSortIcon(): boolean | undefined;
5946
5989
  protected getTextStyle(): {
@@ -5961,28 +6004,13 @@ declare class TableColCell extends ColCell_2 {
5961
6004
  };
5962
6005
  protected getHorizontalResizeAreaName(): string;
5963
6006
  protected drawBackgroundShape(): void;
5964
- protected handleViewport(): AreaRange;
5965
6007
  }
5966
6008
 
5967
6009
  /**
5968
6010
  * Column Header for SpreadSheet
5969
6011
  */
5970
6012
  declare class TableColHeader extends ColHeader {
5971
- frozenColGroup: Group;
5972
- frozenTrailingColGroup: Group;
5973
- private finalColCount;
5974
- private finalTrailingColCount;
5975
- private topLevelColNodeLength;
5976
- constructor(config: ColHeaderConfig);
5977
6013
  protected getCellInstance(node: Node_2_2): ColCell_2;
5978
- private initFrozenColGroups;
5979
- clear(): void;
5980
- private getColFrozenOptionsByNode;
5981
- protected getCellGroup(node: Node_2_2): Group;
5982
- protected isColCellInRect(node: Node_2_2): boolean;
5983
- getScrollGroupClipBBox: () => RectStyleProps;
5984
- protected offset(): void;
5985
- protected clip(): void;
5986
6014
  }
5987
6015
 
5988
6016
  declare class TableCornerCell extends TableColCell {
@@ -5992,7 +6020,6 @@ declare class TableCornerCell extends TableColCell {
5992
6020
 
5993
6021
  declare class TableDataCell_2 extends DataCell_2 {
5994
6022
  protected getLinkFieldStyle(): string;
5995
- drawBorders(): void;
5996
6023
  protected shouldDrawResizeArea(): boolean;
5997
6024
  drawResizeArea(): void;
5998
6025
  protected isDisableHover(cellMeta: CellMeta): boolean;
@@ -6003,11 +6030,10 @@ declare class TableSeriesNumberCell extends TableDataCell_2 {
6003
6030
  protected getTextStyle(): TextTheme;
6004
6031
  }
6005
6032
 
6006
- 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">, {
6007
6034
  s2Ref: ShallowRef<SheetExpose>;
6008
6035
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
6009
6036
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
6010
- sheetUpdate: SheetUpdateCallback;
6011
6037
  rowCellHover: (data: TargetCellInfo_2) => void;
6012
6038
  rowCellClick: (data: TargetCellInfo_2) => void;
6013
6039
  rowCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -6074,6 +6100,8 @@ layoutCellRender: <T extends S2CellType_2 = S2CellType_2>(cell: T) => void;
6074
6100
  beforeRender: () => void;
6075
6101
  afterRender: () => void;
6076
6102
  mounted: (spreadsheet: SpreadSheet_2) => void;
6103
+ update: (renderOptions: S2RenderOptions_2) => S2RenderOptions_2;
6104
+ updateAfterRender: (renderOptions: S2RenderOptions_2) => void;
6077
6105
  destroy: () => void;
6078
6106
  layoutResize: (params: ResizeParams_2) => void;
6079
6107
  layoutResizeSeriesWidth: (params: ResizeParams_2) => void;
@@ -6122,8 +6150,7 @@ spreadsheet: SpreadSheet_2;
6122
6150
  }) => void;
6123
6151
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
6124
6152
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
6125
- }, 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">>> & {
6126
- 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">>> & {
6127
6154
  onRowCellHover?: (data: TargetCellInfo_2) => any;
6128
6155
  onRowCellClick?: (data: TargetCellInfo_2) => any;
6129
6156
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -6190,6 +6217,8 @@ onLayoutCellRender?: (cell: S2CellType_2) => any;
6190
6217
  onBeforeRender?: () => any;
6191
6218
  onAfterRender?: () => any;
6192
6219
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
6220
+ onUpdate?: (renderOptions: S2RenderOptions_2) => any;
6221
+ onUpdateAfterRender?: (renderOptions: S2RenderOptions_2) => any;
6193
6222
  onDestroy?: () => any;
6194
6223
  onLayoutResize?: (params: ResizeParams_2) => any;
6195
6224
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -6555,7 +6584,7 @@ declare interface ValueRange {
6555
6584
 
6556
6585
  declare type ValueRanges = Record<string, ValueRange>;
6557
6586
 
6558
- export declare const version = "@antv/s2-vue-v2.0.0-next.14";
6587
+ export declare const version = "@antv/s2-vue-v2.0.0-next.15";
6559
6588
 
6560
6589
  declare interface ViewCellHeights {
6561
6590
  getCellOffsetY: (index: number) => number;