@antv/s2-vue 1.5.0 → 1.6.0

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';
@@ -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,6 +345,7 @@ declare abstract class BaseFacet {
336
345
  centerFrame: Frame;
337
346
  gridInfo: GridInfo;
338
347
  protected abstract doLayout(): LayoutResult_2;
348
+ abstract getContentHeight(): number;
339
349
  abstract getViewCellHeights(layoutResult: LayoutResult_2): ViewCellHeights;
340
350
  protected scrollFrameId: ReturnType<typeof requestAnimationFrame>;
341
351
  get scrollBarTheme(): ScrollBarTheme;
@@ -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][];
@@ -798,7 +872,7 @@ id: number;
798
872
  isCollapsed: boolean;
799
873
  node: Node_2;
800
874
  }) => any;
801
- onRowCellScroll?: (position: CellScrollPosition) => any;
875
+ onRowCellScroll?: (position: Required<ScrollOffset>) => any;
802
876
  onColCellHover?: (data: TargetCellInfo) => any;
803
877
  onColCellClick?: (data: TargetCellInfo) => any;
804
878
  onColCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -816,6 +890,7 @@ onDataCellMouseMove?: (data: TargetCellInfo) => any;
816
890
  onDataCellTrendIconClick?: (meta: ViewMeta) => any;
817
891
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell[]) => any;
818
892
  onDataCellSelectMove?: (metas: CellMeta[]) => any;
893
+ onDataCellEditEnd?: (meta: ViewMeta) => any;
819
894
  onCornerCellHover?: (data: TargetCellInfo) => any;
820
895
  onCornerCellClick?: (data: TargetCellInfo) => any;
821
896
  onCornerCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -844,7 +919,7 @@ pageCount: number;
844
919
  total: number;
845
920
  current: number;
846
921
  }) => any;
847
- onLayoutCellScroll?: (position: CellScrollPosition) => any;
922
+ onLayoutCellScroll?: (position: Required<ScrollOffset>) => any;
848
923
  onLayoutCollapseRows?: (data: CollapsedRowsType) => any;
849
924
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType) => any;
850
925
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => 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][];
@@ -919,7 +994,7 @@ 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
- linkFields?: string[];
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;
@@ -2131,6 +2235,11 @@ declare interface MappingResult extends ValueRange {
2131
2235
  * @version 1.34.0
2132
2236
  */
2133
2237
  intelligentReverseTextColor?: boolean;
2238
+ /**
2239
+ * @description custom the interval condition's width
2240
+ * @version 1.38.0
2241
+ */
2242
+ fieldValue?: number;
2134
2243
  }
2135
2244
 
2136
2245
  declare type Margin = Padding;
@@ -2155,6 +2264,8 @@ declare class MergedCell extends DataCell_2 {
2155
2264
  drawTextShape(): void;
2156
2265
  }
2157
2266
 
2267
+ declare type MergedCellCallback = (spreadsheet: SpreadSheet_2, cells: S2CellType_2[], meta?: ViewMeta_2) => MergedCell;
2268
+
2158
2269
  /**
2159
2270
  * the index of rows or columns.
2160
2271
  */
@@ -2206,12 +2317,16 @@ declare interface MultiData<T = SimpleDataItem[][] | MiniChartData> {
2206
2317
  [key: string]: unknown;
2207
2318
  }
2208
2319
 
2320
+ declare interface MultiDataParams {
2321
+ drillDownFields?: string[];
2322
+ queryType?: QueryDataType;
2323
+ }
2324
+
2209
2325
  /**
2210
2326
  * Node for cornerHeader, colHeader, rowHeader
2211
2327
  */
2212
2328
  declare class Node_2_2 {
2213
2329
  isTotalMeasure: boolean;
2214
- config: BaseNodeConfig;
2215
2330
  constructor(cfg: BaseNodeConfig);
2216
2331
  /**
2217
2332
  * Get node's field path
@@ -2289,13 +2404,27 @@ declare class Node_2_2 {
2289
2404
  cornerType?: CornerNodeType;
2290
2405
  isGrandTotals?: boolean;
2291
2406
  isSubTotals?: boolean;
2407
+ isTotalRoot?: boolean;
2408
+ /**
2409
+ * @deprecated 已废弃, 该属性只记录相邻一级的隐藏信息,将会在未来版本中移除
2410
+ */
2411
+ hiddenChildNodeInfo?: HiddenColumnsInfo_2 | null;
2412
+ extra?: Record<string, any>;
2292
2413
  [key: string]: any;
2293
2414
  static rootNode(): Node_2_2;
2294
- toJSON(): Omit_2<this, "spreadsheet" | "config" | "parent" | "hierarchy">;
2415
+ toJSON(): Omit_2<this, "parent" | "hierarchy" | "spreadsheet" | "config">;
2295
2416
  getHeadLeafChild(): Node_2_2;
2417
+ /**
2418
+ * 获取树状模式下,当前节点以及其所有子节点的高度总和
2419
+ * */
2420
+ getTotalHeightForTreeHierarchy(): number;
2296
2421
  }
2297
2422
 
2298
2423
  declare interface OffsetConfig {
2424
+ rowHeaderOffsetX?: {
2425
+ value: number | undefined;
2426
+ animate?: boolean;
2427
+ };
2299
2428
  offsetX?: {
2300
2429
  value: number | undefined;
2301
2430
  animate?: boolean;
@@ -2435,7 +2564,7 @@ id: number;
2435
2564
  isCollapsed: boolean;
2436
2565
  node: Node_2;
2437
2566
  }) => void;
2438
- rowCellScroll: (position: CellScrollPosition) => void;
2567
+ rowCellScroll: (position: Required<ScrollOffset>) => void;
2439
2568
  colCellHover: (data: TargetCellInfo) => void;
2440
2569
  colCellClick: (data: TargetCellInfo) => void;
2441
2570
  colCellDoubleClick: (data: TargetCellInfo) => void;
@@ -2453,6 +2582,7 @@ dataCellMouseMove: (data: TargetCellInfo) => void;
2453
2582
  dataCellTrendIconClick: (meta: ViewMeta) => void;
2454
2583
  dataCellBrushSelection: (brushRangeDataCells: DataCell[]) => void;
2455
2584
  dataCellSelectMove: (metas: CellMeta[]) => void;
2585
+ dataCellEditEnd: (meta: ViewMeta) => void;
2456
2586
  cornerCellHover: (data: TargetCellInfo) => void;
2457
2587
  cornerCellClick: (data: TargetCellInfo) => void;
2458
2588
  cornerCellDoubleClick: (data: TargetCellInfo) => void;
@@ -2481,7 +2611,7 @@ pageCount: number;
2481
2611
  total: number;
2482
2612
  current: number;
2483
2613
  }) => void;
2484
- layoutCellScroll: (position: CellScrollPosition) => void;
2614
+ layoutCellScroll: (position: Required<ScrollOffset>) => void;
2485
2615
  layoutCollapseRows: (data: CollapsedRowsType) => void;
2486
2616
  layoutAfterCollapseRows: (data: CollapsedRowsType) => void;
2487
2617
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -2533,7 +2663,7 @@ linkFieldJump: (data: {
2533
2663
  key: string;
2534
2664
  record: Data;
2535
2665
  }) => void;
2536
- scroll: (position: CellScrollPosition) => void;
2666
+ scroll: (position: Required<ScrollOffset>) => void;
2537
2667
  layoutAfterRealDataCellRender: (options: {
2538
2668
  add: [number, number][];
2539
2669
  remove: [number, number][];
@@ -2584,7 +2714,7 @@ id: number;
2584
2714
  isCollapsed: boolean;
2585
2715
  node: Node_2;
2586
2716
  }) => any;
2587
- onRowCellScroll?: (position: CellScrollPosition) => any;
2717
+ onRowCellScroll?: (position: Required<ScrollOffset>) => any;
2588
2718
  onColCellHover?: (data: TargetCellInfo) => any;
2589
2719
  onColCellClick?: (data: TargetCellInfo) => any;
2590
2720
  onColCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -2602,6 +2732,7 @@ onDataCellMouseMove?: (data: TargetCellInfo) => any;
2602
2732
  onDataCellTrendIconClick?: (meta: ViewMeta) => any;
2603
2733
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell[]) => any;
2604
2734
  onDataCellSelectMove?: (metas: CellMeta[]) => any;
2735
+ onDataCellEditEnd?: (meta: ViewMeta) => any;
2605
2736
  onCornerCellHover?: (data: TargetCellInfo) => any;
2606
2737
  onCornerCellClick?: (data: TargetCellInfo) => any;
2607
2738
  onCornerCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -2630,7 +2761,7 @@ pageCount: number;
2630
2761
  total: number;
2631
2762
  current: number;
2632
2763
  }) => any;
2633
- onLayoutCellScroll?: (position: CellScrollPosition) => any;
2764
+ onLayoutCellScroll?: (position: Required<ScrollOffset>) => any;
2634
2765
  onLayoutCollapseRows?: (data: CollapsedRowsType) => any;
2635
2766
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType) => any;
2636
2767
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -2681,7 +2812,7 @@ onLinkFieldJump?: (data: {
2681
2812
  key: string;
2682
2813
  record: Data;
2683
2814
  }) => any;
2684
- onScroll?: (position: CellScrollPosition) => any;
2815
+ onScroll?: (position: Required<ScrollOffset>) => any;
2685
2816
  onLayoutAfterRealDataCellRender?: (options: {
2686
2817
  add: [number, number][];
2687
2818
  remove: [number, number][];
@@ -2715,6 +2846,13 @@ declare interface PropOption<T = any> {
2715
2846
  default?: T;
2716
2847
  }
2717
2848
 
2849
+ declare type Query = Record<string, any>;
2850
+
2851
+ declare enum QueryDataType {
2852
+ All = "all",
2853
+ DetailOnly = "detailOnly"
2854
+ }
2855
+
2718
2856
  declare interface RangeColors {
2719
2857
  good: string;
2720
2858
  satisfactory: string;
@@ -2820,7 +2958,7 @@ declare class RootInteraction {
2820
2958
  isHoverState(): boolean;
2821
2959
  isActiveCell(cell: S2CellType_2): boolean;
2822
2960
  isSelectedCell(cell: S2CellType_2): boolean;
2823
- getCells(): CellMeta_2[];
2961
+ getCells(cellType?: CellTypes[]): CellMeta_2[];
2824
2962
  getActiveCells(): S2CellType_2[];
2825
2963
  clearStyleIndependent(): void;
2826
2964
  getPanelGroupAllUnSelectedDataCells(): DataCell_2[];
@@ -2851,45 +2989,30 @@ declare class RootInteraction {
2851
2989
  clearHoverTimer(): void;
2852
2990
  setHoverTimer(timer: number): void;
2853
2991
  getHoverTimer(): number;
2992
+ getSelectedCellHighlight(): InteractionCellHighlight;
2993
+ getHoverAfterScroll(): boolean;
2994
+ getHoverHighlight(): InteractionCellHighlight;
2995
+ getBrushSelection(): BrushSelection;
2854
2996
  }
2855
2997
 
2856
- declare class RowCell extends HeaderCell {
2857
- protected headerConfig: RowHeaderConfig;
2858
- protected gm: GM;
2859
- get cellType(): CellTypes;
2860
- destroy(): void;
2861
- protected initCell(): void;
2998
+ /**
2999
+ * Adapting the frozen first row for cells pivot table
3000
+ */
3001
+ declare class RowCell extends BaseRowCell {
2862
3002
  /**
2863
- * 绘制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.
2864
3006
  */
2865
- protected drawInteractiveBorderShape(): void;
2866
- protected drawInteractiveBgShape(): void;
2867
- protected showTreeIcon(): boolean;
2868
- protected showTreeLeafNodeAlignDot(): boolean;
2869
- protected getParentTreeIconCfg(): any;
2870
- protected drawTreeIcon(): void;
2871
- protected drawTreeLeafNodeAlignDot(): void;
2872
- protected isBolderText(): boolean;
2873
- protected drawTextShape(): void;
2874
- protected drawLinkFieldShape(): void;
2875
- protected drawRectBorder(): void;
2876
- protected drawResizeAreaInLeaf(): void;
2877
- protected getContentIndent(): number;
2878
- protected getTextIndent(): number;
2879
- protected isTreeLevel(): any;
2880
- protected getIconPosition(): {
2881
- x: any;
2882
- y: any;
2883
- };
2884
- protected getMaxTextWidth(): number;
2885
- protected getTextArea(): {
2886
- x: number;
2887
- width: number;
2888
- y: number;
2889
- height: number;
2890
- };
2891
- protected getTextPosition(): Point;
2892
- 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;
2893
3016
  }
2894
3017
 
2895
3018
  declare type RowCellCollapseTreeRowsType = {
@@ -2908,6 +3031,8 @@ declare interface RowCfg {
2908
3031
  treeRowsWidth?: number;
2909
3032
  }
2910
3033
 
3034
+ declare type RowData = Data_2 | DataType_2;
3035
+
2911
3036
  /**
2912
3037
  * Row Header for SpreadSheet
2913
3038
  */
@@ -2915,6 +3040,10 @@ declare class RowHeader extends BaseHeader<RowHeaderConfig> {
2915
3040
  private gm;
2916
3041
  constructor(cfg: RowHeaderConfig);
2917
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>;
2918
3047
  protected layout(): void;
2919
3048
  protected offset(): void;
2920
3049
  protected clip(): void;
@@ -2922,7 +3051,7 @@ declare class RowHeader extends BaseHeader<RowHeaderConfig> {
2922
3051
 
2923
3052
  declare interface RowHeaderConfig extends BaseHeaderConfig {
2924
3053
  hierarchyType: S2Options_2['hierarchyType'];
2925
- linkFields: string[];
3054
+ linkFields: string[] | ((meta: Node_2_2 | ViewMeta_2) => boolean);
2926
3055
  seriesNumberWidth: number;
2927
3056
  }
2928
3057
 
@@ -2954,6 +3083,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
2954
3083
  cornerCell?: CellCallback<CornerHeaderConfig>;
2955
3084
  rowCell?: CellCallback<RowHeaderConfig>;
2956
3085
  colCell?: CellCallback<ColHeaderConfig>;
3086
+ mergedCell?: MergedCellCallback;
2957
3087
  frame?: FrameCallback;
2958
3088
  cornerHeader?: CornerHeaderCallback;
2959
3089
  /** ***********CUSTOM LIFECYCLE HOOKS**************** */
@@ -2966,7 +3096,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Ico
2966
3096
  mappingDisplayDataItem?: MappingDataItemCallback;
2967
3097
  }
2968
3098
 
2969
- 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>;
2970
3100
 
2971
3101
  declare interface S2DataConfig_2 {
2972
3102
  data: Data_2[];
@@ -3088,6 +3218,7 @@ declare interface S2Options_2<T = TooltipContentType_2, P = Pagination_2, Icon =
3088
3218
  }
3089
3219
 
3090
3220
  declare interface S2PivotSheetOptions {
3221
+ frozenFirstRow?: boolean;
3091
3222
  }
3092
3223
 
3093
3224
  declare interface S2RenderOptions_2 {
@@ -3198,10 +3329,10 @@ declare interface ScrollBarTheme {
3198
3329
  lineCap?: ShapeAttrs['lineCap'];
3199
3330
  }
3200
3331
 
3201
- declare interface ScrollOffset {
3332
+ declare interface ScrollOffset_2 {
3202
3333
  scrollX?: number;
3203
3334
  scrollY?: number;
3204
- hRowScrollX?: number;
3335
+ rowHeaderScrollX?: number;
3205
3336
  }
3206
3337
 
3207
3338
  declare interface ScrollSpeedRatio {
@@ -3216,9 +3347,7 @@ declare interface SelectHeaderCellInfo {
3216
3347
  isMultiSelection?: boolean;
3217
3348
  }
3218
3349
 
3219
- declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
3220
- private backgroundShape;
3221
- private leftBorderShape;
3350
+ declare class SeriesNumberHeader extends BaseFrozenRowHeader {
3222
3351
  /**
3223
3352
  * Get seriesNumber header by config
3224
3353
  * @param viewportBBox
@@ -3227,19 +3356,18 @@ declare class SeriesNumberHeader extends BaseHeader<BaseHeaderConfig> {
3227
3356
  * @param spreadsheet
3228
3357
  * @param cornerWidth
3229
3358
  */
3230
- static getSeriesNumberHeader(viewportBBox: PanelBBox, seriesNumberWidth: number, leafNodes: Node_2_2[], spreadsheet: SpreadSheet_2, cornerWidth: number): SeriesNumberHeader;
3231
- constructor(cfg: BaseHeaderConfig);
3232
- clip(): void;
3233
- layout(): void;
3234
- protected offset(): void;
3235
- private addBackGround;
3236
- private addBorder;
3237
- private getStyle;
3238
- private addText;
3239
- 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;
3240
3368
  }
3241
3369
 
3242
- 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, "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" | "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" | "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">, {
3243
3371
  s2Ref: ShallowRef<SheetExpose>;
3244
3372
  sheetType: ComputedRef<DefineComponent< {
3245
3373
  sheetType: PropType<SheetType>;
@@ -3288,7 +3416,7 @@ id: number;
3288
3416
  isCollapsed: boolean;
3289
3417
  node: Node_2_2;
3290
3418
  }) => void;
3291
- rowCellScroll: (position: CellScrollPosition_2) => void;
3419
+ rowCellScroll: (position: Required<ScrollOffset_2>) => void;
3292
3420
  colCellHover: (data: TargetCellInfo_2) => void;
3293
3421
  colCellClick: (data: TargetCellInfo_2) => void;
3294
3422
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3306,6 +3434,7 @@ dataCellMouseMove: (data: TargetCellInfo_2) => void;
3306
3434
  dataCellTrendIconClick: (meta: ViewMeta_2) => void;
3307
3435
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
3308
3436
  dataCellSelectMove: (metas: CellMeta_2[]) => void;
3437
+ dataCellEditEnd: (meta: ViewMeta_2) => void;
3309
3438
  cornerCellHover: (data: TargetCellInfo_2) => void;
3310
3439
  cornerCellClick: (data: TargetCellInfo_2) => void;
3311
3440
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3334,7 +3463,7 @@ pageCount: number;
3334
3463
  total: number;
3335
3464
  current: number;
3336
3465
  }) => void;
3337
- layoutCellScroll: (position: CellScrollPosition_2) => void;
3466
+ layoutCellScroll: (position: Required<ScrollOffset_2>) => void;
3338
3467
  layoutCollapseRows: (data: CollapsedRowsType_2) => void;
3339
3468
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
3340
3469
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -3386,7 +3515,7 @@ linkFieldJump: (data: {
3386
3515
  key: string;
3387
3516
  record: Data_2;
3388
3517
  }) => void;
3389
- scroll: (position: CellScrollPosition_2) => void;
3518
+ scroll: (position: Required<ScrollOffset_2>) => void;
3390
3519
  layoutAfterRealDataCellRender: (options: {
3391
3520
  add: [number, number][];
3392
3521
  remove: [number, number][];
@@ -3437,7 +3566,7 @@ id: number;
3437
3566
  isCollapsed: boolean;
3438
3567
  node: Node_2_2;
3439
3568
  }) => any;
3440
- onRowCellScroll?: (position: CellScrollPosition_2) => any;
3569
+ onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
3441
3570
  onColCellHover?: (data: TargetCellInfo_2) => any;
3442
3571
  onColCellClick?: (data: TargetCellInfo_2) => any;
3443
3572
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3455,6 +3584,7 @@ onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
3455
3584
  onDataCellTrendIconClick?: (meta: ViewMeta_2) => any;
3456
3585
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
3457
3586
  onDataCellSelectMove?: (metas: CellMeta_2[]) => any;
3587
+ onDataCellEditEnd?: (meta: ViewMeta_2) => any;
3458
3588
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
3459
3589
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
3460
3590
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3483,7 +3613,7 @@ pageCount: number;
3483
3613
  total: number;
3484
3614
  current: number;
3485
3615
  }) => any;
3486
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
3616
+ onLayoutCellScroll?: (position: Required<ScrollOffset_2>) => any;
3487
3617
  onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
3488
3618
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
3489
3619
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -3534,7 +3664,7 @@ onLinkFieldJump?: (data: {
3534
3664
  key: string;
3535
3665
  record: Data_2;
3536
3666
  }) => any;
3537
- onScroll?: (position: CellScrollPosition_2) => any;
3667
+ onScroll?: (position: Required<ScrollOffset_2>) => any;
3538
3668
  onLayoutAfterRealDataCellRender?: (options: {
3539
3669
  add: [number, number][];
3540
3670
  remove: [number, number][];
@@ -3556,7 +3686,7 @@ showPagination: boolean | {
3556
3686
  onShowSizeChange?: (pageSize: number) => void;
3557
3687
  onChange?: (current: number) => void;
3558
3688
  };
3559
- }> | 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, "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" | "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" | "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">, {
3560
3690
  s2Ref: ShallowRef<SheetExpose>;
3561
3691
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
3562
3692
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
@@ -3574,7 +3704,7 @@ id: number;
3574
3704
  isCollapsed: boolean;
3575
3705
  node: Node_2_2;
3576
3706
  }) => void;
3577
- rowCellScroll: (position: CellScrollPosition_2) => void;
3707
+ rowCellScroll: (position: Required<ScrollOffset_2>) => void;
3578
3708
  colCellHover: (data: TargetCellInfo_2) => void;
3579
3709
  colCellClick: (data: TargetCellInfo_2) => void;
3580
3710
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3592,6 +3722,7 @@ dataCellMouseMove: (data: TargetCellInfo_2) => void;
3592
3722
  dataCellTrendIconClick: (meta: ViewMeta_2) => void;
3593
3723
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
3594
3724
  dataCellSelectMove: (metas: CellMeta_2[]) => void;
3725
+ dataCellEditEnd: (meta: ViewMeta_2) => void;
3595
3726
  cornerCellHover: (data: TargetCellInfo_2) => void;
3596
3727
  cornerCellClick: (data: TargetCellInfo_2) => void;
3597
3728
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3620,7 +3751,7 @@ pageCount: number;
3620
3751
  total: number;
3621
3752
  current: number;
3622
3753
  }) => void;
3623
- layoutCellScroll: (position: CellScrollPosition_2) => void;
3754
+ layoutCellScroll: (position: Required<ScrollOffset_2>) => void;
3624
3755
  layoutCollapseRows: (data: CollapsedRowsType_2) => void;
3625
3756
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
3626
3757
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -3672,7 +3803,7 @@ linkFieldJump: (data: {
3672
3803
  key: string;
3673
3804
  record: Data_2;
3674
3805
  }) => void;
3675
- scroll: (position: CellScrollPosition_2) => void;
3806
+ scroll: (position: Required<ScrollOffset_2>) => void;
3676
3807
  layoutAfterRealDataCellRender: (options: {
3677
3808
  add: [number, number][];
3678
3809
  remove: [number, number][];
@@ -3680,7 +3811,7 @@ spreadsheet: SpreadSheet_2;
3680
3811
  }) => void;
3681
3812
  rowCellBrushSelection: (event: default_2) => void;
3682
3813
  colCellBrushSelection: (event: default_2) => void;
3683
- }, 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">>> & {
3814
+ }, 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" | "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" | "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">>> & {
3684
3815
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
3685
3816
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
3686
3817
  onRowCellHover?: (data: TargetCellInfo_2) => any;
@@ -3695,7 +3826,7 @@ id: number;
3695
3826
  isCollapsed: boolean;
3696
3827
  node: Node_2_2;
3697
3828
  }) => any;
3698
- onRowCellScroll?: (position: CellScrollPosition_2) => any;
3829
+ onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
3699
3830
  onColCellHover?: (data: TargetCellInfo_2) => any;
3700
3831
  onColCellClick?: (data: TargetCellInfo_2) => any;
3701
3832
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3713,6 +3844,7 @@ onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
3713
3844
  onDataCellTrendIconClick?: (meta: ViewMeta_2) => any;
3714
3845
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
3715
3846
  onDataCellSelectMove?: (metas: CellMeta_2[]) => any;
3847
+ onDataCellEditEnd?: (meta: ViewMeta_2) => any;
3716
3848
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
3717
3849
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
3718
3850
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3741,7 +3873,7 @@ pageCount: number;
3741
3873
  total: number;
3742
3874
  current: number;
3743
3875
  }) => any;
3744
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
3876
+ onLayoutCellScroll?: (position: Required<ScrollOffset_2>) => any;
3745
3877
  onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
3746
3878
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
3747
3879
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -3792,7 +3924,7 @@ onLinkFieldJump?: (data: {
3792
3924
  key: string;
3793
3925
  record: Data_2;
3794
3926
  }) => any;
3795
- onScroll?: (position: CellScrollPosition_2) => any;
3927
+ onScroll?: (position: Required<ScrollOffset_2>) => any;
3796
3928
  onLayoutAfterRealDataCellRender?: (options: {
3797
3929
  add: [number, number][];
3798
3930
  remove: [number, number][];
@@ -3819,7 +3951,7 @@ id: number;
3819
3951
  isCollapsed: boolean;
3820
3952
  node: Node_2_2;
3821
3953
  }) => void;
3822
- rowCellScroll: (position: CellScrollPosition_2) => void;
3954
+ rowCellScroll: (position: Required<ScrollOffset_2>) => void;
3823
3955
  colCellHover: (data: TargetCellInfo_2) => void;
3824
3956
  colCellClick: (data: TargetCellInfo_2) => void;
3825
3957
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3837,6 +3969,7 @@ dataCellMouseMove: (data: TargetCellInfo_2) => void;
3837
3969
  dataCellTrendIconClick: (meta: ViewMeta_2) => void;
3838
3970
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
3839
3971
  dataCellSelectMove: (metas: CellMeta_2[]) => void;
3972
+ dataCellEditEnd: (meta: ViewMeta_2) => void;
3840
3973
  cornerCellHover: (data: TargetCellInfo_2) => void;
3841
3974
  cornerCellClick: (data: TargetCellInfo_2) => void;
3842
3975
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -3865,7 +3998,7 @@ pageCount: number;
3865
3998
  total: number;
3866
3999
  current: number;
3867
4000
  }) => void;
3868
- layoutCellScroll: (position: CellScrollPosition_2) => void;
4001
+ layoutCellScroll: (position: Required<ScrollOffset_2>) => void;
3869
4002
  layoutCollapseRows: (data: CollapsedRowsType_2) => void;
3870
4003
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
3871
4004
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -3917,7 +4050,7 @@ linkFieldJump: (data: {
3917
4050
  key: string;
3918
4051
  record: Data_2;
3919
4052
  }) => void;
3920
- scroll: (position: CellScrollPosition_2) => void;
4053
+ scroll: (position: Required<ScrollOffset_2>) => void;
3921
4054
  layoutAfterRealDataCellRender: (options: {
3922
4055
  add: [number, number][];
3923
4056
  remove: [number, number][];
@@ -3925,7 +4058,7 @@ spreadsheet: SpreadSheet_2;
3925
4058
  }) => void;
3926
4059
  rowCellBrushSelection: (event: default_2) => void;
3927
4060
  colCellBrushSelection: (event: default_2) => void;
3928
- }, 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">>> & {
4061
+ }, 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" | "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" | "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">>> & {
3929
4062
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
3930
4063
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
3931
4064
  onRowCellHover?: (data: TargetCellInfo_2) => any;
@@ -3940,7 +4073,7 @@ id: number;
3940
4073
  isCollapsed: boolean;
3941
4074
  node: Node_2_2;
3942
4075
  }) => any;
3943
- onRowCellScroll?: (position: CellScrollPosition_2) => any;
4076
+ onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
3944
4077
  onColCellHover?: (data: TargetCellInfo_2) => any;
3945
4078
  onColCellClick?: (data: TargetCellInfo_2) => any;
3946
4079
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3958,6 +4091,7 @@ onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
3958
4091
  onDataCellTrendIconClick?: (meta: ViewMeta_2) => any;
3959
4092
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
3960
4093
  onDataCellSelectMove?: (metas: CellMeta_2[]) => any;
4094
+ onDataCellEditEnd?: (meta: ViewMeta_2) => any;
3961
4095
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
3962
4096
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
3963
4097
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -3986,7 +4120,7 @@ pageCount: number;
3986
4120
  total: number;
3987
4121
  current: number;
3988
4122
  }) => any;
3989
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
4123
+ onLayoutCellScroll?: (position: Required<ScrollOffset_2>) => any;
3990
4124
  onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
3991
4125
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
3992
4126
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -4037,7 +4171,7 @@ onLinkFieldJump?: (data: {
4037
4171
  key: string;
4038
4172
  record: Data_2;
4039
4173
  }) => any;
4040
- onScroll?: (position: CellScrollPosition_2) => any;
4174
+ onScroll?: (position: Required<ScrollOffset_2>) => any;
4041
4175
  onLayoutAfterRealDataCellRender?: (options: {
4042
4176
  add: [number, number][];
4043
4177
  remove: [number, number][];
@@ -4062,6 +4196,18 @@ declare type SheetType = 'pivot' | 'table' | 'gridAnalysis' | 'strategy' | 'edit
4062
4196
  /** render callback */
4063
4197
  declare type SheetUpdateCallback = (params: S2RenderOptions) => S2RenderOptions;
4064
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
+
4065
4211
  declare type SimpleDataItem = string | number;
4066
4212
 
4067
4213
  declare interface Sort {
@@ -4106,6 +4252,8 @@ declare interface SplitLine {
4106
4252
  left: string;
4107
4253
  right: string;
4108
4254
  };
4255
+ /** 分割线虚线 */
4256
+ borderDash?: number[];
4109
4257
  }
4110
4258
 
4111
4259
  declare abstract class SpreadSheet_2 extends EE {
@@ -4186,7 +4334,7 @@ declare abstract class SpreadSheet_2 extends EE {
4186
4334
  abstract clearDrillDownData(rowNodeId?: string, preventRender?: boolean): void;
4187
4335
  abstract handleGroupSort(event: Event_2, meta: Node_2_2): void;
4188
4336
  showTooltip<T = TooltipContentType_2>(showOptions: TooltipShowOptions<T>): void;
4189
- showTooltipWithInfo(event: Event_2 | MouseEvent, data: TooltipData[], options?: TooltipOptions): void;
4337
+ showTooltipWithInfo(event: Event_2 | MouseEvent, cellInfos: TooltipData[], options?: TooltipOptions): void;
4190
4338
  hideTooltip(): void;
4191
4339
  destroyTooltip(): void;
4192
4340
  registerIcons(): void;
@@ -4195,9 +4343,11 @@ declare abstract class SpreadSheet_2 extends EE {
4195
4343
  * Group sort params kept in {@see store} and
4196
4344
  * Priority: group sort > advanced sort
4197
4345
  * @param dataCfg
4198
- * @param reset reset: true, 直接使用用户传入的 DataCfg ,不再与上次数据进行合并
4346
+ * @param reset 是否使用传入的 dataCfg 重置已保存的 dataCfg
4347
+ *
4348
+ * @example setDataCfg(dataCfg, true) 直接使用传入的 DataCfg,不再与上次数据进行合并
4199
4349
  */
4200
- 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;
4201
4351
  setOptions(options: Partial<S2Options_2>, reset?: boolean): void;
4202
4352
  render(reloadData?: boolean, options?: S2RenderOptions_2): void;
4203
4353
  destroy(): void;
@@ -4246,6 +4396,7 @@ declare abstract class SpreadSheet_2 extends EE {
4246
4396
  */
4247
4397
  updateScrollOffset(offsetConfig: OffsetConfig): void;
4248
4398
  getTooltipDataItemMappingCallback(): MappingDataItemCallback;
4399
+ protected isCellType(cell?: Event_2['target']): boolean;
4249
4400
  getCell<T extends S2CellType_2 = S2CellType_2>(target: Event_2['target']): T;
4250
4401
  getCellType(target: Event_2['target']): CellTypes;
4251
4402
  /**
@@ -4330,14 +4481,14 @@ declare class Store {
4330
4481
  declare interface StoreKey {
4331
4482
  scrollX: number;
4332
4483
  scrollY: number;
4333
- hRowScrollX: number;
4484
+ rowHeaderScrollX: number;
4334
4485
  sortParam: SortParam;
4335
4486
  drillDownIdPathMap: Map<string, number[][]>;
4336
4487
  drillDownNode: Node_2_2;
4337
4488
  drillItemsNum: number;
4338
4489
  drillDownFieldInLevel: PartDrillDownFieldInLevel[];
4339
4490
  interactionStateInfo: InteractionStateInfo;
4340
- originalDataCfg: S2DataConfig_2;
4491
+ originalDataCfg: Partial<S2DataConfig_2>;
4341
4492
  panelBBox: BBox;
4342
4493
  activeResizeArea: Group;
4343
4494
  valueRanges: ValueRanges;
@@ -4370,7 +4521,7 @@ declare interface Style {
4370
4521
  device?: 'pc' | 'mobile';
4371
4522
  }
4372
4523
 
4373
- 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">, {
4524
+ 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" | "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" | "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">, {
4374
4525
  s2Ref: ShallowRef<SheetExpose>;
4375
4526
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
4376
4527
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, string | Element, string>) => SpreadSheet_2;
@@ -4388,7 +4539,7 @@ id: number;
4388
4539
  isCollapsed: boolean;
4389
4540
  node: Node_2_2;
4390
4541
  }) => void;
4391
- rowCellScroll: (position: CellScrollPosition_2) => void;
4542
+ rowCellScroll: (position: Required<ScrollOffset_2>) => void;
4392
4543
  colCellHover: (data: TargetCellInfo_2) => void;
4393
4544
  colCellClick: (data: TargetCellInfo_2) => void;
4394
4545
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4406,6 +4557,7 @@ dataCellMouseMove: (data: TargetCellInfo_2) => void;
4406
4557
  dataCellTrendIconClick: (meta: ViewMeta_2) => void;
4407
4558
  dataCellBrushSelection: (brushRangeDataCells: DataCell_2[]) => void;
4408
4559
  dataCellSelectMove: (metas: CellMeta_2[]) => void;
4560
+ dataCellEditEnd: (meta: ViewMeta_2) => void;
4409
4561
  cornerCellHover: (data: TargetCellInfo_2) => void;
4410
4562
  cornerCellClick: (data: TargetCellInfo_2) => void;
4411
4563
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4434,7 +4586,7 @@ pageCount: number;
4434
4586
  total: number;
4435
4587
  current: number;
4436
4588
  }) => void;
4437
- layoutCellScroll: (position: CellScrollPosition_2) => void;
4589
+ layoutCellScroll: (position: Required<ScrollOffset_2>) => void;
4438
4590
  layoutCollapseRows: (data: CollapsedRowsType_2) => void;
4439
4591
  layoutAfterCollapseRows: (data: CollapsedRowsType_2) => void;
4440
4592
  collapseRowsAll: (hierarchyCollapse: boolean) => void;
@@ -4486,7 +4638,7 @@ linkFieldJump: (data: {
4486
4638
  key: string;
4487
4639
  record: Data_2;
4488
4640
  }) => void;
4489
- scroll: (position: CellScrollPosition_2) => void;
4641
+ scroll: (position: Required<ScrollOffset_2>) => void;
4490
4642
  layoutAfterRealDataCellRender: (options: {
4491
4643
  add: [number, number][];
4492
4644
  remove: [number, number][];
@@ -4494,7 +4646,7 @@ spreadsheet: SpreadSheet_2;
4494
4646
  }) => void;
4495
4647
  rowCellBrushSelection: (event: default_2) => void;
4496
4648
  colCellBrushSelection: (event: default_2) => void;
4497
- }, 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">>> & {
4649
+ }, 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" | "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" | "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">>> & {
4498
4650
  onMounted?: (spreadsheet: SpreadSheet_2) => any;
4499
4651
  onSheetUpdate?: (params: S2RenderOptions_2) => any;
4500
4652
  onRowCellHover?: (data: TargetCellInfo_2) => any;
@@ -4509,7 +4661,7 @@ id: number;
4509
4661
  isCollapsed: boolean;
4510
4662
  node: Node_2_2;
4511
4663
  }) => any;
4512
- onRowCellScroll?: (position: CellScrollPosition_2) => any;
4664
+ onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
4513
4665
  onColCellHover?: (data: TargetCellInfo_2) => any;
4514
4666
  onColCellClick?: (data: TargetCellInfo_2) => any;
4515
4667
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4527,6 +4679,7 @@ onDataCellMouseMove?: (data: TargetCellInfo_2) => any;
4527
4679
  onDataCellTrendIconClick?: (meta: ViewMeta_2) => any;
4528
4680
  onDataCellBrushSelection?: (brushRangeDataCells: DataCell_2[]) => any;
4529
4681
  onDataCellSelectMove?: (metas: CellMeta_2[]) => any;
4682
+ onDataCellEditEnd?: (meta: ViewMeta_2) => any;
4530
4683
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
4531
4684
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
4532
4685
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4555,7 +4708,7 @@ pageCount: number;
4555
4708
  total: number;
4556
4709
  current: number;
4557
4710
  }) => any;
4558
- onLayoutCellScroll?: (position: CellScrollPosition_2) => any;
4711
+ onLayoutCellScroll?: (position: Required<ScrollOffset_2>) => any;
4559
4712
  onLayoutCollapseRows?: (data: CollapsedRowsType_2) => any;
4560
4713
  onLayoutAfterCollapseRows?: (data: CollapsedRowsType_2) => any;
4561
4714
  onCollapseRowsAll?: (hierarchyCollapse: boolean) => any;
@@ -4606,7 +4759,7 @@ onLinkFieldJump?: (data: {
4606
4759
  key: string;
4607
4760
  record: Data_2;
4608
4761
  }) => any;
4609
- onScroll?: (position: CellScrollPosition_2) => any;
4762
+ onScroll?: (position: Required<ScrollOffset_2>) => any;
4610
4763
  onLayoutAfterRealDataCellRender?: (options: {
4611
4764
  add: [number, number][];
4612
4765
  remove: [number, number][];
@@ -4633,7 +4786,7 @@ declare interface TextAlignCfg {
4633
4786
 
4634
4787
  declare type TextBaseline = 'top' | 'middle' | 'bottom';
4635
4788
 
4636
- declare interface TextTheme extends TextAlignCfg {
4789
+ declare interface TextTheme extends TextAlignCfg, Pick<ShapeAttrs, 'fontStyle' | 'fontVariant'> {
4637
4790
  fontFamily?: string;
4638
4791
  fontSize?: number;
4639
4792
  fontWeight?: number | 'normal' | 'bold' | 'bolder' | 'lighter';
@@ -4725,6 +4878,7 @@ declare interface TooltipOptions<Icon = Element | string, Text = string> {
4725
4878
  onlyMenu?: boolean;
4726
4879
  enableFormat?: boolean;
4727
4880
  forceRender?: boolean;
4881
+ data?: TooltipData;
4728
4882
  }
4729
4883
 
4730
4884
  declare interface TooltipPosition {
@@ -4747,11 +4901,14 @@ declare type TooltipShowOptions<T = TooltipContentType_2, Icon = Element | strin
4747
4901
  };
4748
4902
 
4749
4903
  declare interface TooltipSummaryOptions {
4750
- name: string;
4751
- value: number | string;
4904
+ name: string | null;
4752
4905
  selectedData: TooltipDataItem[];
4906
+ value: TooltipSummaryOptionsValue;
4907
+ originValue?: TooltipSummaryOptionsValue;
4753
4908
  }
4754
4909
 
4910
+ declare type TooltipSummaryOptionsValue = number | string | undefined | null;
4911
+
4755
4912
  declare interface Total {
4756
4913
  /** 是否显示总计 */
4757
4914
  showGrandTotals: boolean;
@@ -4770,6 +4927,10 @@ declare interface Total {
4770
4927
  reverseSubLayout: boolean;
4771
4928
  label?: string;
4772
4929
  subLabel?: string;
4930
+ /** 总计分组维度 */
4931
+ totalsGroupDimensions?: string[];
4932
+ /** 小计分组维度 */
4933
+ subTotalsGroupDimensions?: string[];
4773
4934
  }
4774
4935
 
4775
4936
  /**
@@ -4782,6 +4943,13 @@ declare interface Totals {
4782
4943
  col?: Partial<Total>;
4783
4944
  }
4784
4945
 
4946
+ declare interface TotalStatus {
4947
+ isRowTotal: boolean;
4948
+ isRowSubTotal: boolean;
4949
+ isColTotal: boolean;
4950
+ isColSubTotal: boolean;
4951
+ }
4952
+
4785
4953
  export declare const useExpose: (expose: (exposed?: Record<string, any>) => void) => ShallowRef<SheetExpose>;
4786
4954
 
4787
4955
  declare interface ValueRange {
@@ -4791,6 +4959,8 @@ declare interface ValueRange {
4791
4959
 
4792
4960
  declare type ValueRanges = Record<string, ValueRange>;
4793
4961
 
4962
+ export declare const version = "@antv/s2-vue-v1.6.0";
4963
+
4794
4964
  declare interface ViewCellHeights {
4795
4965
  getCellOffsetY: (index: number) => number;
4796
4966
  getTotalHeight: () => number;
@@ -4814,15 +4984,15 @@ declare interface ViewMeta_2 {
4814
4984
  valueField: string;
4815
4985
  fieldValue: DataItem;
4816
4986
  isTotals?: boolean;
4817
- rowQuery?: Record<string, any>;
4818
- colQuery?: Record<string, any>;
4987
+ rowQuery?: Query;
4988
+ colQuery?: Query;
4819
4989
  rowId?: string;
4820
4990
  colId?: string;
4821
4991
  field?: string;
4822
4992
  isFrozenCorner?: boolean;
4823
4993
  label?: string;
4824
4994
  value?: string | number;
4825
- query?: Record<string, any>;
4995
+ query?: Query;
4826
4996
  [key: string]: unknown;
4827
4997
  }
4828
4998