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

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,13 +3,15 @@ import { BaseTooltipOperatorMenuOptions } from '@antv/s2';
3
3
  import { Canvas } from '@antv/g';
4
4
  import { CanvasConfig } from '@antv/g';
5
5
  import type { CellScrollPosition } from '@antv/s2';
6
+ import { CellSelectedDetail } from '@antv/s2';
7
+ import { CellSelectedHandler } from '@antv/s2';
6
8
  import { ColCell } from '@antv/s2';
7
9
  import { ComponentOptionsMixin } from 'vue';
8
10
  import { ComputedRef } from 'vue';
9
11
  import { CopyableList } from '@antv/s2';
10
12
  import { CornerCell } from '@antv/s2';
11
13
  import type * as CSS_2 from 'csstype';
12
- import { CSSGlobalKeywords } from '@antv/g-lite/dist/css';
14
+ import { CSSGlobalKeywords } from '@antv/g-lite/types/css';
13
15
  import { DataCell } from '@antv/s2';
14
16
  import { DebouncedFunc } from 'lodash';
15
17
  import { DefineComponent } from 'vue';
@@ -43,8 +45,10 @@ import { RawData } from '@antv/s2';
43
45
  import { Rect } from '@antv/g';
44
46
  import { Rectangle } from '@antv/g';
45
47
  import { Ref } from 'vue';
48
+ import type { Renderer } from '@antv/g-canvas';
46
49
  import { ResizeInfo } from '@antv/s2';
47
50
  import { ResizeParams } from '@antv/s2';
51
+ import { RowCell } from '@antv/s2';
48
52
  import { RowCellCollapsedParams } from '@antv/s2';
49
53
  import { S2CellType } from '@antv/s2';
50
54
  import { S2DataConfig } from '@antv/s2';
@@ -141,7 +145,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
141
145
  protected textShapes: CustomText[];
142
146
  protected linkFieldShape: Line;
143
147
  protected actualText: string;
144
- protected originalText: string;
148
+ protected originalText: SimpleData;
145
149
  protected conditions: Conditions;
146
150
  protected conditionIntervalShape: Rect | undefined;
147
151
  protected conditionIconShape: GuiIcon;
@@ -213,7 +217,7 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
213
217
  /**
214
218
  * 获取原始的文本 (不含省略号)
215
219
  */
216
- getOriginalText(): string;
220
+ getOriginalText(): SimpleData;
217
221
  /**
218
222
  * 文本是否溢出 (有省略号)
219
223
  */
@@ -222,25 +226,25 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
222
226
  * 是否是多行文本
223
227
  */
224
228
  isMultiLineText(): boolean;
225
- /**
226
- * 获取单元格空值占位符
227
- */
228
- getEmptyPlaceholder(): string | null | undefined;
229
229
  /**
230
230
  * 获取文本包围盒
231
231
  */
232
232
  getTextLineBoundingRects(): Rectangle[];
233
+ /**
234
+ * 获取单元格空值占位符
235
+ */
236
+ getEmptyPlaceholder(): string | null | undefined;
233
237
  /**
234
238
  * 获取单元格展示的数值
235
239
  */
236
- getFieldValue(): string;
240
+ getFieldValue(): SimpleData;
237
241
  protected shouldInit(): boolean;
238
242
  getStyle<K extends keyof InternalFullyTheme = CellType>(name?: K): InternalFullyTheme[K] | InternalFullyCellTheme;
239
243
  getLinkFieldShape(): Line;
240
244
  getBackgroundShape(): Image_2 | Rect | Polygon;
241
245
  getStateShapes(): Map<StateShapeLayer, DisplayObject<any, any>>;
242
246
  protected getResizeAreaStyle(): ResizeArea;
243
- protected shouldDrawResizeAreaByType(type: keyof ResizeInteractionOptions, cell: S2CellType_2): number | boolean | "selected" | "all" | "current" | ((cell: S2CellType_2) => boolean) | ((resizeInfo: ResizeInfo_2) => boolean) | undefined;
247
+ protected shouldDrawResizeAreaByType(type: keyof ResizeInteractionOptions, cell: S2CellType_2): number | boolean | "selected" | "all" | ((cell: S2CellType_2) => boolean) | "current" | ((resizeInfo: ResizeInfo_2) => boolean) | undefined;
244
248
  getBBoxByType(type?: CellClipBox): SimpleBBox;
245
249
  drawBorders(): void;
246
250
  /**
@@ -257,8 +261,8 @@ declare abstract class BaseCell<T extends SimpleBBox> extends Group {
257
261
  drawTextShape(): void;
258
262
  protected drawLinkFieldShape(showLinkFieldShape: boolean, linkFillColor: string): void;
259
263
  protected getLinkFieldStyle(): string;
260
- protected drawLinkField(meta: Node_2_2 | ViewMeta_2): void;
261
- updateByState(stateName: InteractionStateName, cell: S2CellType_2): void;
264
+ protected drawLinkField(meta: T): void;
265
+ updateByState(stateName: `${InteractionStateName}`, cell: S2CellType_2): void;
262
266
  protected getInteractiveBorderShapeStyle<T>(borderSize: T & number): {
263
267
  x: number;
264
268
  y: number;
@@ -434,7 +438,7 @@ declare abstract class BaseDataSet_2 {
434
438
  */
435
439
  getCustomFieldDescription: (cell: S2CellType_2<ViewMeta_2 | Node_2_2>) => string | undefined;
436
440
  /**
437
- * 获得字段格式方法
441
+ * 获得字段格式化方法
438
442
  * @param field
439
443
  */
440
444
  getFieldFormatter(field: CustomHeaderField): Formatter;
@@ -480,7 +484,7 @@ declare abstract class BaseDataSet_2 {
480
484
  * @param field
481
485
  * @param query
482
486
  */
483
- abstract getDimensionValues(field: string, query?: Query): string[];
487
+ abstract getDimensionValues(field: string, query?: Query): SimpleData[];
484
488
  /**
485
489
  * 获取单个的单元格数据
486
490
  */
@@ -534,7 +538,7 @@ declare abstract class BaseFacet {
534
538
  foregroundGroup: Group;
535
539
  /**
536
540
  * 当前布局节点信息
537
- * @description 内部消费, 外部调用请使用 facet.getLayoutResult()
541
+ * @private 内部消费, 外部调用请使用 facet.getLayoutResult()
538
542
  */
539
543
  protected layoutResult: LayoutResult_2;
540
544
  viewCellWidths: number[];
@@ -551,9 +555,9 @@ declare abstract class BaseFacet {
551
555
  centerFrame: Frame;
552
556
  gridInfo: GridInfo;
553
557
  protected textWrapNodeHeightCache: Map<string, number>;
554
- protected textWrapTempRowCell: RowCell | DataCell_2;
558
+ protected textWrapTempRowCell: RowCell_2 | DataCell_2;
555
559
  protected textWrapTempColCell: ColCell_2 | TableColCell;
556
- protected abstract getRowCellInstance(node: Node_2_2 | ViewMeta_2, spreadsheet: SpreadSheet_2, config: Partial<BaseHeaderConfig>): RowCell | DataCell_2;
560
+ protected abstract getRowCellInstance(node: Node_2_2 | ViewMeta_2, spreadsheet: SpreadSheet_2, config: Partial<BaseHeaderConfig>): RowCell_2 | DataCell_2;
557
561
  protected abstract getColCellInstance(node: Node_2_2, spreadsheet: SpreadSheet_2, config: Partial<BaseHeaderConfig>): ColCell_2;
558
562
  protected abstract doLayout(): LayoutResult_2;
559
563
  protected abstract clip(scrollX: number, scrollY: number): void;
@@ -562,6 +566,8 @@ declare abstract class BaseFacet {
562
566
  abstract getViewCellHeights(): ViewCellHeights;
563
567
  abstract addDataCell(cell: DataCell_2): void;
564
568
  abstract getCellMeta(rowIndex: number, colIndex: number): ViewMeta_2 | null;
569
+ abstract getContentWidth(): number;
570
+ abstract getContentHeight(): number;
565
571
  protected scrollFrameId: ReturnType<typeof requestAnimationFrame> | null;
566
572
  protected scrollDirection: ScrollDirection;
567
573
  get scrollBarTheme(): DeepRequired<ScrollBarTheme>;
@@ -617,8 +623,10 @@ declare abstract class BaseFacet {
617
623
  width: number;
618
624
  height: number;
619
625
  };
620
- getContentHeight(): number;
621
- updateScrollOffset(offsetConfig: OffsetConfig): void;
626
+ /**
627
+ * @alias s2.interaction.scrollTo(offsetConfig)
628
+ */
629
+ updateScrollOffset(offsetConfig: ScrollOffsetConfig): void;
622
630
  getPaginationScrollY(): number;
623
631
  destroy(): void;
624
632
  setScrollOffset: (scrollOffset: ScrollOffset_2) => void;
@@ -644,10 +652,9 @@ declare abstract class BaseFacet {
644
652
  };
645
653
  getRealHeight: () => number;
646
654
  clearAllGroup(): void;
647
- scrollWithAnimation: (offsetConfig?: OffsetConfig, duration?: number, cb?: () => void) => void;
648
- scrollImmediately: (offsetConfig?: OffsetConfig) => void;
655
+ scrollWithAnimation: (offsetConfig?: ScrollOffsetConfig, duration?: number, cb?: () => void) => void;
656
+ scrollImmediately: (offsetConfig?: ScrollOffsetConfig) => void;
649
657
  /**
650
- *
651
658
  * @param skipScrollEvent 不触发 S2Event.GLOBAL_SCROLL
652
659
  */
653
660
  startScroll: (skipScrollEvent?: boolean) => void;
@@ -735,10 +742,7 @@ declare abstract class BaseFacet {
735
742
  };
736
743
  updatePanelScrollGroup(): void;
737
744
  /**
738
- *
739
- * @param skipScrollEvent: 如true则不触发GLOBAL_SCROLL事件
740
- * During scroll behavior, first call to this method fires immediately and then on interval.
741
- * @protected
745
+ * @param skipScrollEvent: 不触发 GLOBAL_SCROLL 事件
742
746
  */
743
747
  protected dynamicRenderCell(skipScrollEvent?: boolean): void;
744
748
  private emitScrollEvent;
@@ -907,11 +911,11 @@ declare abstract class BaseFacet {
907
911
  /**
908
912
  * 获取行头单元格 (不含可视区域)
909
913
  */
910
- getRowCells(): RowCell[];
914
+ getRowCells(): RowCell_2[];
911
915
  /**
912
916
  * 获取行头叶子节点单元格 (不含可视区域)
913
917
  */
914
- getRowLeafCells(): RowCell[];
918
+ getRowLeafCells(): RowCell_2[];
915
919
  /**
916
920
  * 获取列头单元格 (不含可视区域)
917
921
  */
@@ -956,6 +960,12 @@ declare abstract class BaseFacet {
956
960
  getCells(cellIds?: string[]): S2CellType_2<ViewMeta_2>[];
957
961
  getInitColLeafNodes(): Node_2_2[];
958
962
  clearInitColLeafNodes(): void;
963
+ /**
964
+ * @tip 和 this.spreadsheet.measureTextWidth() 的区别在于:
965
+ * 1. 额外添加一像素余量,防止 maxLabel 有多个同样长度情况下,一些 label 不能展示完全, 出现省略号
966
+ * 2. 测量时, 文本宽度向上取整, 避免子像素的不一致性
967
+ */
968
+ protected measureTextWidth(text: SimpleData, font: unknown): number;
959
969
  }
960
970
 
961
971
  declare interface BaseFields {
@@ -1190,7 +1200,8 @@ rowCellMouseMove: (data: TargetCellInfo) => void;
1190
1200
  rowCellCollapsed: (params: RowCellCollapsedParams) => void;
1191
1201
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
1192
1202
  rowCellScroll: (position: Required<ScrollOffset>) => void;
1193
- rowCellRender: (cell: ColCell) => void;
1203
+ rowCellRender: (cell: RowCell) => void;
1204
+ rowCellSelected: CellSelectedHandler;
1194
1205
  colCellHover: (data: TargetCellInfo) => void;
1195
1206
  colCellClick: (data: TargetCellInfo) => void;
1196
1207
  colCellDoubleClick: (data: TargetCellInfo) => void;
@@ -1204,6 +1215,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo;
1204
1215
  hiddenColumnsDetail: HiddenColumnsInfo[];
1205
1216
  }) => void;
1206
1217
  colCellRender: (cell: ColCell) => void;
1218
+ colCellSelected: CellSelectedHandler;
1207
1219
  dataCellHover: (data: TargetCellInfo) => void;
1208
1220
  dataCellClick: (data: TargetCellInfo) => void;
1209
1221
  dataCellDoubleClick: (data: TargetCellInfo) => void;
@@ -1216,6 +1228,7 @@ dataCellSelectMove: (metaList: ViewMetaData[]) => void;
1216
1228
  dataCellRender: (cell: DataCell) => void;
1217
1229
  dataCellEditStart: (meta: ViewMeta, cell: TableDataCell) => void;
1218
1230
  dataCellEditEnd: (meta: ViewMeta, cell: TableDataCell) => void;
1231
+ dataCellSelected: CellSelectedHandler;
1219
1232
  cornerCellHover: (data: TargetCellInfo) => void;
1220
1233
  cornerCellClick: (data: TargetCellInfo) => void;
1221
1234
  cornerCellDoubleClick: (data: TargetCellInfo) => void;
@@ -1224,6 +1237,7 @@ cornerCellMouseDown: (data: TargetCellInfo) => void;
1224
1237
  cornerCellMouseUp: (data: TargetCellInfo) => void;
1225
1238
  cornerCellMouseMove: (data: TargetCellInfo) => void;
1226
1239
  cornerCellRender: (cell: CornerCell) => void;
1240
+ cornerCellSelected: CellSelectedHandler;
1227
1241
  mergedCellsHover: (data: TargetCellInfo) => void;
1228
1242
  mergedCellsClick: (data: TargetCellInfo) => void;
1229
1243
  mergedCellsDoubleClick: (data: TargetCellInfo) => void;
@@ -1282,7 +1296,7 @@ mouseHover: (event: GEvent) => void;
1282
1296
  mouseUp: (event: MouseEvent) => void;
1283
1297
  mouseDown: (event: MouseEvent) => void;
1284
1298
  mouseMove: (event: MouseEvent) => void;
1285
- selected: (cells: S2CellType[]) => void;
1299
+ selected: CellSelectedHandler;
1286
1300
  reset: (event: KeyboardEvent) => void;
1287
1301
  linkFieldJump: (data: {
1288
1302
  field: string;
@@ -1336,7 +1350,8 @@ onRowCellMouseMove?: (data: TargetCellInfo) => any;
1336
1350
  onRowCellCollapsed?: (params: RowCellCollapsedParams) => any;
1337
1351
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
1338
1352
  onRowCellScroll?: (position: Required<ScrollOffset>) => any;
1339
- onRowCellRender?: (cell: ColCell) => any;
1353
+ onRowCellRender?: (cell: RowCell) => any;
1354
+ onRowCellSelected?: (cells: S2CellType<ViewMeta>[], detail: CellSelectedDetail) => any;
1340
1355
  onColCellHover?: (data: TargetCellInfo) => any;
1341
1356
  onColCellClick?: (data: TargetCellInfo) => any;
1342
1357
  onColCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -1350,6 +1365,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo;
1350
1365
  hiddenColumnsDetail: HiddenColumnsInfo[];
1351
1366
  }) => any;
1352
1367
  onColCellRender?: (cell: ColCell) => any;
1368
+ onColCellSelected?: (cells: S2CellType<ViewMeta>[], detail: CellSelectedDetail) => any;
1353
1369
  onDataCellHover?: (data: TargetCellInfo) => any;
1354
1370
  onDataCellClick?: (data: TargetCellInfo) => any;
1355
1371
  onDataCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -1362,6 +1378,7 @@ onDataCellSelectMove?: (metaList: ViewMetaData[]) => any;
1362
1378
  onDataCellRender?: (cell: DataCell) => any;
1363
1379
  onDataCellEditStart?: (meta: ViewMeta, cell: TableDataCell) => any;
1364
1380
  onDataCellEditEnd?: (meta: ViewMeta, cell: TableDataCell) => any;
1381
+ onDataCellSelected?: (cells: S2CellType<ViewMeta>[], detail: CellSelectedDetail) => any;
1365
1382
  onCornerCellHover?: (data: TargetCellInfo) => any;
1366
1383
  onCornerCellClick?: (data: TargetCellInfo) => any;
1367
1384
  onCornerCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -1370,6 +1387,7 @@ onCornerCellMouseDown?: (data: TargetCellInfo) => any;
1370
1387
  onCornerCellMouseUp?: (data: TargetCellInfo) => any;
1371
1388
  onCornerCellMouseMove?: (data: TargetCellInfo) => any;
1372
1389
  onCornerCellRender?: (cell: CornerCell) => any;
1390
+ onCornerCellSelected?: (cells: S2CellType<ViewMeta>[], detail: CellSelectedDetail) => any;
1373
1391
  onMergedCellsHover?: (data: TargetCellInfo) => any;
1374
1392
  onMergedCellsClick?: (data: TargetCellInfo) => any;
1375
1393
  onMergedCellsDoubleClick?: (data: TargetCellInfo) => any;
@@ -1428,7 +1446,7 @@ onMouseHover?: (event: GEvent) => any;
1428
1446
  onMouseUp?: (event: MouseEvent) => any;
1429
1447
  onMouseDown?: (event: MouseEvent) => any;
1430
1448
  onMouseMove?: (event: MouseEvent) => any;
1431
- onSelected?: (cells: S2CellType[]) => any;
1449
+ onSelected?: (cells: S2CellType<ViewMeta>[], detail: CellSelectedDetail) => any;
1432
1450
  onReset?: (event: KeyboardEvent) => any;
1433
1451
  onLinkFieldJump?: (data: {
1434
1452
  field: string;
@@ -1478,7 +1496,8 @@ declare interface BaseSheetComponentProps<PartialDrillDown = PartDrillDown, Head
1478
1496
  onRowCellCollapsed?: (params: RowCellCollapsedParams) => void;
1479
1497
  onRowCellAllCollapsed?: (isCollapsed: boolean) => void;
1480
1498
  onRowCellScroll?: (position: CellScrollPosition) => void;
1481
- onRowCellRender?: (cell: ColCell) => void;
1499
+ onRowCellRender?: (cell: RowCell) => void;
1500
+ onRowCellSelected?: CellSelectedHandler;
1482
1501
  onColCellHover?: (data: TargetCellInfo) => void;
1483
1502
  onColCellClick?: (data: TargetCellInfo) => void;
1484
1503
  onColCellDoubleClick?: (data: TargetCellInfo) => void;
@@ -1492,6 +1511,7 @@ declare interface BaseSheetComponentProps<PartialDrillDown = PartDrillDown, Head
1492
1511
  hiddenColumnsDetail: HiddenColumnsInfo[];
1493
1512
  }) => void;
1494
1513
  onColCellRender?: (cell: ColCell) => void;
1514
+ onColCellSelected?: CellSelectedHandler;
1495
1515
  onDataCellHover?: (data: TargetCellInfo) => void;
1496
1516
  onDataCellClick?: (data: TargetCellInfo) => void;
1497
1517
  onDataCellDoubleClick?: (data: TargetCellInfo) => void;
@@ -1504,6 +1524,7 @@ declare interface BaseSheetComponentProps<PartialDrillDown = PartDrillDown, Head
1504
1524
  onDataCellRender?: (cell: DataCell) => void;
1505
1525
  onDataCellEditStart?: (meta: ViewMeta, cell: TableDataCell) => void;
1506
1526
  onDataCellEditEnd?: (meta: ViewMeta, cell: TableDataCell) => void;
1527
+ onDataCellSelected?: CellSelectedHandler;
1507
1528
  onCornerCellHover?: (data: TargetCellInfo) => void;
1508
1529
  onCornerCellClick?: (data: TargetCellInfo) => void;
1509
1530
  onCornerCellDoubleClick?: (data: TargetCellInfo) => void;
@@ -1512,6 +1533,7 @@ declare interface BaseSheetComponentProps<PartialDrillDown = PartDrillDown, Head
1512
1533
  onCornerCellMouseUp?: (data: TargetCellInfo) => void;
1513
1534
  onCornerCellMouseMove?: (data: TargetCellInfo) => void;
1514
1535
  onCornerCellRender?: (cell: CornerCell) => void;
1536
+ onCornerCellSelected?: CellSelectedHandler;
1515
1537
  onMergedCellsHover?: (data: TargetCellInfo) => void;
1516
1538
  onMergedCellsClick?: (data: TargetCellInfo) => void;
1517
1539
  onMergedCellsDoubleClick?: (data: TargetCellInfo) => void;
@@ -1571,7 +1593,7 @@ declare interface BaseSheetComponentProps<PartialDrillDown = PartDrillDown, Head
1571
1593
  onMouseUp?: (event: MouseEvent) => void;
1572
1594
  onMouseDown?: (event: MouseEvent) => void;
1573
1595
  onMouseMove?: (event: MouseEvent) => void;
1574
- onSelected?: (cells: S2CellType[]) => void;
1596
+ onSelected?: CellSelectedHandler;
1575
1597
  onReset?: (event: KeyboardEvent) => void;
1576
1598
  onLinkFieldJump?: (data: {
1577
1599
  field: string;
@@ -1719,20 +1741,22 @@ declare interface BulletValue {
1719
1741
  }
1720
1742
 
1721
1743
  declare interface CalcTotals {
1722
- /** 聚合方式 */
1744
+ /**
1745
+ * 聚合方式
1746
+ */
1723
1747
  aggregation?: `${Aggregation}`;
1724
1748
  /**
1725
1749
  * 自定义计算汇总
1726
1750
  * @see https://s2.antv.antgroup.com/examples/analysis/totals/#custom
1727
1751
  */
1728
- calcFunc?: (query: Query, data: CellData[]) => number;
1752
+ calcFunc?: (query: Query, data: CellData[], spreadsheet: SpreadSheet_2) => number;
1729
1753
  }
1730
1754
 
1731
1755
  declare type CanvasEventHandler = (event: FederatedPointerEvent) => void;
1732
1756
 
1733
- declare interface CellAppendInfo<T = Node_2_2> extends Partial<ResizeInfo_2> {
1757
+ declare interface CellAppendInfo<T = Node_2_2> extends Partial<Omit<ResizeInfo_2, 'meta'>> {
1734
1758
  isLinkFieldText?: boolean;
1735
- cellData?: T;
1759
+ meta?: T;
1736
1760
  }
1737
1761
 
1738
1762
  declare enum CellBorderPosition {
@@ -1770,8 +1794,8 @@ declare enum CellClipBox {
1770
1794
  declare type CellCustomSize = null | undefined | number | ((node: Node_2_2 | null) => number | null);
1771
1795
 
1772
1796
  declare class CellData {
1773
- private raw;
1774
- private extraField;
1797
+ readonly raw: RawData_2;
1798
+ readonly extraField: string;
1775
1799
  constructor(raw: RawData_2, extraField: string);
1776
1800
  static getCellData(raw: RawData_2, extraField: string): CellData;
1777
1801
  static getCellDataList(raw: RawData_2, extraFields: string[]): CellData[];
@@ -1805,6 +1829,30 @@ declare interface CellScrollOffset {
1805
1829
 
1806
1830
  declare type CellScrollPosition_2 = Required<ScrollOffset_2>;
1807
1831
 
1832
+ declare interface CellScrollToOptions {
1833
+ /**
1834
+ * 是否展示滚动动画
1835
+ */
1836
+ animate?: boolean;
1837
+ /**
1838
+ * 是否触发滚动事件
1839
+ */
1840
+ skipScrollEvent?: boolean;
1841
+ }
1842
+
1843
+ declare interface CellSelectedDetail_2 {
1844
+ /**
1845
+ * 触发选中的交互名
1846
+ */
1847
+ interactionName?: `${InteractionName}`;
1848
+ /**
1849
+ * 触发选中的单元格
1850
+ */
1851
+ targetCell?: S2CellType_2 | null;
1852
+ }
1853
+
1854
+ declare type CellSelectedHandler_2 = (cells: S2CellType_2[], detail: CellSelectedDetail_2) => void;
1855
+
1808
1856
  declare interface CellTextWordWrapStyle extends Pick<TextStyleProps, 'wordWrap' | 'maxLines' | 'textOverflow'> {
1809
1857
  }
1810
1858
 
@@ -1848,6 +1896,30 @@ declare enum CellType {
1848
1896
  MERGED_CELL = "mergedCell"
1849
1897
  }
1850
1898
 
1899
+ declare interface ChangeCellOptions extends CellScrollToOptions {
1900
+ /**
1901
+ * 目标单元格
1902
+ */
1903
+ cell: S2CellType_2<ViewMeta_2>;
1904
+ /**
1905
+ * 是否是多选
1906
+ */
1907
+ isMultiSelection?: boolean;
1908
+ /**
1909
+ * 状态名 (默认 `selected`)
1910
+ */
1911
+ stateName?: `${InteractionStateName}`;
1912
+ /**
1913
+ * 交互名
1914
+ */
1915
+ interactionName?: `${InteractionName}`;
1916
+ /**
1917
+ * 如果单元格不在可视范围, 是否自动滚动
1918
+ * @default true
1919
+ */
1920
+ scrollIntoView?: boolean;
1921
+ }
1922
+
1851
1923
  declare class ColCell_2 extends HeaderCell<ColHeaderConfig> {
1852
1924
  get cellType(): CellType;
1853
1925
  protected getBorderPositions(): CellBorderPosition[];
@@ -1938,7 +2010,7 @@ declare interface Condition<T = unknown> {
1938
2010
  mapping: ConditionMapping<T>;
1939
2011
  }
1940
2012
 
1941
- declare type ConditionMapping<T = unknown> = (fieldValue: number | string, data: RawData_2, cell?: DataCell_2 | HeaderCell) => ConditionMappingResult<T>;
2013
+ declare type ConditionMapping<T = unknown> = (fieldValue: number | string, data: RawData_2, cell: S2CellType_2) => ConditionMappingResult<T>;
1942
2014
 
1943
2015
  declare type ConditionMappingResult<T = unknown> = T | undefined | null;
1944
2016
 
@@ -2102,6 +2174,7 @@ declare interface CustomTreeNode {
2102
2174
  title?: string;
2103
2175
  /**
2104
2176
  * 是否收起(默认都展开)
2177
+ * @description 优先级 `collapseFields` > `expandDepth` > `collapseAll` > `collapsed`
2105
2178
  */
2106
2179
  collapsed?: boolean;
2107
2180
  /**
@@ -2157,8 +2230,8 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
2157
2230
  };
2158
2231
  };
2159
2232
  protected getBorderPositions(): CellBorderPosition[];
2160
- get valueRangeByField(): ValueRange;
2161
- protected handleByStateName(cells: CellMeta[], stateName: InteractionStateName): void;
2233
+ getValueRange(): ValueRange;
2234
+ protected handleByStateName(cells: CellMeta[], stateName: `${InteractionStateName}`): void;
2162
2235
  protected handleSearchResult(cells: CellMeta[]): void;
2163
2236
  protected handleSelect(cells: CellMeta[]): void;
2164
2237
  protected isDisableHover(cellMeta: CellMeta): boolean;
@@ -2186,13 +2259,13 @@ declare class DataCell_2 extends BaseCell<ViewMeta_2> {
2186
2259
  * Find current field related condition
2187
2260
  * @param conditions
2188
2261
  */
2189
- findFieldCondition<Con extends Condition>(conditions?: Con[]): Con | undefined;
2262
+ findFieldCondition<T extends Condition>(conditions?: T[]): T | undefined;
2190
2263
  /**
2191
2264
  * Mapping value to get condition related attrs
2192
2265
  * @param condition
2193
2266
  */
2194
2267
  mappingValue<Result>(condition: Condition<Result>): ConditionMappingResult<Result>;
2195
- updateByState(stateName: InteractionStateName): void;
2268
+ updateByState(stateName: `${InteractionStateName}`): void;
2196
2269
  clearUnselectedState(): void;
2197
2270
  private toggleConditionIntervalShapeOpacity;
2198
2271
  }
@@ -2228,7 +2301,7 @@ declare interface DataCellStyle extends CellTextWordWrapStyle {
2228
2301
  };
2229
2302
  }
2230
2303
 
2231
- declare type DataItem = SimpleData | MultiData | Record<string, unknown> | undefined | null;
2304
+ declare type DataItem = SimpleData | MultiData | Record<string, unknown>;
2232
2305
 
2233
2306
  declare type DataPath = (number | string | undefined)[];
2234
2307
 
@@ -2284,7 +2357,7 @@ declare interface EmitterType {
2284
2357
  [S2Event.GLOBAL_DOUBLE_CLICK]: CanvasEventHandler;
2285
2358
  [S2Event.GLOBAL_RESET]: EventHandler_2;
2286
2359
  [S2Event.GLOBAL_HOVER]: CanvasEventHandler;
2287
- [S2Event.GLOBAL_SELECTED]: SelectedHandler;
2360
+ [S2Event.GLOBAL_SELECTED]: CellSelectedHandler_2;
2288
2361
  [S2Event.GLOBAL_SCROLL]: (position: CellScrollPosition_2) => void;
2289
2362
  /** ================ Sort ================ */
2290
2363
  [S2Event.RANGE_SORT]: (info: SortParams_2) => void;
@@ -2294,7 +2367,7 @@ declare interface EmitterType {
2294
2367
  [S2Event.RANGE_FILTERED]: (data: RawData_2[]) => any;
2295
2368
  /** ================ Cell ================ */
2296
2369
  [S2Event.GLOBAL_LINK_FIELD_JUMP]: (data: {
2297
- cellData: Node_2_2;
2370
+ meta: Node_2_2 | ViewMeta_2;
2298
2371
  field: string;
2299
2372
  record: Data;
2300
2373
  }) => void;
@@ -2309,6 +2382,7 @@ declare interface EmitterType {
2309
2382
  [S2Event.DATA_CELL_BRUSH_SELECTION]: (cells: (DataCell_2 | CellMeta)[]) => void;
2310
2383
  [S2Event.DATA_CELL_SELECT_MOVE]: (metas: CellMeta[]) => void;
2311
2384
  [S2Event.DATA_CELL_RENDER]: (cell: DataCell_2) => void;
2385
+ [S2Event.DATA_CELL_SELECTED]: CellSelectedHandler_2;
2312
2386
  /** ================ Row Cell ================ */
2313
2387
  [S2Event.ROW_CELL_MOUSE_DOWN]: CanvasEventHandler;
2314
2388
  [S2Event.ROW_CELL_MOUSE_MOVE]: CanvasEventHandler;
@@ -2318,12 +2392,13 @@ declare interface EmitterType {
2318
2392
  [S2Event.ROW_CELL_CONTEXT_MENU]: CanvasEventHandler;
2319
2393
  [S2Event.ROW_CELL_MOUSE_UP]: CanvasEventHandler;
2320
2394
  [S2Event.ROW_CELL_SCROLL]: (position: CellScrollPosition_2) => void;
2321
- [S2Event.ROW_CELL_BRUSH_SELECTION]: (cells: RowCell[]) => void;
2395
+ [S2Event.ROW_CELL_BRUSH_SELECTION]: (cells: RowCell_2[]) => void;
2322
2396
  [S2Event.ROW_CELL_COLLAPSED]: (data: RowCellCollapsedParams_2) => void;
2323
2397
  [S2Event.ROW_CELL_COLLAPSED__PRIVATE]: (data: RowCellCollapsedParams_2) => void;
2324
2398
  [S2Event.ROW_CELL_ALL_COLLAPSED]: (isCollapsed: boolean) => void;
2325
2399
  [S2Event.ROW_CELL_ALL_COLLAPSED__PRIVATE]: (isCollapsed: boolean) => void;
2326
- [S2Event.ROW_CELL_RENDER]: (cell: RowCell) => void;
2400
+ [S2Event.ROW_CELL_RENDER]: (cell: RowCell_2) => void;
2401
+ [S2Event.ROW_CELL_SELECTED]: CellSelectedHandler_2;
2327
2402
  /** ================ Col Cell ================ */
2328
2403
  [S2Event.COL_CELL_MOUSE_DOWN]: CanvasEventHandler;
2329
2404
  [S2Event.COL_CELL_MOUSE_MOVE]: CanvasEventHandler;
@@ -2336,6 +2411,7 @@ declare interface EmitterType {
2336
2411
  [S2Event.COL_CELL_EXPANDED]: (expandedNode: Node_2_2) => void;
2337
2412
  [S2Event.COL_CELL_HIDDEN]: (currentHiddenColumnsInfo: HiddenColumnsInfo_2, hiddenColumnsDetail: HiddenColumnsInfo_2[]) => void;
2338
2413
  [S2Event.COL_CELL_RENDER]: (cell: ColCell_2) => void;
2414
+ [S2Event.COL_CELL_SELECTED]: CellSelectedHandler_2;
2339
2415
  /** ================ Corner Cell ================ */
2340
2416
  [S2Event.CORNER_CELL_MOUSE_MOVE]: CanvasEventHandler;
2341
2417
  [S2Event.CORNER_CELL_MOUSE_DOWN]: CanvasEventHandler;
@@ -2345,6 +2421,7 @@ declare interface EmitterType {
2345
2421
  [S2Event.CORNER_CELL_CONTEXT_MENU]: CanvasEventHandler;
2346
2422
  [S2Event.CORNER_CELL_MOUSE_UP]: CanvasEventHandler;
2347
2423
  [S2Event.CORNER_CELL_RENDER]: (cell: CornerCell_2) => void;
2424
+ [S2Event.CORNER_CELL_SELECTED]: CellSelectedHandler_2;
2348
2425
  /** ================ Merged Cells ================ */
2349
2426
  [S2Event.MERGED_CELLS_MOUSE_DOWN]: CanvasEventHandler;
2350
2427
  [S2Event.MERGED_CELLS_MOUSE_MOVE]: CanvasEventHandler;
@@ -2403,7 +2480,7 @@ declare class EventController {
2403
2480
  canvasMousemoveEvent: FederatedPointerEvent;
2404
2481
  constructor(spreadsheet: SpreadSheet_2);
2405
2482
  get canvasContainer(): Canvas;
2406
- get isAutoResetSheetStyle(): boolean | undefined;
2483
+ isAutoResetSheetStyle(event: Event | FederatedPointerEvent): boolean | undefined;
2407
2484
  bindEvents(): void;
2408
2485
  private isGuiIconShape;
2409
2486
  private isConditionIconShape;
@@ -2474,6 +2551,8 @@ declare interface Fields extends BaseFields {
2474
2551
  customValueOrder?: number;
2475
2552
  }
2476
2553
 
2554
+ declare type FieldValue = string | TotalClass | TotalMeasure;
2555
+
2477
2556
  declare interface FilterParam {
2478
2557
  filterKey: string;
2479
2558
  filteredValues?: unknown[];
@@ -2481,7 +2560,7 @@ declare interface FilterParam {
2481
2560
  }
2482
2561
 
2483
2562
  declare interface FormatResult {
2484
- formattedValue: string;
2563
+ formattedValue: SimpleData;
2485
2564
  value: DataItem;
2486
2565
  }
2487
2566
 
@@ -2491,10 +2570,12 @@ declare interface FormatResult {
2491
2570
  * 2. copy/export
2492
2571
  * 3. tooltip, 且仅在选择多个单元格时,data 类型为数组
2493
2572
  */
2494
- declare type Formatter = (v: unknown, data?: SimpleData | ViewMetaData_2 | ViewMetaData_2[], meta?: Node_2_2 | ViewMeta_2) => string;
2573
+ declare type Formatter = (value: DataItem, data?: DataItem | ViewMetaData_2 | ViewMetaData_2[], meta?: Node_2_2 | ViewMeta_2 | null | undefined) => SimpleData;
2495
2574
 
2496
2575
  declare class Frame extends Group {
2497
2576
  cfg: FrameConfig;
2577
+ cornerRightBorder: Line;
2578
+ cornerBottomBorder: Line;
2498
2579
  constructor(cfg: FrameConfig);
2499
2580
  layout(): void;
2500
2581
  /**
@@ -2651,11 +2732,18 @@ declare interface GuiIconCfg extends Omit<ImageStyleProps, 'fill'> {
2651
2732
  readonly fill?: string | null;
2652
2733
  }
2653
2734
 
2735
+ /**
2736
+ * 基于 Canvas 的高清适配方案
2737
+ * 1. 双屏切换, devicePixelRatio 变化时
2738
+ * 2. Mac 触控板缩放
2739
+ * 3. 浏览器窗口缩放
2740
+ */
2654
2741
  declare class HdAdapter {
2655
2742
  private viewport;
2656
2743
  private devicePixelRatioMedia;
2657
2744
  private spreadsheet;
2658
2745
  private isDevicePixelRatioChange;
2746
+ private zoomOffsetLeft;
2659
2747
  constructor(spreadsheet: SpreadSheet_2);
2660
2748
  init: () => void;
2661
2749
  destroy: () => void;
@@ -2668,6 +2756,9 @@ declare class HdAdapter {
2668
2756
  * @see https://github.com/antvis/S2/issues/2072
2669
2757
  */
2670
2758
  private renderByZoomScaleWithoutResizeEffect;
2759
+ /**
2760
+ * 如果是浏览器窗口的放大缩小 (command +/-), 也会触发
2761
+ */
2671
2762
  private renderByDevicePixelRatioChanged;
2672
2763
  private renderByDevicePixelRatio;
2673
2764
  private renderByZoomScale;
@@ -2768,7 +2859,7 @@ declare abstract class HeaderCell<T extends BaseHeaderConfig = BaseHeaderConfig>
2768
2859
  protected addActionIcon(options: HeaderActionIconOptions): void;
2769
2860
  protected drawActionAndConditionIcons(): void;
2770
2861
  protected isSortCell(): boolean;
2771
- protected handleByStateName(cells: CellMeta[], stateName: InteractionStateName): void;
2862
+ protected handleByStateName(cells: CellMeta[], stateName: `${InteractionStateName}`): void;
2772
2863
  protected handleSearchResult(cells: CellMeta[]): void;
2773
2864
  protected handleHover(cells: CellMeta[]): void;
2774
2865
  protected handleSelect(cells: CellMeta[], nodes?: Node_2_2[]): void;
@@ -2784,11 +2875,11 @@ declare abstract class HeaderCell<T extends BaseHeaderConfig = BaseHeaderConfig>
2784
2875
  toggleActionIcon(id: string): void;
2785
2876
  protected getIconPosition(): PointLike;
2786
2877
  update(): void;
2787
- updateByState(stateName: InteractionStateName): void;
2878
+ updateByState(stateName: `${InteractionStateName}`): void;
2788
2879
  hideInteractionShape(): void;
2789
2880
  isMeasureField(): boolean;
2790
2881
  mappingValue<Result>(condition: Condition<Result>): ConditionMappingResult<Result>;
2791
- findFieldCondition<Con extends Condition>(conditions?: Con[]): Con | undefined;
2882
+ findFieldCondition<T extends Condition>(conditions?: T[]): T | undefined;
2792
2883
  getTreeIcon(): GuiIcon | undefined;
2793
2884
  getActionIcons(): GuiIcon[];
2794
2885
  }
@@ -2879,18 +2970,47 @@ declare interface IconTheme {
2879
2970
  declare type Indexes = [number, number, number, number];
2880
2971
 
2881
2972
  declare interface InteractionCellHighlightOptions {
2882
- /** 高亮行头 */
2973
+ /**
2974
+ * 高亮行头
2975
+ */
2883
2976
  rowHeader?: boolean;
2884
- /** 高亮列头 */
2977
+ /**
2978
+ * 高亮列头
2979
+ */
2885
2980
  colHeader?: boolean;
2886
- /** 高亮选中单元格所在行 */
2981
+ /**
2982
+ * 高亮选中单元格所在行
2983
+ */
2887
2984
  currentRow?: boolean;
2888
- /** 高亮选中单元格所在列 */
2985
+ /**
2986
+ * 高亮选中单元格所在列
2987
+ */
2889
2988
  currentCol?: boolean;
2890
2989
  }
2891
2990
 
2892
2991
  declare type InteractionConstructor = new (spreadsheet: SpreadSheet_2) => BaseEvent;
2893
2992
 
2993
+ declare enum InteractionName {
2994
+ CORNER_CELL_CLICK = "cornerCellClick",
2995
+ DATA_CELL_CLICK = "dataCellClick",
2996
+ ROW_CELL_CLICK = "rowCellClick",
2997
+ COL_CELL_CLICK = "colCellClick",
2998
+ MERGED_CELLS_CLICK = "mergedCellsClick",
2999
+ ROW_COLUMN_CLICK = "rowColumnClick",
3000
+ HEADER_CELL_LINK_CLICK = "headerCellLinkClick",
3001
+ HOVER = "hover",
3002
+ DATA_CELL_BRUSH_SELECTION = "dataCellBrushSelection",
3003
+ ROW_CELL_BRUSH_SELECTION = "rowCellBrushSelection",
3004
+ COL_CELL_BRUSH_SELECTION = "colCellBrushSelection",
3005
+ COL_ROW_RESIZE = "rowColResize",
3006
+ DATA_CELL_MULTI_SELECTION = "dataCellMultiSelection",
3007
+ ROW_CELL_MULTI_SELECTION = "rowCellMultiSelection",
3008
+ COL_CELL_MULTI_SELECTION = "colCellMultiSelection",
3009
+ RANGE_SELECTION = "rangeSelection",
3010
+ SELECTED_CELL_MOVE = "selectedCellMove",
3011
+ GLOBAL_RESET = "globalReset"
3012
+ }
3013
+
2894
3014
  declare interface InteractionOptions {
2895
3015
  /**
2896
3016
  * 链接跳转
@@ -2934,10 +3054,11 @@ declare interface InteractionOptions {
2934
3054
  customTransformer?: (transformer: Transformer_2) => Partial<Transformer_2>;
2935
3055
  };
2936
3056
  /**
2937
- * 自动重置表格样式 (按下 ESC 键, 点击空白区域时, 关闭 tooltip/交互状态)
3057
+ * 自动重置表格样式 (按下 ESC 键, 点击空白区域时, 关闭 tooltip/交互状态), 支持根据 event 动态判断
2938
3058
  * @see https://s2.antv.antgroup.com/examples/interaction/basic/#auto-reset-sheet-style
3059
+ * @example autoResetSheetStyle: (event, spreadsheet) => event.target instanceof HTMLDivElement
2939
3060
  */
2940
- autoResetSheetStyle?: boolean;
3061
+ autoResetSheetStyle?: boolean | ((event: Event | FederatedPointerEvent, spreadsheet: SpreadSheet_2) => boolean);
2941
3062
  /**
2942
3063
  * 隐藏列头配置, 支持维度 (S2DataConfig.fields) 和具体维值 (id)
2943
3064
  * @example hiddenColumnFields: ['type', 'subType'];
@@ -3018,7 +3139,7 @@ declare interface InteractionStateInfo {
3018
3139
  /**
3019
3140
  * 交互状态名
3020
3141
  */
3021
- stateName?: InteractionStateName;
3142
+ stateName?: `${InteractionStateName}`;
3022
3143
  /**
3023
3144
  * 单元格元数据 (包含不在可视范围内的)
3024
3145
  */
@@ -3118,7 +3239,7 @@ declare type KeyboardEventHandler = (event: KeyboardEvent) => void;
3118
3239
  /**
3119
3240
  * determine the order of every row/column tree branch
3120
3241
  */
3121
- declare type LayoutArrange = (spreadsheet: SpreadSheet_2, parent: Node_2_2, field: string, fieldValues: string[]) => string[];
3242
+ declare type LayoutArrange = (spreadsheet: SpreadSheet_2, parent: Node_2_2, field: string, fieldValues: FieldValue[]) => string[];
3122
3243
 
3123
3244
  /**
3124
3245
  * determine the data of cells in Cartesian coordinates
@@ -3254,9 +3375,13 @@ declare interface MergedCellStyle extends CellTextWordWrapStyle {
3254
3375
 
3255
3376
  declare interface Meta {
3256
3377
  /**
3257
- * 字段 id
3378
+ * 字段名
3379
+ * @example
3380
+ 1. 'city'
3381
+ 2. ['city', 'type']
3382
+ 3. /^city/
3258
3383
  */
3259
- field?: string;
3384
+ field?: string | string[] | RegExp;
3260
3385
  /**
3261
3386
  * 字段名称
3262
3387
  */
@@ -3269,6 +3394,7 @@ declare interface Meta {
3269
3394
  * 格式化
3270
3395
  * 数值字段:一般用于格式化数字单位
3271
3396
  * 文本字段:一般用于做字段枚举值的别名
3397
+ * @see https://s2.antv.antgroup.com/manual/basic/formatter
3272
3398
  */
3273
3399
  formatter?: Formatter;
3274
3400
  }
@@ -3420,21 +3546,6 @@ declare class Node_2_2 {
3420
3546
  get isFrozen(): boolean | undefined;
3421
3547
  }
3422
3548
 
3423
- declare interface OffsetConfig {
3424
- rowHeaderOffsetX?: {
3425
- value: number | undefined;
3426
- animate?: boolean;
3427
- };
3428
- offsetX?: {
3429
- value: number | undefined;
3430
- animate?: boolean;
3431
- };
3432
- offsetY?: {
3433
- value: number | undefined;
3434
- animate?: boolean;
3435
- };
3436
- }
3437
-
3438
3549
  declare type OnUpdateCells = (root: RootInteraction, defaultOnUpdateCells: () => void) => void;
3439
3550
 
3440
3551
  declare const ORIGIN_FIELD = "$$origin$$";
@@ -3592,7 +3703,8 @@ rowCellMouseMove: (data: TargetCellInfo) => void;
3592
3703
  rowCellCollapsed: (params: RowCellCollapsedParams) => void;
3593
3704
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
3594
3705
  rowCellScroll: (position: Required<ScrollOffset>) => void;
3595
- rowCellRender: (cell: ColCell) => void;
3706
+ rowCellRender: (cell: RowCell) => void;
3707
+ rowCellSelected: CellSelectedHandler;
3596
3708
  colCellHover: (data: TargetCellInfo) => void;
3597
3709
  colCellClick: (data: TargetCellInfo) => void;
3598
3710
  colCellDoubleClick: (data: TargetCellInfo) => void;
@@ -3606,6 +3718,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo;
3606
3718
  hiddenColumnsDetail: HiddenColumnsInfo[];
3607
3719
  }) => void;
3608
3720
  colCellRender: (cell: ColCell) => void;
3721
+ colCellSelected: CellSelectedHandler;
3609
3722
  dataCellHover: (data: TargetCellInfo) => void;
3610
3723
  dataCellClick: (data: TargetCellInfo) => void;
3611
3724
  dataCellDoubleClick: (data: TargetCellInfo) => void;
@@ -3618,6 +3731,7 @@ dataCellSelectMove: (metaList: ViewMetaData[]) => void;
3618
3731
  dataCellRender: (cell: DataCell) => void;
3619
3732
  dataCellEditStart: (meta: ViewMeta, cell: TableDataCell) => void;
3620
3733
  dataCellEditEnd: (meta: ViewMeta, cell: TableDataCell) => void;
3734
+ dataCellSelected: CellSelectedHandler;
3621
3735
  cornerCellHover: (data: TargetCellInfo) => void;
3622
3736
  cornerCellClick: (data: TargetCellInfo) => void;
3623
3737
  cornerCellDoubleClick: (data: TargetCellInfo) => void;
@@ -3626,6 +3740,7 @@ cornerCellMouseDown: (data: TargetCellInfo) => void;
3626
3740
  cornerCellMouseUp: (data: TargetCellInfo) => void;
3627
3741
  cornerCellMouseMove: (data: TargetCellInfo) => void;
3628
3742
  cornerCellRender: (cell: CornerCell) => void;
3743
+ cornerCellSelected: CellSelectedHandler;
3629
3744
  mergedCellsHover: (data: TargetCellInfo) => void;
3630
3745
  mergedCellsClick: (data: TargetCellInfo) => void;
3631
3746
  mergedCellsDoubleClick: (data: TargetCellInfo) => void;
@@ -3684,7 +3799,7 @@ mouseHover: (event: GEvent) => void;
3684
3799
  mouseUp: (event: MouseEvent) => void;
3685
3800
  mouseDown: (event: MouseEvent) => void;
3686
3801
  mouseMove: (event: MouseEvent) => void;
3687
- selected: (cells: S2CellType[]) => void;
3802
+ selected: CellSelectedHandler;
3688
3803
  reset: (event: KeyboardEvent) => void;
3689
3804
  linkFieldJump: (data: {
3690
3805
  field: string;
@@ -3738,7 +3853,8 @@ onRowCellMouseMove?: (data: TargetCellInfo) => any;
3738
3853
  onRowCellCollapsed?: (params: RowCellCollapsedParams) => any;
3739
3854
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
3740
3855
  onRowCellScroll?: (position: Required<ScrollOffset>) => any;
3741
- onRowCellRender?: (cell: ColCell) => any;
3856
+ onRowCellRender?: (cell: RowCell) => any;
3857
+ onRowCellSelected?: (cells: S2CellType<ViewMeta>[], detail: CellSelectedDetail) => any;
3742
3858
  onColCellHover?: (data: TargetCellInfo) => any;
3743
3859
  onColCellClick?: (data: TargetCellInfo) => any;
3744
3860
  onColCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -3752,6 +3868,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo;
3752
3868
  hiddenColumnsDetail: HiddenColumnsInfo[];
3753
3869
  }) => any;
3754
3870
  onColCellRender?: (cell: ColCell) => any;
3871
+ onColCellSelected?: (cells: S2CellType<ViewMeta>[], detail: CellSelectedDetail) => any;
3755
3872
  onDataCellHover?: (data: TargetCellInfo) => any;
3756
3873
  onDataCellClick?: (data: TargetCellInfo) => any;
3757
3874
  onDataCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -3764,6 +3881,7 @@ onDataCellSelectMove?: (metaList: ViewMetaData[]) => any;
3764
3881
  onDataCellRender?: (cell: DataCell) => any;
3765
3882
  onDataCellEditStart?: (meta: ViewMeta, cell: TableDataCell) => any;
3766
3883
  onDataCellEditEnd?: (meta: ViewMeta, cell: TableDataCell) => any;
3884
+ onDataCellSelected?: (cells: S2CellType<ViewMeta>[], detail: CellSelectedDetail) => any;
3767
3885
  onCornerCellHover?: (data: TargetCellInfo) => any;
3768
3886
  onCornerCellClick?: (data: TargetCellInfo) => any;
3769
3887
  onCornerCellDoubleClick?: (data: TargetCellInfo) => any;
@@ -3772,6 +3890,7 @@ onCornerCellMouseDown?: (data: TargetCellInfo) => any;
3772
3890
  onCornerCellMouseUp?: (data: TargetCellInfo) => any;
3773
3891
  onCornerCellMouseMove?: (data: TargetCellInfo) => any;
3774
3892
  onCornerCellRender?: (cell: CornerCell) => any;
3893
+ onCornerCellSelected?: (cells: S2CellType<ViewMeta>[], detail: CellSelectedDetail) => any;
3775
3894
  onMergedCellsHover?: (data: TargetCellInfo) => any;
3776
3895
  onMergedCellsClick?: (data: TargetCellInfo) => any;
3777
3896
  onMergedCellsDoubleClick?: (data: TargetCellInfo) => any;
@@ -3830,7 +3949,7 @@ onMouseHover?: (event: GEvent) => any;
3830
3949
  onMouseUp?: (event: MouseEvent) => any;
3831
3950
  onMouseDown?: (event: MouseEvent) => any;
3832
3951
  onMouseMove?: (event: MouseEvent) => any;
3833
- onSelected?: (cells: S2CellType[]) => any;
3952
+ onSelected?: (cells: S2CellType<ViewMeta>[], detail: CellSelectedDetail) => any;
3834
3953
  onReset?: (event: KeyboardEvent) => any;
3835
3954
  onLinkFieldJump?: (data: {
3836
3955
  field: string;
@@ -4010,39 +4129,221 @@ declare class RootInteraction {
4010
4129
  spreadsheet: SpreadSheet_2;
4011
4130
  interactions: Map<string, BaseEvent>;
4012
4131
  intercepts: Set<Intercept>;
4132
+ /**
4133
+ * hover有 keep-hover 态,是个计时器,hover后 800毫秒还在当前 cell 的情况下,该 cell 进入 keep-hover 状态
4134
+ * 在任何触发点击,或者点击空白区域时,说明已经不是 hover了,因此需要取消这个计时器。
4135
+ */
4013
4136
  private hoverTimer;
4014
4137
  eventController: EventController;
4015
4138
  private defaultState;
4016
4139
  constructor(spreadsheet: SpreadSheet_2);
4140
+ /**
4141
+ * 销毁交互
4142
+ * @example s2.interaction.destroy()
4143
+ */
4017
4144
  destroy(): void;
4145
+ /**
4146
+ * 重置交互
4147
+ * @example s2.interaction.reset()
4148
+ */
4018
4149
  reset(): void;
4019
4150
  private onTriggerInteractionsResetEffect;
4151
+ /**
4152
+ * 设置交互状态
4153
+ * @example
4154
+ s2.interaction.setState({
4155
+ stateName: InteractionStateName.SELECTED,
4156
+ cells: [{
4157
+ "id": "root[&]浙江省[&]舟山市",
4158
+ "colIndex": -1,
4159
+ "rowIndex": 3,
4160
+ "type": "rowCell"
4161
+ }]
4162
+ })
4163
+ */
4020
4164
  setState(interactionStateInfo: InteractionStateInfo): void;
4165
+ /**
4166
+ * 获取交互状态
4167
+ * @example s2.interaction.getState()
4168
+ */
4021
4169
  getState(): InteractionStateInfo;
4170
+ /**
4171
+ * 设置通过交互触发过更新的单元格
4172
+ * @example s2.interaction.setInteractedCells(dataCell)
4173
+ */
4022
4174
  setInteractedCells(cell: S2CellType_2): void;
4175
+ /**
4176
+ * 获取通过交互触发过更新的单元格
4177
+ * @example s2.interaction.getInteractedCells()
4178
+ */
4023
4179
  getInteractedCells(): S2CellType_2<ViewMeta_2>[];
4180
+ /**
4181
+ * 重置交互状态
4182
+ * @example s2.interaction.resetState()
4183
+ */
4024
4184
  resetState(): void;
4025
- getCurrentStateName(): InteractionStateName | undefined;
4026
- isEqualStateName(stateName: InteractionStateName): boolean;
4185
+ /**
4186
+ * 获取当前交互状态名
4187
+ * @example s2.interaction.getCurrentStateName()
4188
+ */
4189
+ getCurrentStateName(): "selected" | "hover" | "allSelected" | "rowCellBrushSelected" | "colCellBrushSelected" | "dataCellBrushSelected" | "unselected" | "hoverFocus" | "highlight" | "searchResult" | "prepareSelect" | undefined;
4190
+ /**
4191
+ * 是否和当前状态名相同
4192
+ * @example s2.interaction.isEqualStateName(InteractionStateName.SELECTED)
4193
+ */
4194
+ isEqualStateName(stateName: `${InteractionStateName}`): boolean;
4027
4195
  private isStateOf;
4196
+ /**
4197
+ * 是否是选中状态 (含单选,多选,圈选,全选)
4198
+ * @example s2.interaction.isSelectedState()
4199
+ */
4028
4200
  isSelectedState(): boolean;
4201
+ /**
4202
+ * 是否是刷选状态
4203
+ * @example s2.interaction.isBrushSelectedState()
4204
+ */
4205
+ isBrushSelectedState(): boolean;
4206
+ /**
4207
+ * 是否是全选状态
4208
+ * @example s2.interaction.isAllSelectedState()
4209
+ */
4029
4210
  isAllSelectedState(): boolean;
4211
+ /**
4212
+ * 是否是悬停聚焦状态
4213
+ * @example s2.interaction.isHoverFocusState()
4214
+ */
4030
4215
  isHoverFocusState(): boolean;
4216
+ /**
4217
+ * 是否是悬停状态
4218
+ * @example s2.interaction.isHoverState()
4219
+ */
4031
4220
  isHoverState(): boolean;
4221
+ /**
4222
+ * 是否是激活的单元格
4223
+ * @example s2.interaction.isActiveCell(cell)
4224
+ */
4032
4225
  isActiveCell(cell: S2CellType_2): boolean;
4226
+ /**
4227
+ * 是否是选中的单元格
4228
+ * @example s2.interaction.isSelectedCell(cell)
4229
+ */
4033
4230
  isSelectedCell(cell: S2CellType_2): boolean;
4231
+ /**
4232
+ * 获取当前 interaction 记录的 Cells 元信息列表,包括不在可视区域内的格子
4233
+ * @example s2.interaction.getCells(CellType.DATA_CELL)
4234
+ */
4034
4235
  getCells(cellType?: CellType[]): CellMeta[];
4236
+ /**
4237
+ * 获取已激活单元格 (不含非可视区域)
4238
+ * @example s2.interaction.getActiveCells()
4239
+ */
4035
4240
  getActiveCells(): S2CellType_2[];
4036
4241
  getActiveDataCells(): S2CellType_2[];
4037
4242
  getActiveRowCells(): S2CellType_2[];
4038
4243
  getActiveColCells(): S2CellType_2[];
4244
+ /**
4245
+ * 清除单元格交互样式
4246
+ * @example s2.interaction.clearStyleIndependent()
4247
+ */
4039
4248
  clearStyleIndependent(): void;
4249
+ /**
4250
+ * 获取未选中的单元格 (不含非可视区域)
4251
+ * @example s2.interaction.getUnSelectedDataCells()
4252
+ */
4040
4253
  getUnSelectedDataCells(): DataCell_2[];
4041
- selectAll: () => void;
4042
- selectHeaderCell: (selectHeaderCellInfo?: SelectHeaderCellInfo) => true | undefined;
4254
+ private scrollToCellByMeta;
4255
+ /**
4256
+ * 滚动至指定位置
4257
+ * @example
4258
+ s2.interaction.scrollTo({
4259
+ skipScrollEvent: false,
4260
+ offsetX: { value: 100, animate: true },
4261
+ offsetY: { value: 100, animate: true },
4262
+ })
4263
+ */
4264
+ scrollTo(offsetConfig: ScrollOffsetConfig): void;
4265
+ /**
4266
+ * 滚动至指定单元格节点
4267
+ * @example s2.interaction.scrollToNode(rowNode, { animate: true, skipScrollEvent: true })
4268
+ */
4269
+ scrollToNode(meta: ViewMeta_2 | Node_2_2, options?: CellScrollToOptions): void;
4270
+ /**
4271
+ * 滚动至指定单元格
4272
+ * @example s2.interaction.scrollToNode(rowCell, { animate: true, skipScrollEvent: true })
4273
+ */
4274
+ scrollToCell(cell: S2CellType_2, options?: CellScrollToOptions): void;
4275
+ /**
4276
+ * 滚动至指定单元格 id 对应的位置
4277
+ * @example s2.interaction.scrollToCellById('root[&]四川省[&]成都市', { animate: true, skipScrollEvent: true })
4278
+ */
4279
+ scrollToCellById(id: string, options?: CellScrollToOptions): void;
4280
+ /**
4281
+ * 滚动至顶部
4282
+ * @example s2.interaction.scrollToTop({ animate: true, skipScrollEvent: true })
4283
+ */
4284
+ scrollToTop(options?: CellScrollToOptions): void;
4285
+ /**
4286
+ * 滚动至右边
4287
+ * @example s2.interaction.scrollToRight({ animate: true, skipScrollEvent: true })
4288
+ */
4289
+ scrollToRight(options?: CellScrollToOptions): void;
4290
+ /**
4291
+ * 滚动至底部
4292
+ * @example s2.interaction.scrollToBottom({ animate: true, skipScrollEvent: true })
4293
+ */
4294
+ scrollToBottom(options?: CellScrollToOptions): void;
4295
+ /**
4296
+ * 滚动至左边
4297
+ * @example s2.interaction.scrollToLeft({ animate: true, skipScrollEvent: true })
4298
+ */
4299
+ scrollToLeft(options?: CellScrollToOptions): void;
4300
+ /**
4301
+ * 全选
4302
+ * @example s2.interaction.selectAll()
4303
+ */
4304
+ selectAll(): void;
4305
+ /**
4306
+ * 高亮指定单元格 (可视范围内)
4307
+ * @example s2.interaction.highlightCell(dataCell, options)
4308
+ */
4309
+ highlightCell(cell: S2CellType_2, options?: CellScrollToOptions): void;
4310
+ /**
4311
+ * 选中指定单元格 (可视范围内)
4312
+ * @example s2.interaction.selectCell(dataCell, options)
4313
+ */
4314
+ selectCell(cell: S2CellType_2, options?: CellScrollToOptions): void;
4315
+ /**
4316
+ * 改变指定单元格状态 (如: 选中/高亮/多选等) (可视范围内)
4317
+ * @example
4318
+ s2.interaction.changeCell({
4319
+ cell: rowCell,
4320
+ stateName: InteractionStateName.SELECTED,
4321
+ isMultiSelection: false,
4322
+ scrollIntoView: false,
4323
+ animate: true,
4324
+ skipScrollEvent: true,
4325
+ })
4326
+ */
4327
+ changeCell(options?: ChangeCellOptions): true | undefined;
4328
+ /**
4329
+ * 高亮节点对应的单元格
4330
+ * @example s2.interaction.highlightNodes([node])
4331
+ */
4043
4332
  highlightNodes: (nodes?: Node_2_2[]) => void;
4333
+ /**
4334
+ * 合并单元格
4335
+ * @example s2.interaction.mergeCells()
4336
+ */
4044
4337
  mergeCells: (cellsInfo?: MergedCellInfo[], hideData?: boolean) => void;
4045
- unmergeCell: (removedCells: MergedCell_2) => void;
4338
+ /**
4339
+ * 取消合并单元格
4340
+ * @example s2.interaction.unmergeCell(mergedCell)
4341
+ */
4342
+ unmergeCell: (removedCell: MergedCell_2) => void;
4343
+ /**
4344
+ * 隐藏列头
4345
+ * @example s2.interaction.hideColumns(['city'])
4346
+ */
4046
4347
  hideColumns(hiddenColumnFields?: string[], forceRender?: boolean): Promise<void>;
4047
4348
  private getBrushSelectionInfo;
4048
4349
  private getDefaultInteractions;
@@ -4050,12 +4351,41 @@ declare class RootInteraction {
4050
4351
  private registerEventController;
4051
4352
  draw(): void;
4052
4353
  clearState(): void;
4354
+ /**
4355
+ * 改变单元格交互状态后,进行更新和重新绘制
4356
+ * @example
4357
+ s2.interaction.changeState({
4358
+ cells: [{ id: 'city', colIndex: 1, rowIndex : 2, type: 'rowCell' }],
4359
+ stateName: InteractionStateName.SELECTED,
4360
+ force: false
4361
+ })
4362
+ */
4053
4363
  changeState(interactionStateInfo: InteractionStateInfo): void;
4054
- updatePanelGroupAllDataCells(): void;
4364
+ /**
4365
+ * 更新所有数值单元格
4366
+ * @example s2.interaction.updateAllDataCells()
4367
+ */
4368
+ updateAllDataCells(): void;
4369
+ /**
4370
+ * 更新指定单元格
4371
+ * @example s2.interaction.updateCells([rowCell, dataCell])
4372
+ */
4055
4373
  updateCells(cells?: S2CellType_2[]): void;
4056
- addIntercepts(interceptTypes?: InterceptType[]): void;
4057
- hasIntercepts(interceptTypes?: InterceptType[]): boolean;
4058
- removeIntercepts(interceptTypes?: InterceptType[]): void;
4374
+ /**
4375
+ * 添加交互拦截
4376
+ * @example s2.interaction.addIntercepts([InterceptType.HOVER])
4377
+ */
4378
+ addIntercepts(interceptTypes?: `${InterceptType}`[]): void;
4379
+ /**
4380
+ * 是否有指定交互拦截
4381
+ * @example s2.interaction.hasIntercepts([InterceptType.HOVER])
4382
+ */
4383
+ hasIntercepts(interceptTypes?: `${InterceptType}`[]): boolean;
4384
+ /**
4385
+ * 移除交互拦截
4386
+ * @example s2.interaction.removeIntercepts([InterceptType.HOVER])
4387
+ */
4388
+ removeIntercepts(interceptTypes?: `${InterceptType}`[]): void;
4059
4389
  clearHoverTimer(): void;
4060
4390
  setHoverTimer(timer: number): void;
4061
4391
  getHoverTimer(): number | null;
@@ -4066,9 +4396,12 @@ declare class RootInteraction {
4066
4396
  updateDataCellRelevantHeaderCells(stateName: InteractionStateName, meta: ViewMeta_2): void;
4067
4397
  updateDataCellRelevantRowCells(stateName: InteractionStateName, meta: ViewMeta_2): void;
4068
4398
  updateDataCellRelevantColCells(stateName: InteractionStateName, meta: ViewMeta_2): void;
4399
+ emitSelectEvent(options: CellSelectedDetail_2 & {
4400
+ cells?: S2CellType_2[];
4401
+ }): void;
4069
4402
  }
4070
4403
 
4071
- declare class RowCell extends HeaderCell<RowHeaderConfig> {
4404
+ declare class RowCell_2 extends HeaderCell<RowHeaderConfig> {
4072
4405
  get cellType(): CellType;
4073
4406
  protected getBorderPositions(): CellBorderPosition[];
4074
4407
  protected initCell(): void;
@@ -4088,7 +4421,6 @@ declare class RowCell extends HeaderCell<RowHeaderConfig> {
4088
4421
  protected drawTreeIcon(): void;
4089
4422
  protected drawTreeLeafNodeAlignDot(): void;
4090
4423
  protected isBolderText(): boolean;
4091
- drawTextShape(): void;
4092
4424
  protected drawResizeAreaInLeaf(): void;
4093
4425
  protected getHorizontalResizeAreaOffset(): {
4094
4426
  offsetX: number;
@@ -4121,17 +4453,19 @@ declare interface RowCellStyle extends BaseCellStyle, CellTextWordWrapStyle {
4121
4453
  showTreeLeafNodeAlignDot?: boolean;
4122
4454
  /**
4123
4455
  * 收起所有 (对应角头收起展开按钮)
4456
+ * @description 优先级 `collapseFields` > `expandDepth` > `collapseAll`
4124
4457
  */
4125
4458
  collapseAll?: boolean | null;
4126
4459
  /**
4127
4460
  * 折叠节点
4128
- * 优先级大于 collapseAll 和 expandDepth
4129
4461
  * id 级别: { ['root[&]浙江省']: true, ['root[&]河南省']: false } 即 只有 浙江省 对应的节点才会被折叠
4130
4462
  * field 级别: { city: true, type: false } : 即 所有 city 对应的维值都会被折叠
4463
+ * @description 优先级 `collapseFields` > `expandDepth` > `collapseAll`
4131
4464
  */
4132
4465
  collapseFields?: Record<string, boolean> | null;
4133
4466
  /**
4134
- * 行头默认展开到第几层 (从 0 开始)
4467
+ * 行头节点默认展开到第几层 (从 0 开始)
4468
+ * @description 优先级 `collapseFields` > `expandDepth` > `collapseAll`
4135
4469
  */
4136
4470
  expandDepth?: number | null;
4137
4471
  }
@@ -4141,11 +4475,11 @@ declare interface RowCellStyle extends BaseCellStyle, CellTextWordWrapStyle {
4141
4475
  */
4142
4476
  declare class RowHeader extends BaseHeader<RowHeaderConfig> {
4143
4477
  protected initGroups(): void;
4144
- getCellInstance(node: Node_2_2): RowCell | SeriesNumberCell_2;
4478
+ getCellInstance(node: Node_2_2): RowCell_2 | SeriesNumberCell_2;
4145
4479
  protected isCellInRect(node: Node_2_2): boolean;
4146
4480
  protected getCellGroup(item: Node_2_2): Group;
4147
4481
  protected layout(): void;
4148
- protected emitRenderEvent(cell: RowCell | SeriesNumberCell_2): void;
4482
+ protected emitRenderEvent(cell: RowCell_2 | SeriesNumberCell_2): void;
4149
4483
  protected offset(): void;
4150
4484
  protected clip(): void;
4151
4485
  }
@@ -4273,7 +4607,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Men
4273
4607
  /**
4274
4608
  * 设备类型: pc / mobile
4275
4609
  */
4276
- device?: DeviceType;
4610
+ device?: `${DeviceType}`;
4277
4611
  /**
4278
4612
  * 自定义 AntV/G 渲染引擎配置参数 & 插件注册
4279
4613
  * @see https://g.antv.antgroup.com/plugins/intro
@@ -4291,7 +4625,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Men
4291
4625
  };
4292
4626
  },
4293
4627
  */
4294
- transformCanvasConfig?: (renderer: CanvasConfig['renderer'], spreadsheet: SpreadSheet_2) => (Partial<CanvasConfig> | null | undefined) | void;
4628
+ transformCanvasConfig?: (renderer: Renderer, spreadsheet: SpreadSheet_2) => (Partial<CanvasConfig> | null | undefined) | void;
4295
4629
  /** *********** 自定义单元格 hooks **************** */
4296
4630
  /**
4297
4631
  * 自定义数值单元格
@@ -4312,7 +4646,7 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Men
4312
4646
  * 自定义行头单元格
4313
4647
  * @see https://s2.antv.antgroup.com/examples/custom/custom-cell#row-cell
4314
4648
  */
4315
- rowCell?: CellCallback<RowHeaderConfig, RowCell>;
4649
+ rowCell?: CellCallback<RowHeaderConfig, RowCell_2>;
4316
4650
  /**
4317
4651
  * 自定义列头单元格
4318
4652
  * @see https://s2.antv.antgroup.com/examples/custom/custom-cell#col-cell
@@ -4372,11 +4706,12 @@ declare interface S2BasicOptions<T = TooltipContentType_2, P = Pagination_2, Men
4372
4706
  facet?: (spreadsheet: SpreadSheet_2) => BaseFacet;
4373
4707
  }
4374
4708
 
4375
- declare type S2CellType_2<T extends SimpleBBox = ViewMeta_2> = DataCell_2 | HeaderCell | ColCell_2 | CornerCell_2 | RowCell | SeriesNumberCell_2 | MergedCell_2 | TableDataCell_2 | TableCornerCell | TableSeriesNumberCell | BaseCell<T>;
4709
+ declare type S2CellType_2<T extends SimpleBBox = ViewMeta_2> = DataCell_2 | HeaderCell | ColCell_2 | CornerCell_2 | RowCell_2 | SeriesNumberCell_2 | MergedCell_2 | TableDataCell_2 | TableCornerCell | TableSeriesNumberCell | BaseCell<T>;
4376
4710
 
4377
4711
  declare interface S2DataConfig_2 {
4378
4712
  /**
4379
4713
  * 原始明细数据
4714
+ * @see https://assets.antv.antgroup.com/s2/basic.json
4380
4715
  */
4381
4716
  data: RawData_2[];
4382
4717
  /**
@@ -4385,14 +4720,18 @@ declare interface S2DataConfig_2 {
4385
4720
  fields: Fields;
4386
4721
  /**
4387
4722
  * 字段元数据
4723
+ * @see https://s2.antv.antgroup.com/manual/basic/formatter
4388
4724
  */
4389
4725
  meta?: Meta[];
4390
4726
  /**
4391
4727
  * 排序配置
4728
+ * @see https://s2.antv.antgroup.com/manual/basic/sort/basic
4392
4729
  */
4393
4730
  sortParams?: SortParams_2;
4394
4731
  /**
4395
4732
  * 筛选配置
4733
+ * @see https://s2.antv.antgroup.com/api/general/s2-data-config#filterparam
4734
+ * @example https://s2.antv.antgroup.com/examples/case/data-preview/#index
4396
4735
  */
4397
4736
  filterParams?: FilterParam[];
4398
4737
  [key: string]: unknown;
@@ -4412,6 +4751,7 @@ declare enum S2Event {
4412
4751
  ROW_CELL_COLLAPSED = "row-cell:collapsed",
4413
4752
  ROW_CELL_ALL_COLLAPSED = "row-cell:all-collapsed",
4414
4753
  ROW_CELL_RENDER = "row-cell:render",
4754
+ ROW_CELL_SELECTED = "row-cell:selected",
4415
4755
  ROW_CELL_COLLAPSED__PRIVATE = "row-cell:collapsed__private",
4416
4756
  ROW_CELL_ALL_COLLAPSED__PRIVATE = "row-cell:all-collapsed__private",
4417
4757
  /** ================ Col Cell ================ */
@@ -4426,6 +4766,7 @@ declare enum S2Event {
4426
4766
  COL_CELL_EXPANDED = "col-cell:expanded",
4427
4767
  COL_CELL_HIDDEN = "col-cell:hidden",
4428
4768
  COL_CELL_RENDER = "col-cell:render",
4769
+ COL_CELL_SELECTED = "col-cell:selected",
4429
4770
  /** ================ Data Cell ================ */
4430
4771
  DATA_CELL_HOVER = "data-cell:hover",
4431
4772
  DATA_CELL_CLICK = "data-cell:click",
@@ -4437,6 +4778,7 @@ declare enum S2Event {
4437
4778
  DATA_CELL_BRUSH_SELECTION = "data-cell:brush-selection",
4438
4779
  DATA_CELL_SELECT_MOVE = "data-cell:select-move",
4439
4780
  DATA_CELL_RENDER = "data-cell:render",
4781
+ DATA_CELL_SELECTED = "data-cell:selected",
4440
4782
  /** ================ Corner Cell ================ */
4441
4783
  CORNER_CELL_HOVER = "corner-cell:hover",
4442
4784
  CORNER_CELL_CLICK = "corner-cell:click",
@@ -4446,6 +4788,7 @@ declare enum S2Event {
4446
4788
  CORNER_CELL_MOUSE_UP = "corner-cell:mouse-up",
4447
4789
  CORNER_CELL_MOUSE_MOVE = "corner-cell:mouse-move",
4448
4790
  CORNER_CELL_RENDER = "corner-cell:render",
4791
+ CORNER_CELL_SELECTED = "corner-cell:selected",
4449
4792
  /** ================ Merged Cells ================ */
4450
4793
  MERGED_CELLS_HOVER = "merged-cells:hover",
4451
4794
  MERGED_CELLS_CLICK = "merged-cells:click",
@@ -4724,19 +5067,36 @@ declare interface ScrollOffset_2 {
4724
5067
  rowHeaderScrollX?: number;
4725
5068
  }
4726
5069
 
5070
+ declare interface ScrollOffsetConfig extends Pick<CellScrollToOptions, 'skipScrollEvent'> {
5071
+ /**
5072
+ * 行头水平偏移量
5073
+ */
5074
+ rowHeaderOffsetX?: {
5075
+ value: number | undefined;
5076
+ animate?: boolean;
5077
+ };
5078
+ /**
5079
+ * 水平偏移量
5080
+ */
5081
+ offsetX?: {
5082
+ value: number | undefined;
5083
+ animate?: boolean;
5084
+ };
5085
+ /**
5086
+ * 垂直偏移量
5087
+ */
5088
+ offsetY?: {
5089
+ value: number | undefined;
5090
+ animate?: boolean;
5091
+ };
5092
+ }
5093
+
4727
5094
  declare interface ScrollSpeedRatio {
4728
5095
  horizontal?: number;
4729
5096
  vertical?: number;
4730
5097
  }
4731
5098
 
4732
- declare type SelectedHandler = (cells: S2CellType_2[]) => void;
4733
-
4734
- declare interface SelectHeaderCellInfo {
4735
- cell: S2CellType_2<ViewMeta_2>;
4736
- isMultiSelection?: boolean;
4737
- }
4738
-
4739
- declare class SeriesNumberCell_2 extends RowCell {
5099
+ declare class SeriesNumberCell_2 extends RowCell_2 {
4740
5100
  get cellType(): CellType;
4741
5101
  protected getBorderPositions(): CellBorderPosition[];
4742
5102
  protected initCell(): void;
@@ -4788,7 +5148,7 @@ declare class SeriesNumberHeader extends RowHeader {
4788
5148
  protected emitRenderEvent(cell: SeriesNumberCell_2): void;
4789
5149
  }
4790
5150
 
4791
- export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
5151
+ export declare const SheetComponent: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onRowCellSelected" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onColCellSelected" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onDataCellSelected" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onCornerCellSelected" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
4792
5152
  s2Ref: ShallowRef<SheetExpose>;
4793
5153
  sheetType: ComputedRef<DefineComponent< {
4794
5154
  sheetType: PropType<SheetType>;
@@ -4834,7 +5194,8 @@ rowCellMouseMove: (data: TargetCellInfo_2) => void;
4834
5194
  rowCellCollapsed: (params: RowCellCollapsedParams_2) => void;
4835
5195
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
4836
5196
  rowCellScroll: (position: Required<ScrollOffset_2>) => void;
4837
- rowCellRender: (cell: ColCell_2) => void;
5197
+ rowCellRender: (cell: RowCell_2) => void;
5198
+ rowCellSelected: CellSelectedHandler_2;
4838
5199
  colCellHover: (data: TargetCellInfo_2) => void;
4839
5200
  colCellClick: (data: TargetCellInfo_2) => void;
4840
5201
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4848,6 +5209,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo_2;
4848
5209
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
4849
5210
  }) => void;
4850
5211
  colCellRender: (cell: ColCell_2) => void;
5212
+ colCellSelected: CellSelectedHandler_2;
4851
5213
  dataCellHover: (data: TargetCellInfo_2) => void;
4852
5214
  dataCellClick: (data: TargetCellInfo_2) => void;
4853
5215
  dataCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4860,6 +5222,7 @@ dataCellSelectMove: (metaList: ViewMetaData_2[]) => void;
4860
5222
  dataCellRender: (cell: DataCell_2) => void;
4861
5223
  dataCellEditStart: (meta: ViewMeta_2, cell: TableDataCell_2) => void;
4862
5224
  dataCellEditEnd: (meta: ViewMeta_2, cell: TableDataCell_2) => void;
5225
+ dataCellSelected: CellSelectedHandler_2;
4863
5226
  cornerCellHover: (data: TargetCellInfo_2) => void;
4864
5227
  cornerCellClick: (data: TargetCellInfo_2) => void;
4865
5228
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4868,6 +5231,7 @@ cornerCellMouseDown: (data: TargetCellInfo_2) => void;
4868
5231
  cornerCellMouseUp: (data: TargetCellInfo_2) => void;
4869
5232
  cornerCellMouseMove: (data: TargetCellInfo_2) => void;
4870
5233
  cornerCellRender: (cell: CornerCell_2) => void;
5234
+ cornerCellSelected: CellSelectedHandler_2;
4871
5235
  mergedCellsHover: (data: TargetCellInfo_2) => void;
4872
5236
  mergedCellsClick: (data: TargetCellInfo_2) => void;
4873
5237
  mergedCellsDoubleClick: (data: TargetCellInfo_2) => void;
@@ -4926,7 +5290,7 @@ mouseHover: (event: FederatedPointerEvent) => void;
4926
5290
  mouseUp: (event: MouseEvent) => void;
4927
5291
  mouseDown: (event: MouseEvent) => void;
4928
5292
  mouseMove: (event: MouseEvent) => void;
4929
- selected: (cells: S2CellType_2[]) => void;
5293
+ selected: CellSelectedHandler_2;
4930
5294
  reset: (event: KeyboardEvent) => void;
4931
5295
  linkFieldJump: (data: {
4932
5296
  field: string;
@@ -4980,7 +5344,8 @@ onRowCellMouseMove?: (data: TargetCellInfo_2) => any;
4980
5344
  onRowCellCollapsed?: (params: RowCellCollapsedParams_2) => any;
4981
5345
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
4982
5346
  onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
4983
- onRowCellRender?: (cell: ColCell_2) => any;
5347
+ onRowCellRender?: (cell: RowCell_2) => any;
5348
+ onRowCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
4984
5349
  onColCellHover?: (data: TargetCellInfo_2) => any;
4985
5350
  onColCellClick?: (data: TargetCellInfo_2) => any;
4986
5351
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -4994,6 +5359,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo_2;
4994
5359
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
4995
5360
  }) => any;
4996
5361
  onColCellRender?: (cell: ColCell_2) => any;
5362
+ onColCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
4997
5363
  onDataCellHover?: (data: TargetCellInfo_2) => any;
4998
5364
  onDataCellClick?: (data: TargetCellInfo_2) => any;
4999
5365
  onDataCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5006,6 +5372,7 @@ onDataCellSelectMove?: (metaList: ViewMetaData_2[]) => any;
5006
5372
  onDataCellRender?: (cell: DataCell_2) => any;
5007
5373
  onDataCellEditStart?: (meta: ViewMeta_2, cell: TableDataCell_2) => any;
5008
5374
  onDataCellEditEnd?: (meta: ViewMeta_2, cell: TableDataCell_2) => any;
5375
+ onDataCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5009
5376
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
5010
5377
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
5011
5378
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5014,6 +5381,7 @@ onCornerCellMouseDown?: (data: TargetCellInfo_2) => any;
5014
5381
  onCornerCellMouseUp?: (data: TargetCellInfo_2) => any;
5015
5382
  onCornerCellMouseMove?: (data: TargetCellInfo_2) => any;
5016
5383
  onCornerCellRender?: (cell: CornerCell_2) => any;
5384
+ onCornerCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5017
5385
  onMergedCellsHover?: (data: TargetCellInfo_2) => any;
5018
5386
  onMergedCellsClick?: (data: TargetCellInfo_2) => any;
5019
5387
  onMergedCellsDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5072,7 +5440,7 @@ onMouseHover?: (event: FederatedPointerEvent) => any;
5072
5440
  onMouseUp?: (event: MouseEvent) => any;
5073
5441
  onMouseDown?: (event: MouseEvent) => any;
5074
5442
  onMouseMove?: (event: MouseEvent) => any;
5075
- onSelected?: (cells: S2CellType_2[]) => any;
5443
+ onSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5076
5444
  onReset?: (event: KeyboardEvent) => any;
5077
5445
  onLinkFieldJump?: (data: {
5078
5446
  field: string;
@@ -5099,7 +5467,7 @@ showPagination: boolean | {
5099
5467
  onShowSizeChange?: (pageSize: number) => void;
5100
5468
  onChange?: (current: number) => void;
5101
5469
  };
5102
- }, {}> | DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
5470
+ }, {}> | DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onRowCellSelected" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onColCellSelected" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onDataCellSelected" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onCornerCellSelected" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
5103
5471
  s2Ref: ShallowRef<SheetExpose>;
5104
5472
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
5105
5473
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
@@ -5113,7 +5481,8 @@ rowCellMouseMove: (data: TargetCellInfo_2) => void;
5113
5481
  rowCellCollapsed: (params: RowCellCollapsedParams_2) => void;
5114
5482
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
5115
5483
  rowCellScroll: (position: Required<ScrollOffset_2>) => void;
5116
- rowCellRender: (cell: ColCell_2) => void;
5484
+ rowCellRender: (cell: RowCell_2) => void;
5485
+ rowCellSelected: CellSelectedHandler_2;
5117
5486
  colCellHover: (data: TargetCellInfo_2) => void;
5118
5487
  colCellClick: (data: TargetCellInfo_2) => void;
5119
5488
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5127,6 +5496,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo_2;
5127
5496
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
5128
5497
  }) => void;
5129
5498
  colCellRender: (cell: ColCell_2) => void;
5499
+ colCellSelected: CellSelectedHandler_2;
5130
5500
  dataCellHover: (data: TargetCellInfo_2) => void;
5131
5501
  dataCellClick: (data: TargetCellInfo_2) => void;
5132
5502
  dataCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5139,6 +5509,7 @@ dataCellSelectMove: (metaList: ViewMetaData_2[]) => void;
5139
5509
  dataCellRender: (cell: DataCell_2) => void;
5140
5510
  dataCellEditStart: (meta: ViewMeta_2, cell: TableDataCell_2) => void;
5141
5511
  dataCellEditEnd: (meta: ViewMeta_2, cell: TableDataCell_2) => void;
5512
+ dataCellSelected: CellSelectedHandler_2;
5142
5513
  cornerCellHover: (data: TargetCellInfo_2) => void;
5143
5514
  cornerCellClick: (data: TargetCellInfo_2) => void;
5144
5515
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5147,6 +5518,7 @@ cornerCellMouseDown: (data: TargetCellInfo_2) => void;
5147
5518
  cornerCellMouseUp: (data: TargetCellInfo_2) => void;
5148
5519
  cornerCellMouseMove: (data: TargetCellInfo_2) => void;
5149
5520
  cornerCellRender: (cell: CornerCell_2) => void;
5521
+ cornerCellSelected: CellSelectedHandler_2;
5150
5522
  mergedCellsHover: (data: TargetCellInfo_2) => void;
5151
5523
  mergedCellsClick: (data: TargetCellInfo_2) => void;
5152
5524
  mergedCellsDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5205,7 +5577,7 @@ mouseHover: (event: FederatedPointerEvent) => void;
5205
5577
  mouseUp: (event: MouseEvent) => void;
5206
5578
  mouseDown: (event: MouseEvent) => void;
5207
5579
  mouseMove: (event: MouseEvent) => void;
5208
- selected: (cells: S2CellType_2[]) => void;
5580
+ selected: CellSelectedHandler_2;
5209
5581
  reset: (event: KeyboardEvent) => void;
5210
5582
  linkFieldJump: (data: {
5211
5583
  field: string;
@@ -5219,7 +5591,7 @@ spreadsheet: SpreadSheet_2;
5219
5591
  }) => void;
5220
5592
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
5221
5593
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
5222
- }, string, PublicProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
5594
+ }, string, PublicProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onRowCellSelected" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onColCellSelected" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onDataCellSelected" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onCornerCellSelected" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
5223
5595
  onRowCellHover?: (data: TargetCellInfo_2) => any;
5224
5596
  onRowCellClick?: (data: TargetCellInfo_2) => any;
5225
5597
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5230,7 +5602,8 @@ onRowCellMouseMove?: (data: TargetCellInfo_2) => any;
5230
5602
  onRowCellCollapsed?: (params: RowCellCollapsedParams_2) => any;
5231
5603
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
5232
5604
  onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
5233
- onRowCellRender?: (cell: ColCell_2) => any;
5605
+ onRowCellRender?: (cell: RowCell_2) => any;
5606
+ onRowCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5234
5607
  onColCellHover?: (data: TargetCellInfo_2) => any;
5235
5608
  onColCellClick?: (data: TargetCellInfo_2) => any;
5236
5609
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5244,6 +5617,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo_2;
5244
5617
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
5245
5618
  }) => any;
5246
5619
  onColCellRender?: (cell: ColCell_2) => any;
5620
+ onColCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5247
5621
  onDataCellHover?: (data: TargetCellInfo_2) => any;
5248
5622
  onDataCellClick?: (data: TargetCellInfo_2) => any;
5249
5623
  onDataCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5256,6 +5630,7 @@ onDataCellSelectMove?: (metaList: ViewMetaData_2[]) => any;
5256
5630
  onDataCellRender?: (cell: DataCell_2) => any;
5257
5631
  onDataCellEditStart?: (meta: ViewMeta_2, cell: TableDataCell_2) => any;
5258
5632
  onDataCellEditEnd?: (meta: ViewMeta_2, cell: TableDataCell_2) => any;
5633
+ onDataCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5259
5634
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
5260
5635
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
5261
5636
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5264,6 +5639,7 @@ onCornerCellMouseDown?: (data: TargetCellInfo_2) => any;
5264
5639
  onCornerCellMouseUp?: (data: TargetCellInfo_2) => any;
5265
5640
  onCornerCellMouseMove?: (data: TargetCellInfo_2) => any;
5266
5641
  onCornerCellRender?: (cell: CornerCell_2) => any;
5642
+ onCornerCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5267
5643
  onMergedCellsHover?: (data: TargetCellInfo_2) => any;
5268
5644
  onMergedCellsClick?: (data: TargetCellInfo_2) => any;
5269
5645
  onMergedCellsDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5322,7 +5698,7 @@ onMouseHover?: (event: FederatedPointerEvent) => any;
5322
5698
  onMouseUp?: (event: MouseEvent) => any;
5323
5699
  onMouseDown?: (event: MouseEvent) => any;
5324
5700
  onMouseMove?: (event: MouseEvent) => any;
5325
- onSelected?: (cells: S2CellType_2[]) => any;
5701
+ onSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5326
5702
  onReset?: (event: KeyboardEvent) => any;
5327
5703
  onLinkFieldJump?: (data: {
5328
5704
  field: string;
@@ -5350,7 +5726,8 @@ rowCellMouseMove: (data: TargetCellInfo_2) => void;
5350
5726
  rowCellCollapsed: (params: RowCellCollapsedParams_2) => void;
5351
5727
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
5352
5728
  rowCellScroll: (position: Required<ScrollOffset_2>) => void;
5353
- rowCellRender: (cell: ColCell_2) => void;
5729
+ rowCellRender: (cell: RowCell_2) => void;
5730
+ rowCellSelected: CellSelectedHandler_2;
5354
5731
  colCellHover: (data: TargetCellInfo_2) => void;
5355
5732
  colCellClick: (data: TargetCellInfo_2) => void;
5356
5733
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5364,6 +5741,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo_2;
5364
5741
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
5365
5742
  }) => void;
5366
5743
  colCellRender: (cell: ColCell_2) => void;
5744
+ colCellSelected: CellSelectedHandler_2;
5367
5745
  dataCellHover: (data: TargetCellInfo_2) => void;
5368
5746
  dataCellClick: (data: TargetCellInfo_2) => void;
5369
5747
  dataCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5376,6 +5754,7 @@ dataCellSelectMove: (metaList: ViewMetaData_2[]) => void;
5376
5754
  dataCellRender: (cell: DataCell_2) => void;
5377
5755
  dataCellEditStart: (meta: ViewMeta_2, cell: TableDataCell_2) => void;
5378
5756
  dataCellEditEnd: (meta: ViewMeta_2, cell: TableDataCell_2) => void;
5757
+ dataCellSelected: CellSelectedHandler_2;
5379
5758
  cornerCellHover: (data: TargetCellInfo_2) => void;
5380
5759
  cornerCellClick: (data: TargetCellInfo_2) => void;
5381
5760
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5384,6 +5763,7 @@ cornerCellMouseDown: (data: TargetCellInfo_2) => void;
5384
5763
  cornerCellMouseUp: (data: TargetCellInfo_2) => void;
5385
5764
  cornerCellMouseMove: (data: TargetCellInfo_2) => void;
5386
5765
  cornerCellRender: (cell: CornerCell_2) => void;
5766
+ cornerCellSelected: CellSelectedHandler_2;
5387
5767
  mergedCellsHover: (data: TargetCellInfo_2) => void;
5388
5768
  mergedCellsClick: (data: TargetCellInfo_2) => void;
5389
5769
  mergedCellsDoubleClick: (data: TargetCellInfo_2) => void;
@@ -5442,7 +5822,7 @@ mouseHover: (event: FederatedPointerEvent) => void;
5442
5822
  mouseUp: (event: MouseEvent) => void;
5443
5823
  mouseDown: (event: MouseEvent) => void;
5444
5824
  mouseMove: (event: MouseEvent) => void;
5445
- selected: (cells: S2CellType_2[]) => void;
5825
+ selected: CellSelectedHandler_2;
5446
5826
  reset: (event: KeyboardEvent) => void;
5447
5827
  linkFieldJump: (data: {
5448
5828
  field: string;
@@ -5456,7 +5836,7 @@ spreadsheet: SpreadSheet_2;
5456
5836
  }) => void;
5457
5837
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
5458
5838
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
5459
- }, string, PublicProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
5839
+ }, string, PublicProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onRowCellSelected" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onColCellSelected" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onDataCellSelected" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onCornerCellSelected" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
5460
5840
  onRowCellHover?: (data: TargetCellInfo_2) => any;
5461
5841
  onRowCellClick?: (data: TargetCellInfo_2) => any;
5462
5842
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5467,7 +5847,8 @@ onRowCellMouseMove?: (data: TargetCellInfo_2) => any;
5467
5847
  onRowCellCollapsed?: (params: RowCellCollapsedParams_2) => any;
5468
5848
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
5469
5849
  onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
5470
- onRowCellRender?: (cell: ColCell_2) => any;
5850
+ onRowCellRender?: (cell: RowCell_2) => any;
5851
+ onRowCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5471
5852
  onColCellHover?: (data: TargetCellInfo_2) => any;
5472
5853
  onColCellClick?: (data: TargetCellInfo_2) => any;
5473
5854
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5481,6 +5862,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo_2;
5481
5862
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
5482
5863
  }) => any;
5483
5864
  onColCellRender?: (cell: ColCell_2) => any;
5865
+ onColCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5484
5866
  onDataCellHover?: (data: TargetCellInfo_2) => any;
5485
5867
  onDataCellClick?: (data: TargetCellInfo_2) => any;
5486
5868
  onDataCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5493,6 +5875,7 @@ onDataCellSelectMove?: (metaList: ViewMetaData_2[]) => any;
5493
5875
  onDataCellRender?: (cell: DataCell_2) => any;
5494
5876
  onDataCellEditStart?: (meta: ViewMeta_2, cell: TableDataCell_2) => any;
5495
5877
  onDataCellEditEnd?: (meta: ViewMeta_2, cell: TableDataCell_2) => any;
5878
+ onDataCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5496
5879
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
5497
5880
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
5498
5881
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5501,6 +5884,7 @@ onCornerCellMouseDown?: (data: TargetCellInfo_2) => any;
5501
5884
  onCornerCellMouseUp?: (data: TargetCellInfo_2) => any;
5502
5885
  onCornerCellMouseMove?: (data: TargetCellInfo_2) => any;
5503
5886
  onCornerCellRender?: (cell: CornerCell_2) => any;
5887
+ onCornerCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5504
5888
  onMergedCellsHover?: (data: TargetCellInfo_2) => any;
5505
5889
  onMergedCellsClick?: (data: TargetCellInfo_2) => any;
5506
5890
  onMergedCellsDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -5559,7 +5943,7 @@ onMouseHover?: (event: FederatedPointerEvent) => any;
5559
5943
  onMouseUp?: (event: MouseEvent) => any;
5560
5944
  onMouseDown?: (event: MouseEvent) => any;
5561
5945
  onMouseMove?: (event: MouseEvent) => any;
5562
- onSelected?: (cells: S2CellType_2[]) => any;
5946
+ onSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
5563
5947
  onReset?: (event: KeyboardEvent) => any;
5564
5948
  onLinkFieldJump?: (data: {
5565
5949
  field: string;
@@ -5605,7 +5989,7 @@ declare interface SimpleBBox {
5605
5989
  height: number;
5606
5990
  }
5607
5991
 
5608
- declare type SimpleData = string | number | null;
5992
+ declare type SimpleData = string | number | null | undefined;
5609
5993
 
5610
5994
  declare interface Sort {
5611
5995
  /** 字段 id */
@@ -5778,14 +6162,9 @@ declare abstract class SpreadSheet_2 extends EE {
5778
6162
  getTheme(): InternalFullyTheme;
5779
6163
  getThemeName(): "default" | "colorful" | "gray" | "dark";
5780
6164
  /**
5781
- * Update pagination config which store in {@see options}
5782
- * @param pagination
6165
+ * 更新分页配置
5783
6166
  */
5784
6167
  updatePagination(pagination: Pagination_2): void;
5785
- /**
5786
- * 获取当前表格实际内容高度
5787
- */
5788
- getContentHeight(): number;
5789
6168
  /**
5790
6169
  * 修改表格画布大小,不用重新加载数据
5791
6170
  * @param width
@@ -5811,14 +6190,6 @@ declare abstract class SpreadSheet_2 extends EE {
5811
6190
  __s2_instance__: SpreadSheet_2;
5812
6191
  };
5813
6192
  getLayoutWidthType(): "adaptive" | "colAdaptive" | "compact";
5814
- /**
5815
- * Update scroll's offset, the value can be undefined,
5816
- * indicate not update current value
5817
- * @param offsetConfig
5818
- * default offsetX(horizontal scroll need animation)
5819
- * but offsetY(vertical scroll don't need animation)
5820
- */
5821
- updateScrollOffset(offsetConfig: OffsetConfig): void;
5822
6193
  protected isCellType(cell?: CellEventTarget): boolean;
5823
6194
  getCell<T extends S2CellType_2 = S2CellType_2>(target: CellEventTarget): T | null;
5824
6195
  getCellType(target: CellEventTarget): CellType | undefined;
@@ -5836,7 +6207,7 @@ declare abstract class SpreadSheet_2 extends EE {
5836
6207
  * @private
5837
6208
  */
5838
6209
  protected initContainer(dom: S2MountContainer_2): void;
5839
- protected updateContainerStyle(): void;
6210
+ protected setupContainerStyle(): void;
5840
6211
  private initHiddenColumnsDetail;
5841
6212
  private clearCanvasEvent;
5842
6213
  /**
@@ -5845,21 +6216,21 @@ declare abstract class SpreadSheet_2 extends EE {
5845
6216
  * @param font 文本 css 样式
5846
6217
  * @returns 文本测量信息 TextMetrics
5847
6218
  */
5848
- measureText: ((text: string | number | undefined, font: unknown) => TextMetrics | null) & MemoizedFunction;
6219
+ measureText: ((text: SimpleData, font: unknown) => TextMetrics | null) & MemoizedFunction;
5849
6220
  /**
5850
6221
  * 计算文本在画布中的宽度
5851
6222
  * @param text 待计算的文本
5852
6223
  * @param font 文本 css 样式
5853
6224
  * @returns 文本宽度
5854
6225
  */
5855
- measureTextWidth: (text: string | number | undefined, font: unknown) => number;
6226
+ measureTextWidth: (text: SimpleData, font: unknown) => number;
5856
6227
  /**
5857
6228
  * 计算文本在画布中的宽度 https://developer.mozilla.org/zh-CN/docs/Web/API/TextMetrics
5858
6229
  * @param text 待计算的文本
5859
6230
  * @param font 文本 css 样式
5860
6231
  * @returns 文本高度
5861
6232
  */
5862
- measureTextHeight: (text: string | number | undefined, font: unknown) => number;
6233
+ measureTextHeight: (text: SimpleData, font: unknown) => number;
5863
6234
  /**
5864
6235
  * 粗略计算文本在画布中的宽度
5865
6236
  * @param text 待计算的文本
@@ -6030,7 +6401,7 @@ declare class TableSeriesNumberCell extends TableDataCell_2 {
6030
6401
  protected getTextStyle(): TextTheme;
6031
6402
  }
6032
6403
 
6033
- export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
6404
+ export declare const TableSheet: DefineComponent<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onRowCellSelected" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onColCellSelected" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onDataCellSelected" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onCornerCellSelected" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">, {
6034
6405
  s2Ref: ShallowRef<SheetExpose>;
6035
6406
  }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
6036
6407
  spreadsheet: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options: S2Options_2<TooltipContentType_2, Pagination_2, BaseTooltipOperatorMenuOptions_2>) => SpreadSheet_2;
@@ -6044,7 +6415,8 @@ rowCellMouseMove: (data: TargetCellInfo_2) => void;
6044
6415
  rowCellCollapsed: (params: RowCellCollapsedParams_2) => void;
6045
6416
  rowCellAllCollapsed: (isCollapsed: boolean) => void;
6046
6417
  rowCellScroll: (position: Required<ScrollOffset_2>) => void;
6047
- rowCellRender: (cell: ColCell_2) => void;
6418
+ rowCellRender: (cell: RowCell_2) => void;
6419
+ rowCellSelected: CellSelectedHandler_2;
6048
6420
  colCellHover: (data: TargetCellInfo_2) => void;
6049
6421
  colCellClick: (data: TargetCellInfo_2) => void;
6050
6422
  colCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -6058,6 +6430,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo_2;
6058
6430
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
6059
6431
  }) => void;
6060
6432
  colCellRender: (cell: ColCell_2) => void;
6433
+ colCellSelected: CellSelectedHandler_2;
6061
6434
  dataCellHover: (data: TargetCellInfo_2) => void;
6062
6435
  dataCellClick: (data: TargetCellInfo_2) => void;
6063
6436
  dataCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -6070,6 +6443,7 @@ dataCellSelectMove: (metaList: ViewMetaData_2[]) => void;
6070
6443
  dataCellRender: (cell: DataCell_2) => void;
6071
6444
  dataCellEditStart: (meta: ViewMeta_2, cell: TableDataCell_2) => void;
6072
6445
  dataCellEditEnd: (meta: ViewMeta_2, cell: TableDataCell_2) => void;
6446
+ dataCellSelected: CellSelectedHandler_2;
6073
6447
  cornerCellHover: (data: TargetCellInfo_2) => void;
6074
6448
  cornerCellClick: (data: TargetCellInfo_2) => void;
6075
6449
  cornerCellDoubleClick: (data: TargetCellInfo_2) => void;
@@ -6078,6 +6452,7 @@ cornerCellMouseDown: (data: TargetCellInfo_2) => void;
6078
6452
  cornerCellMouseUp: (data: TargetCellInfo_2) => void;
6079
6453
  cornerCellMouseMove: (data: TargetCellInfo_2) => void;
6080
6454
  cornerCellRender: (cell: CornerCell_2) => void;
6455
+ cornerCellSelected: CellSelectedHandler_2;
6081
6456
  mergedCellsHover: (data: TargetCellInfo_2) => void;
6082
6457
  mergedCellsClick: (data: TargetCellInfo_2) => void;
6083
6458
  mergedCellsDoubleClick: (data: TargetCellInfo_2) => void;
@@ -6136,7 +6511,7 @@ mouseHover: (event: FederatedPointerEvent) => void;
6136
6511
  mouseUp: (event: MouseEvent) => void;
6137
6512
  mouseDown: (event: MouseEvent) => void;
6138
6513
  mouseMove: (event: MouseEvent) => void;
6139
- selected: (cells: S2CellType_2[]) => void;
6514
+ selected: CellSelectedHandler_2;
6140
6515
  reset: (event: KeyboardEvent) => void;
6141
6516
  linkFieldJump: (data: {
6142
6517
  field: string;
@@ -6150,7 +6525,7 @@ spreadsheet: SpreadSheet_2;
6150
6525
  }) => void;
6151
6526
  rowCellBrushSelection: (event: FederatedPointerEvent) => void;
6152
6527
  colCellBrushSelection: (event: FederatedPointerEvent) => void;
6153
- }, string, PublicProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
6528
+ }, string, PublicProps, Readonly<ExtractPropTypes<GetInitProps<SheetComponentProps, "sheetType" | "spreadsheet" | "options" | "loading" | "partDrillDown" | "adaptive" | "showPagination" | "themeCfg" | "header" | "onRowCellHover" | "onRowCellClick" | "onRowCellDoubleClick" | "onRowCellContextMenu" | "onRowCellMouseDown" | "onRowCellMouseUp" | "onRowCellMouseMove" | "onRowCellCollapsed" | "onRowCellAllCollapsed" | "onRowCellScroll" | "onRowCellRender" | "onRowCellSelected" | "onColCellHover" | "onColCellClick" | "onColCellDoubleClick" | "onColCellContextMenu" | "onColCellMouseDown" | "onColCellMouseUp" | "onColCellMouseMove" | "onColCellExpanded" | "onColCellHidden" | "onColCellRender" | "onColCellSelected" | "onDataCellHover" | "onDataCellClick" | "onDataCellDoubleClick" | "onDataCellContextMenu" | "onDataCellMouseDown" | "onDataCellMouseUp" | "onDataCellMouseMove" | "onDataCellBrushSelection" | "onDataCellSelectMove" | "onDataCellRender" | "onDataCellEditStart" | "onDataCellEditEnd" | "onDataCellSelected" | "onCornerCellHover" | "onCornerCellClick" | "onCornerCellDoubleClick" | "onCornerCellContextMenu" | "onCornerCellMouseDown" | "onCornerCellMouseUp" | "onCornerCellMouseMove" | "onCornerCellRender" | "onCornerCellSelected" | "onMergedCellsHover" | "onMergedCellsClick" | "onMergedCellsDoubleClick" | "onMergedCellsContextMenu" | "onMergedCellsMouseDown" | "onMergedCellsMouseUp" | "onMergedCellsMouseMove" | "onMergedCellsRender" | "onSeriesNumberCellRender" | "onRangeSort" | "onRangeSorted" | "onRangeFilter" | "onRangeFiltered" | "onLayoutAfterHeaderLayout" | "onLayoutPagination" | "onLayoutCellRender" | "onBeforeRender" | "onAfterRender" | "onMounted" | "onUpdate" | "onUpdateAfterRender" | "onDestroy" | "onLayoutResize" | "onLayoutResizeSeriesWidth" | "onLayoutResizeRowWidth" | "onLayoutResizeRowHeight" | "onLayoutResizeColWidth" | "onLayoutResizeColHeight" | "onLayoutResizeTreeWidth" | "onLayoutResizeMouseDown" | "onLayoutResizeMouseUp" | "onLayoutResizeMouseMove" | "onKeyBoardDown" | "onKeyBoardUp" | "onCopied" | "onActionIconHover" | "onActionIconHoverOff" | "onActionIconClick" | "onContextMenu" | "onClick" | "onHover" | "onDoubleClick" | "onMouseHover" | "onMouseUp" | "onMouseDown" | "onMouseMove" | "onSelected" | "onReset" | "onLinkFieldJump" | "onScroll" | "onLayoutAfterRealDataCellRender" | "onRowCellBrushSelection" | "onColCellBrushSelection">>> & {
6154
6529
  onRowCellHover?: (data: TargetCellInfo_2) => any;
6155
6530
  onRowCellClick?: (data: TargetCellInfo_2) => any;
6156
6531
  onRowCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -6161,7 +6536,8 @@ onRowCellMouseMove?: (data: TargetCellInfo_2) => any;
6161
6536
  onRowCellCollapsed?: (params: RowCellCollapsedParams_2) => any;
6162
6537
  onRowCellAllCollapsed?: (isCollapsed: boolean) => any;
6163
6538
  onRowCellScroll?: (position: Required<ScrollOffset_2>) => any;
6164
- onRowCellRender?: (cell: ColCell_2) => any;
6539
+ onRowCellRender?: (cell: RowCell_2) => any;
6540
+ onRowCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
6165
6541
  onColCellHover?: (data: TargetCellInfo_2) => any;
6166
6542
  onColCellClick?: (data: TargetCellInfo_2) => any;
6167
6543
  onColCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -6175,6 +6551,7 @@ currentHiddenColumnsInfo: HiddenColumnsInfo_2;
6175
6551
  hiddenColumnsDetail: HiddenColumnsInfo_2[];
6176
6552
  }) => any;
6177
6553
  onColCellRender?: (cell: ColCell_2) => any;
6554
+ onColCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
6178
6555
  onDataCellHover?: (data: TargetCellInfo_2) => any;
6179
6556
  onDataCellClick?: (data: TargetCellInfo_2) => any;
6180
6557
  onDataCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -6187,6 +6564,7 @@ onDataCellSelectMove?: (metaList: ViewMetaData_2[]) => any;
6187
6564
  onDataCellRender?: (cell: DataCell_2) => any;
6188
6565
  onDataCellEditStart?: (meta: ViewMeta_2, cell: TableDataCell_2) => any;
6189
6566
  onDataCellEditEnd?: (meta: ViewMeta_2, cell: TableDataCell_2) => any;
6567
+ onDataCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
6190
6568
  onCornerCellHover?: (data: TargetCellInfo_2) => any;
6191
6569
  onCornerCellClick?: (data: TargetCellInfo_2) => any;
6192
6570
  onCornerCellDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -6195,6 +6573,7 @@ onCornerCellMouseDown?: (data: TargetCellInfo_2) => any;
6195
6573
  onCornerCellMouseUp?: (data: TargetCellInfo_2) => any;
6196
6574
  onCornerCellMouseMove?: (data: TargetCellInfo_2) => any;
6197
6575
  onCornerCellRender?: (cell: CornerCell_2) => any;
6576
+ onCornerCellSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
6198
6577
  onMergedCellsHover?: (data: TargetCellInfo_2) => any;
6199
6578
  onMergedCellsClick?: (data: TargetCellInfo_2) => any;
6200
6579
  onMergedCellsDoubleClick?: (data: TargetCellInfo_2) => any;
@@ -6253,7 +6632,7 @@ onMouseHover?: (event: FederatedPointerEvent) => any;
6253
6632
  onMouseUp?: (event: MouseEvent) => any;
6254
6633
  onMouseDown?: (event: MouseEvent) => any;
6255
6634
  onMouseMove?: (event: MouseEvent) => any;
6256
- onSelected?: (cells: S2CellType_2[]) => any;
6635
+ onSelected?: (cells: S2CellType_2<ViewMeta_2>[], detail: CellSelectedDetail_2) => any;
6257
6636
  onReset?: (event: KeyboardEvent) => any;
6258
6637
  onLinkFieldJump?: (data: {
6259
6638
  field: string;
@@ -6273,7 +6652,7 @@ onSpreadsheet?: (container: S2MountContainer_2, dataCfg: S2DataConfig_2, options
6273
6652
  declare interface TargetCellInfo_2 {
6274
6653
  target: S2CellType_2;
6275
6654
  event: FederatedPointerEvent;
6276
- viewMeta: Node_2_2;
6655
+ viewMeta: ViewMeta_2 | Node_2_2;
6277
6656
  }
6278
6657
 
6279
6658
  declare type TextAlign = 'left' | 'center' | 'right';
@@ -6349,7 +6728,7 @@ declare type TooltipDataItem = ViewMetaData_2;
6349
6728
 
6350
6729
  declare type TooltipDetailListItem = {
6351
6730
  name: string;
6352
- value: string | number;
6731
+ value: SimpleData;
6353
6732
  icon?: Element | string;
6354
6733
  };
6355
6734
 
@@ -6556,6 +6935,29 @@ declare interface Total {
6556
6935
  subTotalsLabel?: string;
6557
6936
  }
6558
6937
 
6938
+ declare class TotalClass {
6939
+ label: string;
6940
+ isSubTotals: boolean;
6941
+ isGrandTotals: boolean;
6942
+ isTotalRoot: boolean;
6943
+ constructor(params: TotalClassConfig);
6944
+ }
6945
+
6946
+ /**
6947
+ * Class to mark '小计' & '总计'
6948
+ */
6949
+ declare interface TotalClassConfig {
6950
+ label: string;
6951
+ isSubTotals: boolean;
6952
+ isGrandTotals: boolean;
6953
+ isTotalRoot?: boolean;
6954
+ }
6955
+
6956
+ declare class TotalMeasure {
6957
+ label: string;
6958
+ constructor(label: string);
6959
+ }
6960
+
6559
6961
  declare interface Totals {
6560
6962
  row?: Total;
6561
6963
  col?: Total;
@@ -6584,7 +6986,7 @@ declare interface ValueRange {
6584
6986
 
6585
6987
  declare type ValueRanges = Record<string, ValueRange>;
6586
6988
 
6587
- export declare const version = "@antv/s2-vue-v2.0.0-next.15";
6989
+ export declare const version = "@antv/s2-vue-v2.0.0-next.16";
6588
6990
 
6589
6991
  declare interface ViewCellHeights {
6590
6992
  getCellOffsetY: (index: number) => number;
@@ -6597,29 +6999,45 @@ declare interface ViewCellHeights {
6597
6999
  }
6598
7000
 
6599
7001
  declare interface ViewMeta_2 {
7002
+ /** 表格实例 */
6600
7003
  spreadsheet: SpreadSheet_2;
7004
+ /** 数据唯一标识 */
6601
7005
  id: string;
7006
+ /** x 坐标 */
6602
7007
  x: number;
7008
+ /** y 坐标 */
6603
7009
  y: number;
7010
+ /** 单元格宽度 */
6604
7011
  width: number;
7012
+ /** 单元格高度 */
6605
7013
  height: number;
6606
- data: ViewMetaData_2 | SimpleData | undefined;
7014
+ /** 单元格数据 */
7015
+ data: ViewMetaData_2 | undefined;
7016
+ /** 行索引 */
6607
7017
  rowIndex: number;
7018
+ /** 列索引 */
6608
7019
  colIndex: number;
7020
+ /** 数值字段, 对应 s2DataConfig.fields */
6609
7021
  valueField: string;
7022
+ /** 数值 */
6610
7023
  fieldValue: DataItem;
7024
+ /** 是否是汇总字段 */
6611
7025
  isTotals?: boolean;
7026
+ /** 行查询条件 */
6612
7027
  rowQuery?: Query;
7028
+ /** 列查询条件 */
6613
7029
  colQuery?: Query;
7030
+ /** 行 id */
6614
7031
  rowId?: string;
7032
+ /** 列 id */
6615
7033
  colId?: string;
6616
- field?: string;
6617
- isFrozenCorner?: boolean;
6618
- label?: string;
6619
- value?: string | number;
7034
+ /** 查询条件 */
6620
7035
  query?: Query;
7036
+ /** 叶子节点 */
6621
7037
  isLeaf?: boolean;
7038
+ /** 是否是浅渲染 */
6622
7039
  shallowRender?: boolean;
7040
+ /** 其他字段 */
6623
7041
  [key: string]: unknown;
6624
7042
  }
6625
7043