@antv/s2-vue 1.6.0-alpha.1 → 1.6.1

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
@@ -3,7 +3,7 @@ import { BaseTooltip } from '@antv/s2';
3
3
  import type { BBox } from '@antv/g-canvas';
4
4
  import { Canvas } from '@antv/g-canvas';
5
5
  import { CellMeta } from '@antv/s2';
6
- import { CellScrollPosition } from '@antv/s2';
6
+ import type { CellScrollPosition } from '@antv/s2';
7
7
  import { CollapsedRowsType } from '@antv/s2';
8
8
  import { ComponentCustomProps } from 'vue';
9
9
  import { ComponentOptionsMixin } from 'vue';
@@ -24,7 +24,7 @@ import { Group } from '@antv/g-canvas';
24
24
  import { HiddenColumnsInfo } from '@antv/s2';
25
25
  import type { IElement } from '@antv/g-canvas';
26
26
  import { IGroup } from '@antv/g-canvas';
27
- import type { IShape } from '@antv/g-canvas';
27
+ import { IShape } from '@antv/g-canvas';
28
28
  import { LayoutResult } from '@antv/s2';
29
29
  import { MemoizedFunction } from 'lodash';
30
30
  import { Node as Node_2 } from '@antv/s2';
@@ -41,6 +41,7 @@ import { S2DataConfig } from '@antv/s2';
41
41
  import { S2MountContainer } from '@antv/s2';
42
42
  import { S2Options } from '@antv/s2';
43
43
  import { S2RenderOptions } from '@antv/s2';
44
+ import { ScrollOffset } from '@antv/s2';
44
45
  import { ShallowRef } from 'vue';
45
46
  import { Shape } from '@antv/g-canvas';
46
47
  import { ShapeAttrs } from '@antv/g-canvas';
@@ -68,11 +69,6 @@ declare enum Aggregation {
68
69
  AVG = "AVG"
69
70
  }
70
71
 
71
- declare interface AreaRange {
72
- start: number;
73
- width: number;
74
- }
75
-
76
72
  declare interface Background {
77
73
  opacity?: number;
78
74
  color?: string;
@@ -134,6 +130,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
134
130
  };
135
131
  };
136
132
  getActualText(): string;
133
+ isTextOverflowing(): boolean;
137
134
  getFieldValue(): string;
138
135
  /**
139
136
  * in case there are more params to be handled
@@ -158,6 +155,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
158
155
  protected abstract getTextPosition(): Point;
159
156
  protected abstract findFieldCondition(conditions: Condition[]): Condition;
160
157
  protected abstract mappingValue(condition: Condition): MappingResult;
158
+ protected shouldInit(): boolean;
161
159
  getStyle<K extends keyof S2Theme = keyof CellThemes>(name?: K): DefaultCellTheme | S2Theme[K];
162
160
  protected getResizeAreaStyle(): ResizeArea;
163
161
  protected shouldDrawResizeAreaByType(type: keyof ResizeInteractionOptions, cell: S2CellType_2): boolean | ((cell: S2CellType_2<ViewMeta_2>) => boolean) | ResizeType | ((resizeInfo: ResizeInfo_2) => boolean);
@@ -179,6 +177,8 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
179
177
  };
180
178
  protected drawTextShape(): void;
181
179
  protected drawLinkFieldShape(showLinkFieldShape: boolean, linkFillColor: string): void;
180
+ protected getLinkFieldStyle(): string;
181
+ protected drawLinkField(meta: Node_2_2 | ViewMeta_2): void;
182
182
  updateByState(stateName: InteractionStateName, cell: S2CellType_2): void;
183
183
  protected getInteractiveBorderShapeStyle<T>(style: T & number): {
184
184
  x: number;
@@ -198,6 +198,10 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
198
198
  get cellConditions(): Conditions;
199
199
  drawConditionIconShapes(): void;
200
200
  getTextConditionFill(textStyle: TextTheme): string;
201
+ protected getCrossBackgroundColor(rowIndex: number): {
202
+ backgroundColorOpacity: number;
203
+ backgroundColor: string;
204
+ };
201
205
  }
202
206
 
203
207
  declare interface BaseChartData {
@@ -221,10 +225,10 @@ declare abstract class BaseDataSet_2 {
221
225
  meta: Meta[];
222
226
  originData: DataType_2[];
223
227
  totalData: DataType_2[];
224
- indexesData: DataType_2[][] | DataType_2[];
228
+ indexesData: Record<string, DataType_2[][] | DataType_2[]>;
225
229
  sortParams: SortParams_2;
226
230
  filterParams: FilterParam[];
227
- protected spreadsheet: SpreadSheet_2;
231
+ spreadsheet: SpreadSheet_2;
228
232
  constructor(spreadsheet: SpreadSheet_2);
229
233
  protected displayData: DataType_2[];
230
234
  /**
@@ -247,7 +251,10 @@ declare abstract class BaseDataSet_2 {
247
251
  */
248
252
  getFieldDescription(field: string): string;
249
253
  setDataCfg(dataCfg: S2DataConfig_2): void;
254
+ processMeta(meta: Meta[], defaultExtraFieldText: string): Meta[];
250
255
  getDisplayDataSet(): DataType_2[];
256
+ isEmpty(): boolean;
257
+ getEmptyViewIndexes(): Indexes;
251
258
  getValueRangeByField(field: string): ValueRange;
252
259
  /** ******************NEED IMPLEMENT BY USER CASE************************ */
253
260
  /**
@@ -272,7 +279,7 @@ declare abstract class BaseDataSet_2 {
272
279
  * @param field current dimensions
273
280
  * @param query dimension value query
274
281
  */
275
- abstract getDimensionValues(field: string, query?: DataType_2): string[];
282
+ abstract getDimensionValues(field: string, query?: Query): string[];
276
283
  /**
277
284
  * In most cases, this function to get the specific
278
285
  * cross data cell data
@@ -280,15 +287,17 @@ declare abstract class BaseDataSet_2 {
280
287
  */
281
288
  abstract getCellData(params: CellDataParams): DataType_2;
282
289
  /**
283
- * To get a row or column cells data;
284
- * if query is empty, return all data
290
+ * 获取符合 query 的所有单元格数据,如果 query 为空,返回空数组
285
291
  * @param query
286
- * @param isTotals
287
- * @param isRow
288
- * @param drillDownFields
292
+ * @param params 默认获取符合 query 的所有数据,包括小计总计等汇总数据;
293
+ * 如果只希望获取明细数据,请使用 { queryType: QueryDataType.DetailOnly }
289
294
  */
290
- abstract getMultiData(query: DataType_2, isTotals?: boolean, isRow?: boolean, drillDownFields?: string[]): DataType_2[];
295
+ abstract getMultiData(query: Query, params?: MultiDataParams): Data_2[];
291
296
  moreThanOneValue(): boolean;
297
+ /**
298
+ * get a row cells data including cell
299
+ */
300
+ abstract getRowData(cellMeta: CellMeta_2 | ViewMeta_2 | Node): RowData;
292
301
  }
293
302
 
294
303
  declare interface BaseDrillDownComponentProps<DataSet = BaseDataSet> {
@@ -336,7 +345,8 @@ declare abstract class BaseFacet {
336
345
  centerFrame: Frame;
337
346
  gridInfo: GridInfo;
338
347
  protected abstract doLayout(): LayoutResult_2;
339
- abstract getViewCellHeights(layoutResult: LayoutResult_2): ViewCellHeights;
348
+ abstract getContentHeight(): number;
349
+ abstract getViewCellHeights(layoutResult?: LayoutResult_2): ViewCellHeights;
340
350
  protected scrollFrameId: ReturnType<typeof requestAnimationFrame>;
341
351
  get scrollBarTheme(): ScrollBarTheme;
342
352
  get scrollBarSize(): number;
@@ -370,12 +380,11 @@ declare abstract class BaseFacet {
370
380
  width: number;
371
381
  height: number;
372
382
  };
373
- getContentHeight(): number;
374
383
  updateScrollOffset(offsetConfig: OffsetConfig): void;
375
384
  getPaginationScrollY(): number;
376
385
  destroy(): void;
377
- setScrollOffset: (scrollOffset: ScrollOffset) => void;
378
- getScrollOffset: () => ScrollOffset;
386
+ setScrollOffset: (scrollOffset: ScrollOffset_2) => void;
387
+ getScrollOffset: () => ScrollOffset_2;
379
388
  emitPaginationEvent: () => void;
380
389
  private unbindEvents;
381
390
  clipPanelGroup: () => void;
@@ -402,12 +411,12 @@ declare abstract class BaseFacet {
402
411
  scrollImmediately: (offsetConfig?: OffsetConfig) => void;
403
412
  /**
404
413
  *
405
- * @param skipScrollEvent 如为true则不触发S2Event.GLOBAL_SCROLL
414
+ * @param skipScrollEvent 不触发 S2Event.GLOBAL_SCROLL
406
415
  */
407
416
  startScroll: (skipScrollEvent?: boolean) => void;
408
417
  getRendererHeight: () => number;
409
418
  private getAdjustedScrollOffset;
410
- renderRowScrollBar: (rowScrollX: number) => void;
419
+ renderRowScrollBar: (rowHeaderScrollX: number) => void;
411
420
  getValidScrollBarOffset: (offset: number, maxOffset: number) => number;
412
421
  renderHScrollBar: (width: number, realWidth: number, scrollX: number) => void;
413
422
  private getScrollbarPosition;
@@ -444,6 +453,7 @@ declare abstract class BaseFacet {
444
453
  private stopScrollChainingIfNeeded;
445
454
  private stopScrollChaining;
446
455
  onWheel: (event: WheelEvent) => void;
456
+ protected panelScrollGroupClip(scrollX: number, scrollY: number): void;
447
457
  protected clip(scrollX: number, scrollY: number): void;
448
458
  /**
449
459
  * Translate panelGroup, rowHeader, cornerHeader, columnHeader ect
@@ -475,6 +485,7 @@ declare abstract class BaseFacet {
475
485
  * 5. series number header
476
486
  */
477
487
  protected renderHeaders(): void;
488
+ protected getRowHeaderCfg(): RowHeaderConfig;
478
489
  protected getRowHeader(): RowHeader;
479
490
  protected getColHeader(): ColHeader;
480
491
  protected getCornerHeader(): CornerHeader;
@@ -496,6 +507,22 @@ declare abstract class BaseFacet {
496
507
  protected onAfterScroll: DebouncedFunc<() => void>;
497
508
  protected saveInitColumnLeafNodes(columnNodes?: Node_2_2[]): void;
498
509
  getHiddenColumnsInfo(columnNode: Node_2_2): HiddenColumnsInfo_2 | null;
510
+ getCornerNodes(): Node_2_2[];
511
+ }
512
+
513
+ declare class BaseFrozenRowHeader extends RowHeader {
514
+ scrollGroup: IGroup;
515
+ frozenHeadGroup: IGroup;
516
+ constructor(cfg: RowHeaderConfig);
517
+ protected rowCellInRectXDir(item: Node_2_2): boolean;
518
+ protected rowCellInRectYDir(item: Node_2_2): boolean;
519
+ protected rowCellInRect(item: Node_2_2): boolean;
520
+ protected getCellGroup(item: Node_2_2): IGroup;
521
+ protected offset(): void;
522
+ clip(): void;
523
+ isFrozenRow(node: Node_2_2): boolean;
524
+ getFrozenFirstRowHeight(): number;
525
+ clear(): void;
499
526
  }
500
527
 
501
528
  /**
@@ -506,6 +533,7 @@ declare abstract class BaseFacet {
506
533
  declare abstract class BaseHeader<T extends BaseHeaderConfig> extends Group {
507
534
  protected headerConfig: T;
508
535
  protected constructor(cfg: T);
536
+ getConfig(): T;
509
537
  /**
510
538
  * 清空热区,为重绘做准备,防止热区重复渲染
511
539
  * @param type 当前重绘的header类型
@@ -521,10 +549,10 @@ declare abstract class BaseHeader<T extends BaseHeaderConfig> extends Group {
521
549
  onScrollXY(scrollX: number, scrollY: number, type: string): void;
522
550
  /**
523
551
  * Only call when hRowScrollBar scrolls
524
- * @param rowScrollX hRowScrollbar horizontal offset
552
+ * @param rowHeaderScrollX hRowScrollbar horizontal offset
525
553
  * @param type
526
554
  */
527
- onRowScrollX(rowScrollX: number, type: string): void;
555
+ onRowScrollX(rowHeaderScrollX: number, type: string): void;
528
556
  protected abstract layout(): any;
529
557
  protected abstract offset(): any;
530
558
  protected abstract clip(): any;
@@ -570,6 +598,7 @@ declare interface BaseNodeConfig {
570
598
  isSubTotals?: boolean;
571
599
  isCollapsed?: boolean;
572
600
  isGrandTotals?: boolean;
601
+ isTotalRoot?: boolean;
573
602
  hierarchy?: Hierarchy;
574
603
  isPivotMode?: boolean;
575
604
  seriesNumberWidth?: number;
@@ -586,9 +615,53 @@ declare interface BaseNodeConfig {
586
615
  height?: number;
587
616
  padding?: number;
588
617
  children?: Node_2_2[];
618
+ hiddenColumnsInfo?: HiddenColumnsInfo_2 | null;
589
619
  extra?: Record<string, any>;
590
620
  }
591
621
 
622
+ declare class BaseRowCell extends HeaderCell {
623
+ protected headerConfig: RowHeaderConfig;
624
+ protected gm: GM;
625
+ get cellType(): CellTypes;
626
+ destroy(): void;
627
+ protected initCell(): void;
628
+ getBackgroundColor(): {
629
+ backgroundColor: string;
630
+ backgroundColorOpacity: number;
631
+ };
632
+ /**
633
+ * 绘制hover悬停,刷选的外框
634
+ */
635
+ protected drawInteractiveBorderShape(): void;
636
+ protected drawInteractiveBgShape(): void;
637
+ protected showTreeIcon(): boolean;
638
+ protected showTreeLeafNodeAlignDot(): boolean;
639
+ protected getParentTreeIconCfg(): any;
640
+ protected drawTreeIcon(): void;
641
+ protected drawTreeLeafNodeAlignDot(): void;
642
+ protected isBolderText(): boolean;
643
+ protected drawTextShape(): void;
644
+ protected drawRectBorder(): void;
645
+ protected getResizeClipAreaBBox(): SimpleBBox;
646
+ protected drawResizeAreaInLeaf(): void;
647
+ protected getContentIndent(): number;
648
+ protected getTextIndent(): number;
649
+ protected isTreeLevel(): any;
650
+ protected getIconPosition(): {
651
+ x: any;
652
+ y: any;
653
+ };
654
+ protected getMaxTextWidth(): number;
655
+ protected getTextArea(): SimpleBBox;
656
+ protected getAdjustTextAreaHeight(textArea: SimpleBBox, scrollY: number, viewportHeight: number): number;
657
+ protected calculateTextY({ textArea, adjustTextAreaHeight, }: {
658
+ textArea: SimpleBBox;
659
+ adjustTextAreaHeight: number;
660
+ }): number;
661
+ protected getTextPosition(): Point;
662
+ protected getIconYPosition(): number;
663
+ }
664
+
592
665
  export declare const BaseSheet: DefineComponent< {
593
666
  sheetType: PropType<SheetType>;
594
667
  dataCfg: PropType<S2DataConfig>;
@@ -649,7 +722,7 @@ id: number;
649
722
  isCollapsed: boolean;
650
723
  node: Node_2;
651
724
  }) => void;
652
- rowCellScroll: (position: CellScrollPosition) => void;
725
+ rowCellScroll: (position: Required<ScrollOffset>) => void;
653
726
  colCellHover: (data: TargetCellInfo) => void;
654
727
  colCellClick: (data: TargetCellInfo) => void;
655
728
  colCellDoubleClick: (data: TargetCellInfo) => void;
@@ -667,6 +740,7 @@ dataCellMouseMove: (data: TargetCellInfo) => void;
667
740
  dataCellTrendIconClick: (meta: ViewMeta) => void;
668
741
  dataCellBrushSelection: (brushRangeDataCells: DataCell[]) => void;
669
742
  dataCellSelectMove: (metas: CellMeta[]) => void;
743
+ dataCellEditEnd: (meta: ViewMeta) => void;
670
744
  cornerCellHover: (data: TargetCellInfo) => void;
671
745
  cornerCellClick: (data: TargetCellInfo) => void;
672
746
  cornerCellDoubleClick: (data: TargetCellInfo) => void;
@@ -695,7 +769,7 @@ pageCount: number;
695
769
  total: number;
696
770
  current: number;
697
771
  }) => void;
698
- layoutCellScroll: (position: CellScrollPosition) => void;
772
+ layoutCellScroll: (position: Required<ScrollOffset>) => void;
699
773
  layoutCollapseRows: (data: CollapsedRowsType) => void;
700
774
  layoutAfterCollapseRows: (data: CollapsedRowsType) => void;
701
775
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -747,7 +821,7 @@ linkFieldJump: (data: {
747
821
  key: string;
748
822
  record: Data;
749
823
  }) => void;
750
- scroll: (position: CellScrollPosition) => void;
824
+ scroll: (position: Required<ScrollOffset>) => void;
751
825
  layoutAfterRealDataCellRender: (options: {
752
826
  add: [number, number][];
753
827
  remove: [number, number][];
@@ -784,7 +858,6 @@ onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, opt
784
858
  onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet) => void>;
785
859
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
786
860
  }>> & {
787
- onMounted?: (spreadsheet: SpreadSheet) => any;
788
861
  onSheetUpdate?: (params: S2RenderOptions) => any;
789
862
  onRowCellHover?: (data: TargetCellInfo) => any;
790
863
  onRowCellClick?: (data: TargetCellInfo) => any;
@@ -798,7 +871,7 @@ id: number;
798
871
  isCollapsed: boolean;
799
872
  node: Node_2;
800
873
  }) => any;
801
- onRowCellScroll?: (position: CellScrollPosition) => any;
874
+ onRowCellScroll?: (position: Required<ScrollOffset>) => any;
802
875
  onColCellHover?: (data: TargetCellInfo) => any;
803
876
  onColCellClick?: (data: TargetCellInfo) => any;
804
877
  onColCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -816,6 +889,7 @@ onDataCellMouseMove?: (data: TargetCellInfo) => any;
816
889
  onDataCellTrendIconClick?: (meta: ViewMeta) => any;
817
890
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell[]) => any;
818
891
  onDataCellSelectMove?: (metas: CellMeta[]) => any;
892
+ onDataCellEditEnd?: (meta: ViewMeta) => any;
819
893
  onCornerCellHover?: (data: TargetCellInfo) => any;
820
894
  onCornerCellClick?: (data: TargetCellInfo) => any;
821
895
  onCornerCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -844,7 +918,7 @@ pageCount: number;
844
918
  total: number;
845
919
  current: number;
846
920
  }) => any;
847
- onLayoutCellScroll?: (position: CellScrollPosition) => any;
921
+ onLayoutCellScroll?: (position: Required<ScrollOffset>) => any;
848
922
  onLayoutCollapseRows?: (data: CollapsedRowsType) => any;
849
923
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType) => any;
850
924
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -855,6 +929,7 @@ hiddenColumnsDetail: HiddenColumnsInfo[];
855
929
  }) => any;
856
930
  onBeforeRender?: () => any;
857
931
  onAfterRender?: () => any;
932
+ onMounted?: (spreadsheet: SpreadSheet) => any;
858
933
  onDestroy?: () => any;
859
934
  onLayoutResize?: (params: ResizeParams) => any;
860
935
  onLayoutResizeSeriesWidth?: (params: ResizeParams) => any;
@@ -895,7 +970,7 @@ onLinkFieldJump?: (data: {
895
970
  key: string;
896
971
  record: Data;
897
972
  }) => any;
898
- onScroll?: (position: CellScrollPosition) => any;
973
+ onScroll?: (position: Required<ScrollOffset>) => any;
899
974
  onLayoutAfterRealDataCellRender?: (options: {
900
975
  add: [number, number][];
901
976
  remove: [number, number][];
@@ -917,9 +992,9 @@ showPagination: boolean | {
917
992
  onShowSizeChange?: (pageSize: number) => void;
918
993
  onChange?: (current: number) => void;
919
994
  };
920
- }>;
995
+ }, {}>;
921
996
 
922
- declare interface BaseSheetComponentProps<PartialDrillDown = unknown, Header = unknown, Options = S2Options<TooltipContentType, Pagination>> {
997
+ declare interface BaseSheetComponentProps<PartialDrillDown = unknown, Header = unknown, Options = S2Options<TooltipContentType, Pagination>, OverrideShowPagination = false> {
923
998
  sheetType?: SheetType;
924
999
  spreadsheet?: (container: S2MountContainer, dataCfg: S2DataConfig, options: Options) => SpreadSheet;
925
1000
  dataCfg: S2DataConfig;
@@ -927,10 +1002,7 @@ declare interface BaseSheetComponentProps<PartialDrillDown = unknown, Header = u
927
1002
  loading?: boolean;
928
1003
  partDrillDown?: PartialDrillDown;
929
1004
  adaptive?: Adaptive;
930
- showPagination?: boolean | {
931
- onShowSizeChange?: (pageSize: number) => void;
932
- onChange?: (current: number) => void;
933
- };
1005
+ showPagination?: ShowPagination<OverrideShowPagination, Options>;
934
1006
  themeCfg?: ThemeCfg;
935
1007
  header?: Header;
936
1008
  /** @deprecated 1.29.0 已废弃, 请使用 onMounted 代替 */
@@ -967,6 +1039,7 @@ declare interface BaseSheetComponentProps<PartialDrillDown = unknown, Header = u
967
1039
  onDataCellTrendIconClick?: (meta: ViewMeta) => void;
968
1040
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell[]) => void;
969
1041
  onDataCellSelectMove?: (metas: CellMeta[]) => void;
1042
+ onDataCellEditEnd?: (meta: ViewMeta) => void;
970
1043
  onCornerCellHover?: (data: TargetCellInfo) => void;
971
1044
  onCornerCellClick?: (data: TargetCellInfo) => void;
972
1045
  onCornerCellDoubleClick?: (data: TargetCellInfo) => void;
@@ -1122,7 +1195,7 @@ declare interface BulletValue {
1122
1195
 
1123
1196
  declare interface CalcTotals {
1124
1197
  aggregation?: Aggregation;
1125
- calcFunc?: (query: DataType_2, arr: DataType_2[]) => number;
1198
+ calcFunc?: (query: Query, arr: DataType_2[]) => number;
1126
1199
  }
1127
1200
 
1128
1201
  declare type CanvasEventHandler = (event: Event_2) => void;
@@ -1154,10 +1227,11 @@ declare interface CellCfg {
1154
1227
  declare type CellCustomWidth = number | ((node: Node_2_2) => number);
1155
1228
 
1156
1229
  declare interface CellDataParams {
1157
- query: DataType_2;
1230
+ query: Query;
1158
1231
  isTotals?: boolean;
1159
1232
  rowNode?: Node_2_2;
1160
1233
  isRow?: boolean;
1234
+ totalStatus?: TotalStatus;
1161
1235
  }
1162
1236
 
1163
1237
  declare interface CellMeta_2 {
@@ -1165,6 +1239,7 @@ declare interface CellMeta_2 {
1165
1239
  colIndex: number;
1166
1240
  rowIndex: number;
1167
1241
  type: CellTypes;
1242
+ rowQuery?: Record<string, any>;
1168
1243
  [key: string]: unknown;
1169
1244
  }
1170
1245
 
@@ -1176,10 +1251,7 @@ declare interface CellScrollOffset {
1176
1251
  offsetY: number;
1177
1252
  }
1178
1253
 
1179
- declare interface CellScrollPosition_2 {
1180
- scrollX: number;
1181
- scrollY: number;
1182
- }
1254
+ declare type CellScrollPosition_2 = Required<ScrollOffset_2>;
1183
1255
 
1184
1256
  declare interface CellTheme {
1185
1257
  crossBackgroundColor?: string;
@@ -1195,6 +1267,8 @@ declare interface CellTheme {
1195
1267
  interactionState?: InteractionState;
1196
1268
  miniBarChartHeight?: number;
1197
1269
  miniBarChartFillColor?: string;
1270
+ /** 单元格边线虚线 */
1271
+ borderDash?: number[];
1198
1272
  }
1199
1273
 
1200
1274
  declare type CellThemes = {
@@ -1244,20 +1318,16 @@ declare class ColCell extends HeaderCell {
1244
1318
  protected getExpandIconTheme(): IconTheme;
1245
1319
  protected addExpandColumnSplitLine(): void;
1246
1320
  protected addExpandColumnIconShapes(): void;
1247
- protected addExpandColumnIcon(): void;
1248
- protected getExpandColumnIconConfig(): {
1321
+ protected addExpandColumnIcons(): void;
1322
+ private addExpandColumnIcon;
1323
+ protected getExpandColumnIconConfig(isLastColumn: boolean): {
1249
1324
  x: number;
1250
1325
  y: number;
1251
1326
  width: number;
1252
1327
  height: number;
1253
1328
  };
1254
1329
  protected isLastColumn(): boolean;
1255
- /**
1256
- * 计算文本位置时候需要,留给后代根据情况(固定列)覆盖
1257
- * @param viewport
1258
- * @returns viewport
1259
- */
1260
- protected handleViewport(viewport: AreaRange): AreaRange;
1330
+ protected isAllDisplaySiblingNodeHidden(): HiddenColumnsInfo_2;
1261
1331
  }
1262
1332
 
1263
1333
  declare interface ColCfg {
@@ -1286,7 +1356,7 @@ declare class ColHeader extends BaseHeader<ColHeaderConfig> {
1286
1356
  clear(): void;
1287
1357
  protected getCellInstance(item: Node_2_2, spreadsheet: SpreadSheet_2, headerConfig: ColHeaderConfig): ColCell;
1288
1358
  protected getCellGroup(node: Node_2_2): IGroup;
1289
- protected isColCellInRect(item: Node_2_2): boolean;
1359
+ protected isColCellInRect(node: Node_2_2): boolean;
1290
1360
  protected layout(): void;
1291
1361
  protected offset(): void;
1292
1362
  }
@@ -1327,6 +1397,7 @@ declare interface Conditions {
1327
1397
 
1328
1398
  declare class CornerBBox extends BaseBBox {
1329
1399
  calculateBBox(): void;
1400
+ private getCornerBBoxOriginalHeight;
1330
1401
  private getCornerBBoxHeight;
1331
1402
  private getCornerBBoxWidth;
1332
1403
  private adjustCornerBBoxWidth;
@@ -1337,7 +1408,6 @@ declare class CornerCell extends HeaderCell {
1337
1408
  protected isBolderText(): boolean;
1338
1409
  cornerType: CornerNodeType;
1339
1410
  get cellType(): CellTypes;
1340
- update(): void;
1341
1411
  protected initCell(): void;
1342
1412
  /**
1343
1413
  * @deprecated 已废弃, 请使用 drawTextShape
@@ -1381,6 +1451,7 @@ declare class CornerHeader extends BaseHeader<CornerHeaderConfig> {
1381
1451
  */
1382
1452
  static getCornerHeader(panelBBox: PanelBBox, cornerBBox: CornerBBox, seriesNumberWidth: number, cfg: SpreadSheetFacetCfg, layoutResult: LayoutResult_2, s2: SpreadSheet_2): CornerHeader;
1383
1453
  static getCornerNodes(position: Point, width: number, height: number, rows: string[], columns: string[], rowsHierarchy: Hierarchy, colsHierarchy: Hierarchy, dataSet: BaseDataSet_2, seriesNumberWidth: number, s2: SpreadSheet_2): Node_2_2[];
1454
+ static getTreeCornerText(s2: SpreadSheet_2): string;
1384
1455
  constructor(cfg: CornerHeaderConfig);
1385
1456
  /**
1386
1457
  * Make cornerHeader scroll with hScrollBar
@@ -1392,6 +1463,7 @@ declare class CornerHeader extends BaseHeader<CornerHeaderConfig> {
1392
1463
  protected renderCells(): void;
1393
1464
  protected offset(): void;
1394
1465
  protected clip(): void;
1466
+ getNodes(): Node_2_2[];
1395
1467
  }
1396
1468
 
1397
1469
  declare type CornerHeaderCallback = (parent: S2CellType_2, spreadsheet: SpreadSheet_2, ...restOptions: unknown[]) => void;
@@ -1457,6 +1529,7 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
1457
1529
  protected handleHover(cells: CellMeta_2[]): void;
1458
1530
  update(): void;
1459
1531
  setMeta(viewMeta: ViewMeta_2): void;
1532
+ protected drawTextShape(): void;
1460
1533
  protected initCell(): void;
1461
1534
  /**
1462
1535
  * 获取默认字体颜色:根据字段标记背景颜色,设置字体颜色
@@ -1650,6 +1723,7 @@ declare class EventController {
1650
1723
  s2EventHandlers: S2EventHandler[];
1651
1724
  domEventListeners: EventListener_2[];
1652
1725
  isCanvasEffect: boolean;
1726
+ canvasMousemoveEvent: Event_2;
1653
1727
  constructor(spreadsheet: SpreadSheet_2);
1654
1728
  get canvasContainer(): Canvas;
1655
1729
  get isAutoResetSheetStyle(): boolean;
@@ -1658,6 +1732,7 @@ declare class EventController {
1658
1732
  private onKeyboardCopy;
1659
1733
  private onKeyboardEsc;
1660
1734
  private resetSheetStyle;
1735
+ private isMouseEvent;
1661
1736
  private isMouseOnTheCanvasContainer;
1662
1737
  private getContainerRect;
1663
1738
  private isMouseOnTheTooltip;
@@ -1807,9 +1882,18 @@ declare class GuiIcon extends Group {
1807
1882
  static type: string;
1808
1883
  iconImageShape: Shape.Image;
1809
1884
  constructor(cfg: GuiIconCfg);
1810
- private getImage;
1811
- hasSupportSuffix: (image: string) => boolean;
1885
+ getImage(name: string, cacheKey: string, fill?: string): Promise<HTMLImageElement>;
1886
+ /**
1887
+ * 1. https://xxx.svg
1888
+ * 2. http://xxx.svg
1889
+ * 3. //xxx.svg
1890
+ */
1891
+ isOnlineLink: (src: string) => boolean;
1812
1892
  private render;
1893
+ setImageAttrs(attrs: Partial<{
1894
+ name: string;
1895
+ fill: string;
1896
+ }>): void;
1813
1897
  }
1814
1898
 
1815
1899
  declare interface GuiIconCfg extends ShapeAttrs {
@@ -1820,6 +1904,7 @@ declare class HdAdapter {
1820
1904
  private viewport;
1821
1905
  private devicePixelRatioMedia;
1822
1906
  private spreadsheet;
1907
+ private isDevicePixelRatioChange;
1823
1908
  constructor(spreadsheet: SpreadSheet_2);
1824
1909
  init: () => void;
1825
1910
  destroy: () => void;
@@ -1827,6 +1912,11 @@ declare class HdAdapter {
1827
1912
  private removeDevicePixelRatioListener;
1828
1913
  private initDeviceZoomListener;
1829
1914
  private removeDeviceZoomListener;
1915
+ /**
1916
+ * DPR 改变也会触发 visualViewport 的 resize 事件, 预期是只监听双指缩放, 所以这里规避掉
1917
+ * @see https://github.com/antvis/S2/issues/2072
1918
+ */
1919
+ private renderByZoomScaleWithoutResizeEffect;
1830
1920
  private renderByDevicePixelRatioChanged;
1831
1921
  private renderByDevicePixelRatio;
1832
1922
  private renderByZoomScale;
@@ -1864,8 +1954,9 @@ declare abstract class HeaderCell extends BaseCell<Node_2_2> {
1864
1954
  protected actionIcons: GuiIcon[];
1865
1955
  protected hasDefaultHiddenIcon: boolean;
1866
1956
  protected abstract isBolderText(): boolean;
1867
- protected handleRestOptions(...[headerConfig]: [BaseHeaderConfig]): void;
1957
+ protected handleRestOptions(...[headerConfig]: [BaseHeaderConfig, unknown]): void;
1868
1958
  protected initCell(): void;
1959
+ getTreeIcon(): GuiIcon;
1869
1960
  protected getInteractiveBorderShapeStyle(border: number): {
1870
1961
  x: number;
1871
1962
  y: number;
@@ -1895,6 +1986,10 @@ declare abstract class HeaderCell extends BaseCell<Node_2_2> {
1895
1986
  backgroundColor: string;
1896
1987
  backgroundColorOpacity: number;
1897
1988
  };
1989
+ protected getBackgroundColorByCondition(backgroundColor: string, backgroundColorOpacity: number): {
1990
+ backgroundColor: string;
1991
+ backgroundColorOpacity: number;
1992
+ };
1898
1993
  toggleActionIcon(id: string): void;
1899
1994
  update(): void;
1900
1995
  updateByState(stateName: InteractionStateName): void;
@@ -1975,14 +2070,21 @@ declare interface IconTheme {
1975
2070
  margin?: Margin;
1976
2071
  }
1977
2072
 
1978
- declare type Indexes = [number, number, number, number];
2073
+ declare type Indexes = [number?, number?, number?, number?];
2074
+
2075
+ declare interface InteractionCellHighlight {
2076
+ rowHeader?: boolean;
2077
+ colHeader?: boolean;
2078
+ currentRow?: boolean;
2079
+ currentCol?: boolean;
2080
+ }
1979
2081
 
1980
2082
  declare type InteractionConstructor = new (spreadsheet: SpreadSheet_2) => BaseEvent;
1981
2083
 
1982
2084
  declare interface InteractionOptions {
1983
2085
  linkFields?: string[] | ((meta: Node_2_2 | ViewMeta_2) => boolean);
1984
2086
  selectedCellsSpotlight?: boolean;
1985
- hoverHighlight?: boolean;
2087
+ hoverHighlight?: boolean | InteractionCellHighlight;
1986
2088
  hoverFocus?: boolean | HoverFocusOptions;
1987
2089
  enableCopy?: boolean;
1988
2090
  copyWithFormat?: boolean;
@@ -1997,8 +2099,9 @@ declare interface InteractionOptions {
1997
2099
  selectedCellMove?: boolean;
1998
2100
  scrollbarPosition?: ScrollbarPositionType;
1999
2101
  eventListenerOptions?: boolean | AddEventListenerOptions;
2000
- selectedCellHighlight?: boolean;
2102
+ selectedCellHighlight?: boolean | InteractionCellHighlight;
2001
2103
  overscrollBehavior?: 'auto' | 'none' | 'contain';
2104
+ hoverAfterScroll?: boolean;
2002
2105
  /** ***********CUSTOM INTERACTION HOOKS**************** */
2003
2106
  customInteractions?: CustomInteraction[];
2004
2107
  }
@@ -2020,6 +2123,7 @@ declare interface InteractionStateInfo {
2020
2123
  declare enum InteractionStateName {
2021
2124
  ALL_SELECTED = "allSelected",
2022
2125
  SELECTED = "selected",
2126
+ BRUSH_SELECTED = "brushSelected",
2023
2127
  UNSELECTED = "unselected",
2024
2128
  HOVER = "hover",
2025
2129
  HOVER_FOCUS = "hoverFocus",
@@ -2120,7 +2224,7 @@ declare interface LineTheme {
2120
2224
 
2121
2225
  declare type MappingDataItemCallback = (valueField: string, data: DataItem) => Record<string, string | number> | DataItem;
2122
2226
 
2123
- declare type MappingFunction = (fieldValue: number | string, data: Record<string, any>) => MappingResult;
2227
+ declare type MappingFunction = (fieldValue: number | string, data: Record<string, any>) => MappingResult | null | undefined;
2124
2228
 
2125
2229
  declare interface MappingResult extends ValueRange {
2126
2230
  icon?: string;
@@ -2160,6 +2264,8 @@ declare class MergedCell extends DataCell_2 {
2160
2264
  drawTextShape(): void;
2161
2265
  }
2162
2266
 
2267
+ declare type MergedCellCallback = (spreadsheet: SpreadSheet_2, cells: S2CellType_2[], meta?: ViewMeta_2) => MergedCell;
2268
+
2163
2269
  /**
2164
2270
  * the index of rows or columns.
2165
2271
  */
@@ -2211,12 +2317,16 @@ declare interface MultiData<T = SimpleDataItem[][] | MiniChartData> {
2211
2317
  [key: string]: unknown;
2212
2318
  }
2213
2319
 
2320
+ declare interface MultiDataParams {
2321
+ drillDownFields?: string[];
2322
+ queryType?: QueryDataType;
2323
+ }
2324
+
2214
2325
  /**
2215
2326
  * Node for cornerHeader, colHeader, rowHeader
2216
2327
  */
2217
2328
  declare class Node_2_2 {
2218
2329
  isTotalMeasure: boolean;
2219
- config: BaseNodeConfig;
2220
2330
  constructor(cfg: BaseNodeConfig);
2221
2331
  /**
2222
2332
  * Get node's field path
@@ -2294,13 +2404,27 @@ declare class Node_2_2 {
2294
2404
  cornerType?: CornerNodeType;
2295
2405
  isGrandTotals?: boolean;
2296
2406
  isSubTotals?: boolean;
2407
+ isTotalRoot?: boolean;
2408
+ /**
2409
+ * @deprecated 已废弃, 该属性只记录相邻一级的隐藏信息,将会在未来版本中移除
2410
+ */
2411
+ hiddenChildNodeInfo?: HiddenColumnsInfo_2 | null;
2412
+ extra?: Record<string, any>;
2297
2413
  [key: string]: any;
2298
2414
  static rootNode(): Node_2_2;
2299
- toJSON(): Omit_2<this, "spreadsheet" | "config" | "parent" | "hierarchy">;
2415
+ toJSON(): Omit_2<this, "parent" | "hierarchy" | "spreadsheet" | "config">;
2300
2416
  getHeadLeafChild(): Node_2_2;
2417
+ /**
2418
+ * 获取树状模式下,当前节点以及其所有子节点的高度总和
2419
+ * */
2420
+ getTotalHeightForTreeHierarchy(): number;
2301
2421
  }
2302
2422
 
2303
2423
  declare interface OffsetConfig {
2424
+ rowHeaderOffsetX?: {
2425
+ value: number | undefined;
2426
+ animate?: boolean;
2427
+ };
2304
2428
  offsetX?: {
2305
2429
  value: number | undefined;
2306
2430
  animate?: boolean;
@@ -2440,7 +2564,7 @@ id: number;
2440
2564
  isCollapsed: boolean;
2441
2565
  node: Node_2;
2442
2566
  }) => void;
2443
- rowCellScroll: (position: CellScrollPosition) => void;
2567
+ rowCellScroll: (position: Required<ScrollOffset>) => void;
2444
2568
  colCellHover: (data: TargetCellInfo) => void;
2445
2569
  colCellClick: (data: TargetCellInfo) => void;
2446
2570
  colCellDoubleClick: (data: TargetCellInfo) => void;
@@ -2458,6 +2582,7 @@ dataCellMouseMove: (data: TargetCellInfo) => void;
2458
2582
  dataCellTrendIconClick: (meta: ViewMeta) => void;
2459
2583
  dataCellBrushSelection: (brushRangeDataCells: DataCell[]) => void;
2460
2584
  dataCellSelectMove: (metas: CellMeta[]) => void;
2585
+ dataCellEditEnd: (meta: ViewMeta) => void;
2461
2586
  cornerCellHover: (data: TargetCellInfo) => void;
2462
2587
  cornerCellClick: (data: TargetCellInfo) => void;
2463
2588
  cornerCellDoubleClick: (data: TargetCellInfo) => void;
@@ -2486,7 +2611,7 @@ pageCount: number;
2486
2611
  total: number;
2487
2612
  current: number;
2488
2613
  }) => void;
2489
- layoutCellScroll: (position: CellScrollPosition) => void;
2614
+ layoutCellScroll: (position: Required<ScrollOffset>) => void;
2490
2615
  layoutCollapseRows: (data: CollapsedRowsType) => void;
2491
2616
  layoutAfterCollapseRows: (data: CollapsedRowsType) => void;
2492
2617
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -2538,7 +2663,7 @@ linkFieldJump: (data: {
2538
2663
  key: string;
2539
2664
  record: Data;
2540
2665
  }) => void;
2541
- scroll: (position: CellScrollPosition) => void;
2666
+ scroll: (position: Required<ScrollOffset>) => void;
2542
2667
  layoutAfterRealDataCellRender: (options: {
2543
2668
  add: [number, number][];
2544
2669
  remove: [number, number][];
@@ -2575,7 +2700,6 @@ onSpreadsheet: PropType<(container: S2MountContainer, dataCfg: S2DataConfig, opt
2575
2700
  onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet) => void>;
2576
2701
  onMounted: PropType<(spreadsheet: SpreadSheet) => void>;
2577
2702
  }>> & {
2578
- onMounted?: (spreadsheet: SpreadSheet) => any;
2579
2703
  onSheetUpdate?: (params: S2RenderOptions) => any;
2580
2704
  onRowCellHover?: (data: TargetCellInfo) => any;
2581
2705
  onRowCellClick?: (data: TargetCellInfo) => any;
@@ -2589,7 +2713,7 @@ id: number;
2589
2713
  isCollapsed: boolean;
2590
2714
  node: Node_2;
2591
2715
  }) => any;
2592
- onRowCellScroll?: (position: CellScrollPosition) => any;
2716
+ onRowCellScroll?: (position: Required<ScrollOffset>) => any;
2593
2717
  onColCellHover?: (data: TargetCellInfo) => any;
2594
2718
  onColCellClick?: (data: TargetCellInfo) => any;
2595
2719
  onColCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -2607,6 +2731,7 @@ onDataCellMouseMove?: (data: TargetCellInfo) => any;
2607
2731
  onDataCellTrendIconClick?: (meta: ViewMeta) => any;
2608
2732
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell[]) => any;
2609
2733
  onDataCellSelectMove?: (metas: CellMeta[]) => any;
2734
+ onDataCellEditEnd?: (meta: ViewMeta) => any;
2610
2735
  onCornerCellHover?: (data: TargetCellInfo) => any;
2611
2736
  onCornerCellClick?: (data: TargetCellInfo) => any;
2612
2737
  onCornerCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -2635,7 +2760,7 @@ pageCount: number;
2635
2760
  total: number;
2636
2761
  current: number;
2637
2762
  }) => any;
2638
- onLayoutCellScroll?: (position: CellScrollPosition) => any;
2763
+ onLayoutCellScroll?: (position: Required<ScrollOffset>) => any;
2639
2764
  onLayoutCollapseRows?: (data: CollapsedRowsType) => any;
2640
2765
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType) => any;
2641
2766
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -2646,6 +2771,7 @@ hiddenColumnsDetail: HiddenColumnsInfo[];
2646
2771
  }) => any;
2647
2772
  onBeforeRender?: () => any;
2648
2773
  onAfterRender?: () => any;
2774
+ onMounted?: (spreadsheet: SpreadSheet) => any;
2649
2775
  onDestroy?: () => any;
2650
2776
  onLayoutResize?: (params: ResizeParams) => any;
2651
2777
  onLayoutResizeSeriesWidth?: (params: ResizeParams) => any;
@@ -2686,7 +2812,7 @@ onLinkFieldJump?: (data: {
2686
2812
  key: string;
2687
2813
  record: Data;
2688
2814
  }) => any;
2689
- onScroll?: (position: CellScrollPosition) => any;
2815
+ onScroll?: (position: Required<ScrollOffset>) => any;
2690
2816
  onLayoutAfterRealDataCellRender?: (options: {
2691
2817
  add: [number, number][];
2692
2818
  remove: [number, number][];
@@ -2708,7 +2834,7 @@ showPagination: boolean | {
2708
2834
  onShowSizeChange?: (pageSize: number) => void;
2709
2835
  onChange?: (current: number) => void;
2710
2836
  };
2711
- }>;
2837
+ }, {}>;
2712
2838
 
2713
2839
  declare interface PointObject {
2714
2840
  x: number;
@@ -2720,6 +2846,13 @@ declare interface PropOption<T = any> {
2720
2846
  default?: T;
2721
2847
  }
2722
2848
 
2849
+ declare type Query = Record<string, any>;
2850
+
2851
+ declare enum QueryDataType {
2852
+ All = "all",
2853
+ DetailOnly = "detailOnly"
2854
+ }
2855
+
2723
2856
  declare interface RangeColors {
2724
2857
  good: string;
2725
2858
  satisfactory: string;
@@ -2825,7 +2958,7 @@ declare class RootInteraction {
2825
2958
  isHoverState(): boolean;
2826
2959
  isActiveCell(cell: S2CellType_2): boolean;
2827
2960
  isSelectedCell(cell: S2CellType_2): boolean;
2828
- getCells(): CellMeta_2[];
2961
+ getCells(cellType?: CellTypes[]): CellMeta_2[];
2829
2962
  getActiveCells(): S2CellType_2[];
2830
2963
  clearStyleIndependent(): void;
2831
2964
  getPanelGroupAllUnSelectedDataCells(): DataCell_2[];
@@ -2856,45 +2989,30 @@ declare class RootInteraction {
2856
2989
  clearHoverTimer(): void;
2857
2990
  setHoverTimer(timer: number): void;
2858
2991
  getHoverTimer(): number;
2992
+ getSelectedCellHighlight(): InteractionCellHighlight;
2993
+ getHoverAfterScroll(): boolean;
2994
+ getHoverHighlight(): InteractionCellHighlight;
2995
+ getBrushSelection(): BrushSelection;
2859
2996
  }
2860
2997
 
2861
- declare class RowCell extends HeaderCell {
2862
- protected headerConfig: RowHeaderConfig;
2863
- protected gm: GM;
2864
- get cellType(): CellTypes;
2865
- destroy(): void;
2866
- protected initCell(): void;
2998
+ /**
2999
+ * Adapting the frozen first row for cells pivot table
3000
+ */
3001
+ declare class RowCell extends BaseRowCell {
2867
3002
  /**
2868
- * 绘制hover悬停,刷选的外框
3003
+ * To indicate whether the current node is a frozen node
3004
+ *
3005
+ * PS: It is a specific config for the cell node, so it should not be extended in the headerConfig.
2869
3006
  */
2870
- protected drawInteractiveBorderShape(): void;
2871
- protected drawInteractiveBgShape(): void;
2872
- protected showTreeIcon(): boolean;
2873
- protected showTreeLeafNodeAlignDot(): boolean;
2874
- protected getParentTreeIconCfg(): any;
2875
- protected drawTreeIcon(): void;
2876
- protected drawTreeLeafNodeAlignDot(): void;
2877
- protected isBolderText(): boolean;
2878
- protected drawTextShape(): void;
2879
- protected drawLinkFieldShape(): void;
2880
- protected drawRectBorder(): void;
2881
- protected drawResizeAreaInLeaf(): void;
2882
- protected getContentIndent(): number;
2883
- protected getTextIndent(): number;
2884
- protected isTreeLevel(): any;
2885
- protected getIconPosition(): {
2886
- x: any;
2887
- y: any;
2888
- };
2889
- protected getMaxTextWidth(): number;
2890
- protected getTextArea(): {
2891
- x: number;
2892
- width: number;
2893
- y: number;
2894
- height: number;
2895
- };
2896
- protected getTextPosition(): Point;
2897
- protected getIconYPosition(): number;
3007
+ protected frozenRowCell: boolean;
3008
+ protected handleRestOptions(...[headerConfig, ...options]: [BaseHeaderConfig, boolean]): void;
3009
+ protected getAdjustTextAreaHeight(textArea: SimpleBBox, scrollY: number, viewportHeight: number): number;
3010
+ protected calculateTextY({ textArea, adjustTextAreaHeight, }: {
3011
+ textArea: SimpleBBox;
3012
+ adjustTextAreaHeight: number;
3013
+ }): number;
3014
+ protected getResizeClipAreaBBox(): SimpleBBox;
3015
+ private getFrozenFirstRowHeight;
2898
3016
  }
2899
3017
 
2900
3018
  declare type RowCellCollapseTreeRowsType = {
@@ -2913,6 +3031,8 @@ declare interface RowCfg {
2913
3031
  treeRowsWidth?: number;
2914
3032
  }
2915
3033
 
3034
+ declare type RowData = Data_2 | DataType_2;
3035
+
2916
3036
  /**
2917
3037
  * Row Header for SpreadSheet
2918
3038
  */
@@ -2920,6 +3040,10 @@ declare class RowHeader extends BaseHeader<RowHeaderConfig> {
2920
3040
  private gm;
2921
3041
  constructor(cfg: RowHeaderConfig);
2922
3042
  destroy(): void;
3043
+ protected rowCellInRect(item: Node_2_2): boolean;
3044
+ createCellInstance(node: Node_2_2): RowCell;
3045
+ protected getCellGroup(node: Node_2_2): IGroup;
3046
+ protected getCustomRowCell(): CellCallback<RowHeaderConfig>;
2923
3047
  protected layout(): void;
2924
3048
  protected offset(): void;
2925
3049
  protected clip(): void;
@@ -2959,6 +3083,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
2959
3083
  cornerCell?: CellCallback<CornerHeaderConfig>;
2960
3084
  rowCell?: CellCallback<RowHeaderConfig>;
2961
3085
  colCell?: CellCallback<ColHeaderConfig>;
3086
+ mergedCell?: MergedCellCallback;
2962
3087
  frame?: FrameCallback;
2963
3088
  cornerHeader?: CornerHeaderCallback;
2964
3089
  /** ***********CUSTOM LIFECYCLE HOOKS**************** */
@@ -2971,7 +3096,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
2971
3096
  mappingDisplayDataItem?: MappingDataItemCallback;
2972
3097
  }
2973
3098
 
2974
- declare type S2CellType_2<T extends SimpleBBox = ViewMeta_2> = DataCell_2 | HeaderCell | ColCell | CornerCell | RowCell | MergedCell | BaseCell<T>;
3099
+ declare type S2CellType_2<T extends SimpleBBox = ViewMeta_2> = DataCell_2 | HeaderCell | ColCell | CornerCell | RowCell | BaseRowCell | MergedCell | BaseCell<T>;
2975
3100
 
2976
3101
  declare interface S2DataConfig_2 {
2977
3102
  data: Data_2[];
@@ -3093,6 +3218,7 @@ declare interface S2Options_2<T = TooltipContentType_2, P = Pagination_2, Icon =
3093
3218
  }
3094
3219
 
3095
3220
  declare interface S2PivotSheetOptions {
3221
+ frozenFirstRow?: boolean;
3096
3222
  }
3097
3223
 
3098
3224
  declare interface S2RenderOptions_2 {
@@ -3203,10 +3329,10 @@ declare interface ScrollBarTheme {
3203
3329
  lineCap?: ShapeAttrs['lineCap'];
3204
3330
  }
3205
3331
 
3206
- declare interface ScrollOffset {
3332
+ declare interface ScrollOffset_2 {
3207
3333
  scrollX?: number;
3208
3334
  scrollY?: number;
3209
- hRowScrollX?: number;
3335
+ rowHeaderScrollX?: number;
3210
3336
  }
3211
3337
 
3212
3338
  declare interface ScrollSpeedRatio {
@@ -3221,9 +3347,7 @@ declare interface SelectHeaderCellInfo {
3221
3347
  isMultiSelection?: boolean;
3222
3348
  }
3223
3349
 
3224
- declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
3225
- private backgroundShape;
3226
- private leftBorderShape;
3350
+ declare class SeriesNumberHeader extends BaseFrozenRowHeader {
3227
3351
  /**
3228
3352
  * Get seriesNumber header by config
3229
3353
  * @param viewportBBox
@@ -3232,19 +3356,18 @@ declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
3232
3356
  * @param spreadsheet
3233
3357
  * @param cornerWidth
3234
3358
  */
3235
- static getSeriesNumberHeader(viewportBBox: PanelBBox, seriesNumberWidth: number, leafNodes: Node_2_2[], spreadsheet: SpreadSheet_2, cornerWidth: number): SeriesNumberHeader;
3236
- constructor(cfg: BaseHeaderConfig);
3237
- clip(): void;
3238
- layout(): void;
3239
- protected offset(): void;
3240
- private addBackGround;
3241
- private addBorder;
3242
- private getStyle;
3243
- private addText;
3244
- private getTextPadding;
3359
+ static getSeriesNumberHeader({ viewportBBox, seriesNumberWidth, leafNodes, spreadsheet, cornerWidth, }: {
3360
+ viewportBBox: PanelBBox;
3361
+ seriesNumberWidth: number;
3362
+ leafNodes: Node_2_2[];
3363
+ spreadsheet: SpreadSheet_2;
3364
+ cornerWidth: number;
3365
+ }): SeriesNumberHeader;
3366
+ createCellInstance(node: Node_2_2): RowCell;
3367
+ protected getCustomRowCell(): any;
3245
3368
  }
3246
3369
 
3247
- export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "onMounted" | "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
3370
+ export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "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">, {
3248
3371
  s2Ref: ShallowRef<SheetExpose>;
3249
3372
  sheetType: ComputedRef<DefineComponent< {
3250
3373
  sheetType: PropType<SheetType>;
@@ -3293,7 +3416,7 @@ id: number;
3293
3416
  isCollapsed: boolean;
3294
3417
  node: Node_2_2;
3295
3418
  }) => void;
3296
- rowCellScroll: (position: CellScrollPosition_2) => void;
3419
+ rowCellScroll: (position: Required<ScrollOffset_2>) => void;
3297
3420
  colCellHover: (data: TargetCellInfo_2) => void;
3298
3421
  colCellClick: (data: TargetCellInfo_2) => void;
3299
3422
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3311,6 +3434,7 @@ dataCellMouseMove: (data: TargetCellInfo_2) => void;
3311
3434
  dataCellTrendIconClick: (meta: ViewMeta_2) => void;
3312
3435
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
3313
3436
  dataCellSelectMove: (metas: CellMeta_2[]) => void;
3437
+ dataCellEditEnd: (meta: ViewMeta_2) => void;
3314
3438
  cornerCellHover: (data: TargetCellInfo_2) => void;
3315
3439
  cornerCellClick: (data: TargetCellInfo_2) => void;
3316
3440
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3339,7 +3463,7 @@ pageCount: number;
3339
3463
  total: number;
3340
3464
  current: number;
3341
3465
  }) => void;
3342
- layoutCellScroll: (position: CellScrollPosition_2) => void;
3466
+ layoutCellScroll: (position: Required<ScrollOffset_2>) => void;
3343
3467
  layoutCollapseRows: (data: CollapsedRowsType_2) => void;
3344
3468
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
3345
3469
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -3391,7 +3515,7 @@ linkFieldJump: (data: {
3391
3515
  key: string;
3392
3516
  record: Data_2;
3393
3517
  }) => void;
3394
- scroll: (position: CellScrollPosition_2) => void;
3518
+ scroll: (position: Required<ScrollOffset_2>) => void;
3395
3519
  layoutAfterRealDataCellRender: (options: {
3396
3520
  add: [number, number][];
3397
3521
  remove: [number, number][];
@@ -3428,7 +3552,6 @@ onSpreadsheet: PropType<(container: S2MountContainer_2, dataCfg: S2DataConfig_2,
3428
3552
  onGetSpreadSheet: PropType<(spreadsheet: SpreadSheet_2) => void>;
3429
3553
  onMounted: PropType<(spreadsheet: SpreadSheet_2) => void>;
3430
3554
  }>> & {
3431
- onMounted?: (spreadsheet: SpreadSheet_2) => any;
3432
3555
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
3433
3556
  onRowCellHover?: (data: TargetCellInfo_2) => any;
3434
3557
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -3442,7 +3565,7 @@ id: number;
3442
3565
  isCollapsed: boolean;
3443
3566
  node: Node_2_2;
3444
3567
  }) => any;
3445
- onRowCellScroll?: (position: CellScrollPosition_2) => any;
3568
+ onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
3446
3569
  onColCellHover?: (data: TargetCellInfo_2) => any;
3447
3570
  onColCellClick?: (data: TargetCellInfo_2) => any;
3448
3571
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3460,6 +3583,7 @@ onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
3460
3583
  onDataCellTrendIconClick?: (meta: ViewMeta_2) => any;
3461
3584
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
3462
3585
  onDataCellSelectMove?: (metas: CellMeta_2[]) => any;
3586
+ onDataCellEditEnd?: (meta: ViewMeta_2) => any;
3463
3587
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
3464
3588
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
3465
3589
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3488,7 +3612,7 @@ pageCount: number;
3488
3612
  total: number;
3489
3613
  current: number;
3490
3614
  }) => any;
3491
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
3615
+ onLayoutCellScroll?: (position: Required<ScrollOffset_2>) => any;
3492
3616
  onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
3493
3617
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
3494
3618
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -3499,6 +3623,7 @@ hiddenColumnsDetail: HiddenColumnsInfo_2[];
3499
3623
  }) => any;
3500
3624
  onBeforeRender?: () => any;
3501
3625
  onAfterRender?: () => any;
3626
+ onMounted?: (spreadsheet: SpreadSheet_2) => any;
3502
3627
  onDestroy?: () => any;
3503
3628
  onLayoutResize?: (params: ResizeParams_2) => any;
3504
3629
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -3539,7 +3664,7 @@ onLinkFieldJump?: (data: {
3539
3664
  key: string;
3540
3665
  record: Data_2;
3541
3666
  }) => any;
3542
- onScroll?: (position: CellScrollPosition_2) => any;
3667
+ onScroll?: (position: Required<ScrollOffset_2>) => any;
3543
3668
  onLayoutAfterRealDataCellRender?: (options: {
3544
3669
  add: [number, number][];
3545
3670
  remove: [number, number][];
@@ -3561,7 +3686,7 @@ showPagination: boolean | {
3561
3686
  onShowSizeChange?: (pageSize: number) => void;
3562
3687
  onChange?: (current: number) => void;
3563
3688
  };
3564
- }> | DefineComponent<GetInitProps<SheetComponentProps, "onMounted" | "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
3689
+ }, {}> | DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "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">, {
3565
3690
  s2Ref: ShallowRef<SheetExpose>;
3566
3691
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3567
3692
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
@@ -3579,7 +3704,7 @@ id: number;
3579
3704
  isCollapsed: boolean;
3580
3705
  node: Node_2_2;
3581
3706
  }) => void;
3582
- rowCellScroll: (position: CellScrollPosition_2) => void;
3707
+ rowCellScroll: (position: Required<ScrollOffset_2>) => void;
3583
3708
  colCellHover: (data: TargetCellInfo_2) => void;
3584
3709
  colCellClick: (data: TargetCellInfo_2) => void;
3585
3710
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3597,6 +3722,7 @@ dataCellMouseMove: (data: TargetCellInfo_2) => void;
3597
3722
  dataCellTrendIconClick: (meta: ViewMeta_2) => void;
3598
3723
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
3599
3724
  dataCellSelectMove: (metas: CellMeta_2[]) => void;
3725
+ dataCellEditEnd: (meta: ViewMeta_2) => void;
3600
3726
  cornerCellHover: (data: TargetCellInfo_2) => void;
3601
3727
  cornerCellClick: (data: TargetCellInfo_2) => void;
3602
3728
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3625,7 +3751,7 @@ pageCount: number;
3625
3751
  total: number;
3626
3752
  current: number;
3627
3753
  }) => void;
3628
- layoutCellScroll: (position: CellScrollPosition_2) => void;
3754
+ layoutCellScroll: (position: Required<ScrollOffset_2>) => void;
3629
3755
  layoutCollapseRows: (data: CollapsedRowsType_2) => void;
3630
3756
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
3631
3757
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -3677,7 +3803,7 @@ linkFieldJump: (data: {
3677
3803
  key: string;
3678
3804
  record: Data_2;
3679
3805
  }) => void;
3680
- scroll: (position: CellScrollPosition_2) => void;
3806
+ scroll: (position: Required<ScrollOffset_2>) => void;
3681
3807
  layoutAfterRealDataCellRender: (options: {
3682
3808
  add: [number, number][];
3683
3809
  remove: [number, number][];
@@ -3685,8 +3811,7 @@ spreadsheet: SpreadSheet_2;
3685
3811
  }) => void;
3686
3812
  rowCellBrushSelection: (event: default_2) => void;
3687
3813
  colCellBrushSelection: (event: default_2) => void;
3688
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "onMounted" | "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
3689
- onMounted?: (spreadsheet: SpreadSheet_2) => any;
3814
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "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">>> & {
3690
3815
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
3691
3816
  onRowCellHover?: (data: TargetCellInfo_2) => any;
3692
3817
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -3700,7 +3825,7 @@ id: number;
3700
3825
  isCollapsed: boolean;
3701
3826
  node: Node_2_2;
3702
3827
  }) => any;
3703
- onRowCellScroll?: (position: CellScrollPosition_2) => any;
3828
+ onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
3704
3829
  onColCellHover?: (data: TargetCellInfo_2) => any;
3705
3830
  onColCellClick?: (data: TargetCellInfo_2) => any;
3706
3831
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3718,6 +3843,7 @@ onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
3718
3843
  onDataCellTrendIconClick?: (meta: ViewMeta_2) => any;
3719
3844
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
3720
3845
  onDataCellSelectMove?: (metas: CellMeta_2[]) => any;
3846
+ onDataCellEditEnd?: (meta: ViewMeta_2) => any;
3721
3847
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
3722
3848
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
3723
3849
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3746,7 +3872,7 @@ pageCount: number;
3746
3872
  total: number;
3747
3873
  current: number;
3748
3874
  }) => any;
3749
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
3875
+ onLayoutCellScroll?: (position: Required<ScrollOffset_2>) => any;
3750
3876
  onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
3751
3877
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
3752
3878
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -3757,6 +3883,7 @@ hiddenColumnsDetail: HiddenColumnsInfo_2[];
3757
3883
  }) => any;
3758
3884
  onBeforeRender?: () => any;
3759
3885
  onAfterRender?: () => any;
3886
+ onMounted?: (spreadsheet: SpreadSheet_2) => any;
3760
3887
  onDestroy?: () => any;
3761
3888
  onLayoutResize?: (params: ResizeParams_2) => any;
3762
3889
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -3797,7 +3924,7 @@ onLinkFieldJump?: (data: {
3797
3924
  key: string;
3798
3925
  record: Data_2;
3799
3926
  }) => any;
3800
- onScroll?: (position: CellScrollPosition_2) => any;
3927
+ onScroll?: (position: Required<ScrollOffset_2>) => any;
3801
3928
  onLayoutAfterRealDataCellRender?: (options: {
3802
3929
  add: [number, number][];
3803
3930
  remove: [number, number][];
@@ -3807,7 +3934,7 @@ onRowCellBrushSelection?: (event: default_2) => any;
3807
3934
  onColCellBrushSelection?: (event: default_2) => any;
3808
3935
  onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
3809
3936
  onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
3810
- }, {}>>;
3937
+ }, {}, {}>>;
3811
3938
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3812
3939
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
3813
3940
  getSpreadSheet: (spreadsheet: SpreadSheet_2) => void;
@@ -3824,7 +3951,7 @@ id: number;
3824
3951
  isCollapsed: boolean;
3825
3952
  node: Node_2_2;
3826
3953
  }) => void;
3827
- rowCellScroll: (position: CellScrollPosition_2) => void;
3954
+ rowCellScroll: (position: Required<ScrollOffset_2>) => void;
3828
3955
  colCellHover: (data: TargetCellInfo_2) => void;
3829
3956
  colCellClick: (data: TargetCellInfo_2) => void;
3830
3957
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3842,6 +3969,7 @@ dataCellMouseMove: (data: TargetCellInfo_2) => void;
3842
3969
  dataCellTrendIconClick: (meta: ViewMeta_2) => void;
3843
3970
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
3844
3971
  dataCellSelectMove: (metas: CellMeta_2[]) => void;
3972
+ dataCellEditEnd: (meta: ViewMeta_2) => void;
3845
3973
  cornerCellHover: (data: TargetCellInfo_2) => void;
3846
3974
  cornerCellClick: (data: TargetCellInfo_2) => void;
3847
3975
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3870,7 +3998,7 @@ pageCount: number;
3870
3998
  total: number;
3871
3999
  current: number;
3872
4000
  }) => void;
3873
- layoutCellScroll: (position: CellScrollPosition_2) => void;
4001
+ layoutCellScroll: (position: Required<ScrollOffset_2>) => void;
3874
4002
  layoutCollapseRows: (data: CollapsedRowsType_2) => void;
3875
4003
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
3876
4004
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -3922,7 +4050,7 @@ linkFieldJump: (data: {
3922
4050
  key: string;
3923
4051
  record: Data_2;
3924
4052
  }) => void;
3925
- scroll: (position: CellScrollPosition_2) => void;
4053
+ scroll: (position: Required<ScrollOffset_2>) => void;
3926
4054
  layoutAfterRealDataCellRender: (options: {
3927
4055
  add: [number, number][];
3928
4056
  remove: [number, number][];
@@ -3930,8 +4058,7 @@ spreadsheet: SpreadSheet_2;
3930
4058
  }) => void;
3931
4059
  rowCellBrushSelection: (event: default_2) => void;
3932
4060
  colCellBrushSelection: (event: default_2) => void;
3933
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "onMounted" | "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
3934
- onMounted?: (spreadsheet: SpreadSheet_2) => any;
4061
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "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">>> & {
3935
4062
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
3936
4063
  onRowCellHover?: (data: TargetCellInfo_2) => any;
3937
4064
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -3945,7 +4072,7 @@ id: number;
3945
4072
  isCollapsed: boolean;
3946
4073
  node: Node_2_2;
3947
4074
  }) => any;
3948
- onRowCellScroll?: (position: CellScrollPosition_2) => any;
4075
+ onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
3949
4076
  onColCellHover?: (data: TargetCellInfo_2) => any;
3950
4077
  onColCellClick?: (data: TargetCellInfo_2) => any;
3951
4078
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3963,6 +4090,7 @@ onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
3963
4090
  onDataCellTrendIconClick?: (meta: ViewMeta_2) => any;
3964
4091
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
3965
4092
  onDataCellSelectMove?: (metas: CellMeta_2[]) => any;
4093
+ onDataCellEditEnd?: (meta: ViewMeta_2) => any;
3966
4094
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
3967
4095
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
3968
4096
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3991,7 +4119,7 @@ pageCount: number;
3991
4119
  total: number;
3992
4120
  current: number;
3993
4121
  }) => any;
3994
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
4122
+ onLayoutCellScroll?: (position: Required<ScrollOffset_2>) => any;
3995
4123
  onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
3996
4124
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
3997
4125
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -4002,6 +4130,7 @@ hiddenColumnsDetail: HiddenColumnsInfo_2[];
4002
4130
  }) => any;
4003
4131
  onBeforeRender?: () => any;
4004
4132
  onAfterRender?: () => any;
4133
+ onMounted?: (spreadsheet: SpreadSheet_2) => any;
4005
4134
  onDestroy?: () => any;
4006
4135
  onLayoutResize?: (params: ResizeParams_2) => any;
4007
4136
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -4042,7 +4171,7 @@ onLinkFieldJump?: (data: {
4042
4171
  key: string;
4043
4172
  record: Data_2;
4044
4173
  }) => any;
4045
- onScroll?: (position: CellScrollPosition_2) => any;
4174
+ onScroll?: (position: Required<ScrollOffset_2>) => any;
4046
4175
  onLayoutAfterRealDataCellRender?: (options: {
4047
4176
  add: [number, number][];
4048
4177
  remove: [number, number][];
@@ -4052,7 +4181,7 @@ onRowCellBrushSelection?: (event: default_2) => any;
4052
4181
  onColCellBrushSelection?: (event: default_2) => any;
4053
4182
  onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
4054
4183
  onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
4055
- }, {}>;
4184
+ }, {}, {}>;
4056
4185
 
4057
4186
  declare type SheetComponentOptions = S2Options<TooltipContentType, Pagination & PaginationProps>;
4058
4187
 
@@ -4067,6 +4196,18 @@ declare type SheetType = 'pivot' | 'table' | 'gridAnalysis' | 'strategy' | 'edit
4067
4196
  /** render callback */
4068
4197
  declare type SheetUpdateCallback = (params: S2RenderOptions) => S2RenderOptions;
4069
4198
 
4199
+ declare type ShowPagination<OverrideShowPagination, Options> = OverrideShowPagination extends true ? Options extends {
4200
+ pagination?: {
4201
+ onShowSizeChange?: unknown;
4202
+ onChange?: unknown;
4203
+ };
4204
+ } ? boolean | Pick<Options['pagination'], 'onShowSizeChange' | 'onChange'> : _ShowPagination : _ShowPagination;
4205
+
4206
+ declare type _ShowPagination = boolean | {
4207
+ onShowSizeChange?: (pageSize: number) => void;
4208
+ onChange?: (current: number) => void;
4209
+ };
4210
+
4070
4211
  declare type SimpleDataItem = string | number;
4071
4212
 
4072
4213
  declare interface Sort {
@@ -4111,6 +4252,8 @@ declare interface SplitLine {
4111
4252
  left: string;
4112
4253
  right: string;
4113
4254
  };
4255
+ /** 分割线虚线 */
4256
+ borderDash?: number[];
4114
4257
  }
4115
4258
 
4116
4259
  declare abstract class SpreadSheet_2 extends EE {
@@ -4191,7 +4334,7 @@ declare abstract class SpreadSheet_2 extends EE {
4191
4334
  abstract clearDrillDownData(rowNodeId?: string, preventRender?: boolean): void;
4192
4335
  abstract handleGroupSort(event: Event_2, meta: Node_2_2): void;
4193
4336
  showTooltip<T = TooltipContentType_2>(showOptions: TooltipShowOptions<T>): void;
4194
- showTooltipWithInfo(event: Event_2 | MouseEvent, data: TooltipData[], options?: TooltipOptions): void;
4337
+ showTooltipWithInfo(event: Event_2 | MouseEvent, cellInfos: TooltipData[], options?: TooltipOptions): void;
4195
4338
  hideTooltip(): void;
4196
4339
  destroyTooltip(): void;
4197
4340
  registerIcons(): void;
@@ -4200,10 +4343,17 @@ declare abstract class SpreadSheet_2 extends EE {
4200
4343
  * Group sort params kept in {@see store} and
4201
4344
  * Priority: group sort > advanced sort
4202
4345
  * @param dataCfg
4203
- * @param reset reset: true, 直接使用用户传入的 DataCfg ,不再与上次数据进行合并
4346
+ * @param reset 是否使用传入的 dataCfg 重置已保存的 dataCfg
4347
+ *
4348
+ * @example setDataCfg(dataCfg, true) 直接使用传入的 DataCfg,不再与上次数据进行合并
4204
4349
  */
4205
- setDataCfg(dataCfg: S2DataConfig_2, reset?: boolean): void;
4350
+ setDataCfg<T extends boolean = false>(dataCfg: T extends true ? S2DataConfig_2 : Partial<S2DataConfig_2>, reset?: T): void;
4206
4351
  setOptions(options: Partial<S2Options_2>, reset?: boolean): void;
4352
+ /**
4353
+ * 配置都是 merge 操作, 但是隐藏列配置比较特殊, 变更时, 应该是全量覆盖, 而不应该是合并
4354
+ * https://github.com/antvis/S2/issues/2495
4355
+ */
4356
+ private resetHiddenColumnsDetailInfoIfNeeded;
4207
4357
  render(reloadData?: boolean, options?: S2RenderOptions_2): void;
4208
4358
  destroy(): void;
4209
4359
  setThemeCfg(themeCfg?: ThemeCfg_2): void;
@@ -4251,6 +4401,7 @@ declare abstract class SpreadSheet_2 extends EE {
4251
4401
  */
4252
4402
  updateScrollOffset(offsetConfig: OffsetConfig): void;
4253
4403
  getTooltipDataItemMappingCallback(): MappingDataItemCallback;
4404
+ protected isCellType(cell?: Event_2['target']): boolean;
4254
4405
  getCell<T extends S2CellType_2 = S2CellType_2>(target: Event_2['target']): T;
4255
4406
  getCellType(target: Event_2['target']): CellTypes;
4256
4407
  /**
@@ -4271,7 +4422,11 @@ declare abstract class SpreadSheet_2 extends EE {
4271
4422
  protected updateContainerStyle(): void;
4272
4423
  protected initPanelGroupChildren(): void;
4273
4424
  getInitColumnLeafNodes(): Node_2_2[];
4425
+ /**
4426
+ * @deprecated 已废弃, 请使用 clearInitColumnLeafNodes
4427
+ */
4274
4428
  clearColumnLeafNodes(): void;
4429
+ clearInitColumnLeafNodes(): void;
4275
4430
  private initHiddenColumnsDetail;
4276
4431
  private clearCanvasEvent;
4277
4432
  /**
@@ -4335,14 +4490,14 @@ declare class Store {
4335
4490
  declare interface StoreKey {
4336
4491
  scrollX: number;
4337
4492
  scrollY: number;
4338
- hRowScrollX: number;
4493
+ rowHeaderScrollX: number;
4339
4494
  sortParam: SortParam;
4340
4495
  drillDownIdPathMap: Map<string, number[][]>;
4341
4496
  drillDownNode: Node_2_2;
4342
4497
  drillItemsNum: number;
4343
4498
  drillDownFieldInLevel: PartDrillDownFieldInLevel[];
4344
4499
  interactionStateInfo: InteractionStateInfo;
4345
- originalDataCfg: S2DataConfig_2;
4500
+ originalDataCfg: Partial<S2DataConfig_2>;
4346
4501
  panelBBox: BBox;
4347
4502
  activeResizeArea: Group;
4348
4503
  valueRanges: ValueRanges;
@@ -4375,7 +4530,7 @@ declare interface Style {
4375
4530
  device?: 'pc' | 'mobile';
4376
4531
  }
4377
4532
 
4378
- export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "onMounted" | "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
4533
+ export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "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">, {
4379
4534
  s2Ref: ShallowRef<SheetExpose>;
4380
4535
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
4381
4536
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
@@ -4393,7 +4548,7 @@ id: number;
4393
4548
  isCollapsed: boolean;
4394
4549
  node: Node_2_2;
4395
4550
  }) => void;
4396
- rowCellScroll: (position: CellScrollPosition_2) => void;
4551
+ rowCellScroll: (position: Required<ScrollOffset_2>) => void;
4397
4552
  colCellHover: (data: TargetCellInfo_2) => void;
4398
4553
  colCellClick: (data: TargetCellInfo_2) => void;
4399
4554
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4411,6 +4566,7 @@ dataCellMouseMove: (data: TargetCellInfo_2) => void;
4411
4566
  dataCellTrendIconClick: (meta: ViewMeta_2) => void;
4412
4567
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
4413
4568
  dataCellSelectMove: (metas: CellMeta_2[]) => void;
4569
+ dataCellEditEnd: (meta: ViewMeta_2) => void;
4414
4570
  cornerCellHover: (data: TargetCellInfo_2) => void;
4415
4571
  cornerCellClick: (data: TargetCellInfo_2) => void;
4416
4572
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4439,7 +4595,7 @@ pageCount: number;
4439
4595
  total: number;
4440
4596
  current: number;
4441
4597
  }) => void;
4442
- layoutCellScroll: (position: CellScrollPosition_2) => void;
4598
+ layoutCellScroll: (position: Required<ScrollOffset_2>) => void;
4443
4599
  layoutCollapseRows: (data: CollapsedRowsType_2) => void;
4444
4600
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
4445
4601
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -4491,7 +4647,7 @@ linkFieldJump: (data: {
4491
4647
  key: string;
4492
4648
  record: Data_2;
4493
4649
  }) => void;
4494
- scroll: (position: CellScrollPosition_2) => void;
4650
+ scroll: (position: Required<ScrollOffset_2>) => void;
4495
4651
  layoutAfterRealDataCellRender: (options: {
4496
4652
  add: [number, number][];
4497
4653
  remove: [number, number][];
@@ -4499,8 +4655,7 @@ spreadsheet: SpreadSheet_2;
4499
4655
  }) => void;
4500
4656
  rowCellBrushSelection: (event: default_2) => void;
4501
4657
  colCellBrushSelection: (event: default_2) => void;
4502
- }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "onMounted" | "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
4503
- onMounted?: (spreadsheet: SpreadSheet_2) => any;
4658
+ }, string, VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "getSpreadSheet" | "onSheetUpdate" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapseTreeRows" | "onRowCellScroll" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellTrendIconClick" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellScroll" | "onLayoutCollapseRows" | "onLayoutAfterCollapseRows" | "onCollapseRowsAll" | "onLayoutColsExpanded" | "onLayoutColsHidden" | "onBeforeRender" | "onAfterRender" | "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">>> & {
4504
4659
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
4505
4660
  onRowCellHover?: (data: TargetCellInfo_2) => any;
4506
4661
  onRowCellClick?: (data: TargetCellInfo_2) => any;
@@ -4514,7 +4669,7 @@ id: number;
4514
4669
  isCollapsed: boolean;
4515
4670
  node: Node_2_2;
4516
4671
  }) => any;
4517
- onRowCellScroll?: (position: CellScrollPosition_2) => any;
4672
+ onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
4518
4673
  onColCellHover?: (data: TargetCellInfo_2) => any;
4519
4674
  onColCellClick?: (data: TargetCellInfo_2) => any;
4520
4675
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4532,6 +4687,7 @@ onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
4532
4687
  onDataCellTrendIconClick?: (meta: ViewMeta_2) => any;
4533
4688
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
4534
4689
  onDataCellSelectMove?: (metas: CellMeta_2[]) => any;
4690
+ onDataCellEditEnd?: (meta: ViewMeta_2) => any;
4535
4691
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
4536
4692
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
4537
4693
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4560,7 +4716,7 @@ pageCount: number;
4560
4716
  total: number;
4561
4717
  current: number;
4562
4718
  }) => any;
4563
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
4719
+ onLayoutCellScroll?: (position: Required<ScrollOffset_2>) => any;
4564
4720
  onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
4565
4721
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
4566
4722
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -4571,6 +4727,7 @@ hiddenColumnsDetail: HiddenColumnsInfo_2[];
4571
4727
  }) => any;
4572
4728
  onBeforeRender?: () => any;
4573
4729
  onAfterRender?: () => any;
4730
+ onMounted?: (spreadsheet: SpreadSheet_2) => any;
4574
4731
  onDestroy?: () => any;
4575
4732
  onLayoutResize?: (params: ResizeParams_2) => any;
4576
4733
  onLayoutResizeSeriesWidth?: (params: ResizeParams_2) => any;
@@ -4611,7 +4768,7 @@ onLinkFieldJump?: (data: {
4611
4768
  key: string;
4612
4769
  record: Data_2;
4613
4770
  }) => any;
4614
- onScroll?: (position: CellScrollPosition_2) => any;
4771
+ onScroll?: (position: Required<ScrollOffset_2>) => any;
4615
4772
  onLayoutAfterRealDataCellRender?: (options: {
4616
4773
  add: [number, number][];
4617
4774
  remove: [number, number][];
@@ -4621,7 +4778,7 @@ onRowCellBrushSelection?: (event: default_2) => any;
4621
4778
  onColCellBrushSelection?: (event: default_2) => any;
4622
4779
  onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => any;
4623
4780
  onGetSpreadSheet?: (spreadsheet: SpreadSheet_2) => any;
4624
- }, {}>;
4781
+ }, {}, {}>;
4625
4782
 
4626
4783
  declare interface TargetCellInfo_2 {
4627
4784
  target: S2CellType_2;
@@ -4638,7 +4795,7 @@ declare interface TextAlignCfg {
4638
4795
 
4639
4796
  declare type TextBaseline = 'top' | 'middle' | 'bottom';
4640
4797
 
4641
- declare interface TextTheme extends TextAlignCfg {
4798
+ declare interface TextTheme extends TextAlignCfg, Pick<ShapeAttrs, 'fontStyle' | 'fontVariant'> {
4642
4799
  fontFamily?: string;
4643
4800
  fontSize?: number;
4644
4801
  fontWeight?: number | 'normal' | 'bold' | 'bolder' | 'lighter';
@@ -4730,6 +4887,7 @@ declare interface TooltipOptions<Icon = Element | string, Text = string> {
4730
4887
  onlyMenu?: boolean;
4731
4888
  enableFormat?: boolean;
4732
4889
  forceRender?: boolean;
4890
+ data?: TooltipData;
4733
4891
  }
4734
4892
 
4735
4893
  declare interface TooltipPosition {
@@ -4752,11 +4910,14 @@ declare type TooltipShowOptions<T = TooltipContentType_2, Icon = Element | strin
4752
4910
  };
4753
4911
 
4754
4912
  declare interface TooltipSummaryOptions {
4755
- name: string;
4756
- value: number | string;
4913
+ name: string | null;
4757
4914
  selectedData: TooltipDataItem[];
4915
+ value: TooltipSummaryOptionsValue;
4916
+ originValue?: TooltipSummaryOptionsValue;
4758
4917
  }
4759
4918
 
4919
+ declare type TooltipSummaryOptionsValue = number | string | undefined | null;
4920
+
4760
4921
  declare interface Total {
4761
4922
  /** 是否显示总计 */
4762
4923
  showGrandTotals: boolean;
@@ -4775,6 +4936,10 @@ declare interface Total {
4775
4936
  reverseSubLayout: boolean;
4776
4937
  label?: string;
4777
4938
  subLabel?: string;
4939
+ /** 总计分组维度 */
4940
+ totalsGroupDimensions?: string[];
4941
+ /** 小计分组维度 */
4942
+ subTotalsGroupDimensions?: string[];
4778
4943
  }
4779
4944
 
4780
4945
  /**
@@ -4787,6 +4952,13 @@ declare interface Totals {
4787
4952
  col?: Partial<Total>;
4788
4953
  }
4789
4954
 
4955
+ declare interface TotalStatus {
4956
+ isRowTotal: boolean;
4957
+ isRowSubTotal: boolean;
4958
+ isColTotal: boolean;
4959
+ isColSubTotal: boolean;
4960
+ }
4961
+
4790
4962
  export declare const useExpose: (expose: (exposed?: Record<string, any>) => void) => ShallowRef<SheetExpose>;
4791
4963
 
4792
4964
  declare interface ValueRange {
@@ -4796,6 +4968,8 @@ declare interface ValueRange {
4796
4968
 
4797
4969
  declare type ValueRanges = Record<string, ValueRange>;
4798
4970
 
4971
+ export declare const version = "@antv/s2-vue-v1.6.1";
4972
+
4799
4973
  declare interface ViewCellHeights {
4800
4974
  getCellOffsetY: (index: number) => number;
4801
4975
  getTotalHeight: () => number;
@@ -4819,15 +4993,15 @@ declare interface ViewMeta_2 {
4819
4993
  valueField: string;
4820
4994
  fieldValue: DataItem;
4821
4995
  isTotals?: boolean;
4822
- rowQuery?: Record<string, any>;
4823
- colQuery?: Record<string, any>;
4996
+ rowQuery?: Query;
4997
+ colQuery?: Query;
4824
4998
  rowId?: string;
4825
4999
  colId?: string;
4826
5000
  field?: string;
4827
5001
  isFrozenCorner?: boolean;
4828
5002
  label?: string;
4829
5003
  value?: string | number;
4830
- query?: Record<string, any>;
5004
+ query?: Query;
4831
5005
  [key: string]: unknown;
4832
5006
  }
4833
5007